Interface IxTooltipSettings

Tooltip settings that can be passed to the loader to define how the tooltip that is to be opened should look like and behave.

Hierarchy

  • IxTooltipSettings

Properties

alignment? autoClose? autoCloseInterval? className? closeByButton? closeByClick? closeByEsc? content? dragAble? fixed? height? heightUnit? htmlTarget? keepVisible? key? maxHeight? maxHeightUnit? maxWidth? maxWidthUnit? modal? offsetX? offsetY? parent? position? scrollable? title? width? widthUnit?

Properties

Optional alignment

alignment?: Alignments

Alignment where tooltip should be positioned.

Optional autoClose

autoClose?: boolean

Should the tooltip close itself in an interval.

Optional autoCloseInterval

autoCloseInterval?: number

Time in milliseconds (ms).

Optional className

className?: string

Tooltip style class.

Optional closeByButton

closeByButton?: boolean

Show tooltip close button.

Optional closeByClick

closeByClick?: boolean

Close tooltip on click anywhere outside the tooltip.

Optional closeByEsc

closeByEsc?: boolean

Close tooltip via ESC key.

Optional content

content?: string | HTMLElement | JQuery<HTMLElement> | HTMLElement[]

Tooltip content.

Optional dragAble

dragAble?: boolean

The tooltip can be moved via drag and drop.

Optional fixed

fixed?: boolean

Tooltip position relative to viewport (positioning must be set to window or modal).

Optional height

height?: string | number

Fix tooltip height.

Optional heightUnit

heightUnit?: HeightUnit

Tooltip height unit.

Values

px | vw (viewport width = width: 1-100)

Defaults

px

Optional htmlTarget

htmlTarget?: HTMLElement

An element in the Document Object Model (DOM).

Optional keepVisible

keepVisible?: boolean

Tooltip is kept in the visible region, whenever possible.

Optional key

key?: string

The tooltip identifier [data-tooltip-key='<key>'].

Optional maxHeight

maxHeight?: string | number

Fix tooltip maximal height.

Optional maxHeightUnit

maxHeightUnit?: string

Tooltip maximal height unit.

Values

px | vw (viewport width = width: 1-100)

Defaults

px

Optional maxWidth

maxWidth?: string | number

Fix tooltip maximal width.

Optional maxWidthUnit

maxWidthUnit?: string

Tooltip maximal width unit.

Values

px | vw (viewport width = width: 1-100)

Defaults

px

Optional modal

modal?: boolean

Tooltip is opened modal. Means that the background is locked with a dark layer.

Optional offsetX

offsetX?: number

Horizontal tooltip offset in px (affects only when position = "window").

Deprecated

Optional offsetY

offsetY?: number

Vertical tooltip offset in px (affects only when position = "window").

Deprecated

Optional parent

parent?: string | HTMLElement | ContainerBase

The parent element.

Optional position

position?: Position

Tooltip positioning.

Values

absolute | element (depends on htmlTarget) | embedded (depends on htmlTarget) | modal | mouse | window | ""

Optional scrollable

scrollable?: boolean

Content is scrollable in TT_Content container.

Optional title

title?: string | boolean

Tooltip title.

Optional width

width?: string | number

Fix tooltip width.

Optional widthUnit

widthUnit?: WidthUnit

Tooltip width unit.

Values

px | vw (viewport width = width: 1-100)

Defaults

px

Settings

Member Visibility

Theme

On This Page