Interface IConfig

Config interface to modify behaviour and style of prompt

interface IConfig {
    animationDirection?: AnimationDirection;
    animationDisable?: boolean;
    backgroundColor?: string;
    containerId?: string;
    hideImage?: boolean;
    hideText?: boolean;
    imageColor?: string;
    imageId?: string;
    imageSize?: string;
    imageStyle?: ImageStyle;
    mobileDetect?: boolean;
    orientation?: DeviceOrientation;
    styleId?: string;
    text?: string;
    textColor?: string;
    textFont?: string;
    textId?: string;
    textSize?: string;
    zIndex?: number;
}

Properties

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

Properties

OptionalanimationDirection

animationDirection?: AnimationDirection

Direction of image animation

Default

'clockwise'

OptionalanimationDisable

animationDisable?: boolean

Enable/disable image animation

Default

false

OptionalbackgroundColor

backgroundColor?: string

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

Default

'#000000'

OptionalcontainerId

containerId?: string

Id of whole container prompt

Default

'promptContainer'

OptionalhideImage

hideImage?: boolean

Hide/show image

Default

false

OptionalhideText

hideText?: boolean

Hide/show description text

Default

false

OptionalimageColor

imageColor?: string

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

Default

'#ffffff'

OptionalimageId

imageId?: string

Id of svg image

Default

'promptImage'

OptionalimageSize

imageSize?: string

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

Default

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

OptionalimageStyle

imageStyle?: ImageStyle

Phone style

Default

'circle'

OptionalmobileDetect

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

Optionalorientation

orientation?: DeviceOrientation

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

Default

'landscape'

OptionalstyleId

styleId?: string

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

Default

'promptStyle'

Optionaltext

text?: string

Description text to show

Default

'Please rotate your device'

OptionaltextColor

textColor?: string

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

Default

'#ffffff'

OptionaltextFont

textFont?: string

Font of description text

Default

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

OptionaltextId

textId?: string

Id of container with description text

Default

'promptText'

OptionaltextSize

textSize?: string

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

Default

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

OptionalzIndex

zIndex?: number

z-index of whole prompt

Default

undefined

Settings

Member Visibility

On This Page

Properties