Interface IConfig

Config interface to modify behaviour and style of prompt

Hierarchy

  • IConfig

Properties

animationDirection? animationDisable? backgroundColor? containerId? hideImage? hideText? imageColor? imageId? imageSize? imageStyle? mobileDetect? orientation? styleId? text? textColor? textFont? textId? textSize? zIndex?

Properties

Optional animationDirection

animationDirection?: AnimationDirection

Direction of image animation

Default

'clockwise'

Optional animationDisable

animationDisable?: boolean

Enable/disable image animation

Default

false

Optional backgroundColor

backgroundColor?: string

Background color of whole prompt (all css possibilities, like hexa color '#000000', 'red'...)

Default

'#000000'

Optional containerId

containerId?: string

Id of whole container prompt

Default

'promptContainer'

Optional hideImage

hideImage?: boolean

Hide/show image

Default

false

Optional hideText

hideText?: boolean

Hide/show description text

Default

false

Optional imageColor

imageColor?: string

Color of device image (all css possibilities, like hexa color '#000000', 'red'...)

Default

'#ffffff'

Optional imageId

imageId?: string

Id of svg image

Default

'promptImage'

Optional imageSize

imageSize?: string

Size of device image (all css units like px, em, rem, vh...)

Default

'60vh' for portrait '30vh' for landscape

Optional imageStyle

imageStyle?: ImageStyle

Phone style

Default

'circle'

Optional mobileDetect

mobileDetect?: boolean

Turn on/off automatic mobile/tablet detection When automatic detection is on, then prompt is show only on mobile/tablet devices

Default

false

Optional orientation

orientation?: DeviceOrientation

The orientation you want to force, if orientation is different, prompt is showed.

Default

'landscape'

Optional styleId

styleId?: string

Id of style tag, where all styles of this library are defined

Default

'promptStyle'

Optional text

text?: string

Description text to show

Default

'Please rotate your device'

Optional textColor

textColor?: string

Color of description text (all css possibilities, like hexa color '#000000', 'red'...)

Default

'#ffffff'

Optional textFont

textFont?: string

Font of description text

Default

'\'Arial Black\', \'Arial Bold\', Gadget, sans-serif'

Optional textId

textId?: string

Id of container with description text

Default

'promptText'

Optional textSize

textSize?: string

Size of description text (all css units like px, em, rem, vh...)

Default

'10vh' for portrait '5vh' for landscape

Optional zIndex

zIndex?: number

z-index of whole prompt

Default

undefined

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc