Class Hint

Generic package interface.

Implements

Package <HintOptions >

Index

Constructors

Methods

addHint addHints callback clone destroy disableCloseDialogOnWindowClick disableHintAutoRefresh enableCloseDialogOnWindowClick enableHintAutoRefresh getActiveHintSignal getHint getHints getOption getRefreshesSignal getTargetElement hideHint hideHintDialog hideHints isActive isRendered onhintclick onHintClick onhintclose onHintClose onhintsadded onHintsAdded refresh removeHint removeHints render setHints setOption setOptions showHint showHintDialog showHints

Constructors

constructor

new Hint(
elementOrSelector?: string | HTMLElement,
options?: Partial<HintOptions >,
): Hint
Create a new Hint instance
Parameters
- OptionalelementOrSelector: string | HTMLElement
  Optional target element or CSS query to start the Hint on
- Optionaloptions: Partial<HintOptions >
  Optional Hint options
Returns Hint
- Defined in src/packages/hint/hint.ts:42

Methods

addHint

addHint(hint: HintItem ): this
Add a Hint item
Parameters
- hint: HintItem
  The Hint item
Returns this
- Defined in src/packages/hint/hint.ts:101

addHints

addHints(): Promise<Hint >
Returns Promise<Hint >
Deprecated
renderHints() is deprecated, please use render() instead
- Defined in src/packages/hint/hint.ts:189

callback

callback<K extends "hintsAdded" | "hintClick" | "hintClose">(
callbackName: K ,
):
| undefined
| {
hintClick?: hintClickCallback;
hintClose?: hintCloseCallback;
hintsAdded?: hintsAddedCallback;
}[K ]
Get the callback function for the provided callback name
Type Parameters
- K extends "hintsAdded" | "hintClick" | "hintClose"
Parameters
- callbackName: K
  The name of the callback
Returns
| undefined
| {
hintClick?: hintClickCallback;
hintClose?: hintCloseCallback;
hintsAdded?: hintsAddedCallback;
}[K ]
- Defined in src/packages/hint/hint.ts:56

clone

clone(): ThisType<Hint >
Clone the Hint instance

Returns ThisType<Hint >
Implementation of Package.clone
- Defined in src/packages/hint/hint.ts:382

destroy

destroy(): Hint
Destroys and removes all hint elements on the page Useful when you want to destroy the elements and add them again (e.g. a modal or popup)

Returns Hint
- Defined in src/packages/hint/hint.ts:241

disableCloseDialogOnWindowClick

disableCloseDialogOnWindowClick(): void
Disable closing the dialog when the user clicks outside the hint

Returns void
- Defined in src/packages/hint/hint.ts:180

disableHintAutoRefresh

disableHintAutoRefresh(): this
Disable hint auto refresh on page scroll and resize for hints

Returns this
- Defined in src/packages/hint/hint.ts:341

enableCloseDialogOnWindowClick

enableCloseDialogOnWindowClick(): void
Enable closing the dialog when the user clicks outside the hint

Returns void
- Defined in src/packages/hint/hint.ts:169

enableHintAutoRefresh

enableHintAutoRefresh(): this
Enable hint auto refresh on page scroll and resize for hints

Returns this
- Defined in src/packages/hint/hint.ts:323

getActiveHintSignal

getActiveHintSignal(): State <undefined | number>
Get the active hint signal This is meant to be used internally by the Hint package

Returns State <undefined | number>
- Defined in src/packages/hint/hint.ts:112

getHint

getHint(stepId: number): undefined | HintItem
Get the Hint item for the provided step ID
Parameters
- stepId: number
  The step ID
Returns undefined | HintItem
- Defined in src/packages/hint/hint.ts:84

getHints

getHints(): HintItem []
Get the Hint items

Returns HintItem []
- Defined in src/packages/hint/hint.ts:76

getOption

getOption<K extends keyof HintOptions >(key: K ): HintOptions [K ]
Get specific Hint option
Type Parameters
- K extends keyof HintOptions
Parameters
- key: K
  The option key
Returns HintOptions [K ]
Implementation of Package.getOption
- Defined in src/packages/hint/hint.ts:356

getRefreshesSignal

getRefreshesSignal(): State <number>
Returns the underlying state of the refreshes This is an internal method and should not be used outside of the package.

Returns State <number>
- Defined in src/packages/hint/hint.ts:120

getTargetElement

getTargetElement(): HTMLElement
Get the target element for the Hint

Returns HTMLElement
- Defined in src/packages/hint/hint.ts:69

hideHint

hideHint(stepId: number): Promise<Hint >
Hide a specific hint on the page
Parameters
- stepId: number
  The hint step ID
Returns Promise<Hint >
- Defined in src/packages/hint/hint.ts:197

hideHintDialog

hideHintDialog(): Hint
Hide hint dialog from the page

Returns Hint
- Defined in src/packages/hint/hint.ts:300

hideHints

hideHints(): Promise<Hint >
Hide all hints on the page

Returns Promise<Hint >
- Defined in src/packages/hint/hint.ts:210

isActive

isActive(): boolean
Returns true if the Hint is active

Returns boolean
Implementation of Package.isActive
- Defined in src/packages/hint/hint.ts:389

isRendered

isRendered(): boolean
Returns true if the hints are rendered

Returns boolean
- Defined in src/packages/hint/hint.ts:127

onhintclick

onhintclick(providedCallback: hintClickCallback): void
Parameters
- providedCallback: hintClickCallback
Returns void
Deprecated
onhintclick is deprecated, please use onHintClick instead
- Defined in src/packages/hint/hint.ts:427

onHintClick

onHintClick(providedCallback: hintClickCallback): Hint
Callback for when hint items are clicked
Parameters
- providedCallback: hintClickCallback
  callback function
Returns Hint
- Defined in src/packages/hint/hint.ts:414

onhintclose

onhintclose(providedCallback: hintCloseCallback): void
Parameters
- providedCallback: hintCloseCallback
Returns void
Deprecated
onhintclose is deprecated, please use onHintClose instead
- Defined in src/packages/hint/hint.ts:448

onHintClose

onHintClose(providedCallback: hintCloseCallback): Hint
Callback for when hint items are closed
Parameters
- providedCallback: hintCloseCallback
  callback function
Returns Hint
- Defined in src/packages/hint/hint.ts:435

onhintsadded

onhintsadded(providedCallback: hintsAddedCallback): void
Parameters
- providedCallback: hintsAddedCallback
  callback function
Returns void
Deprecated
onhintsadded is deprecated, please use onHintsAdded instead
- Defined in src/packages/hint/hint.ts:406

onHintsAdded

onHintsAdded(providedCallback: hintsAddedCallback): Hint
Parameters
- providedCallback: hintsAddedCallback
Returns Hint
- Defined in src/packages/hint/hint.ts:393

refresh

refresh(): Hint
Refresh the hints on the page

Returns Hint
- Defined in src/packages/hint/hint.ts:308

removeHint

removeHint(stepId: number): Hint
Remove one single hint element from the page Useful when you want to destroy the element and add them again (e.g. a modal or popup) Use removeHints if you want to remove all elements.
Parameters
- stepId: number
  The hint step ID
Returns Hint
- Defined in src/packages/hint/hint.ts:268

removeHints

removeHints(): Hint
Returns Hint
Deprecated
removeHints() is deprecated, please use destroy() instead
- Defined in src/packages/hint/hint.ts:256

render

render(): Promise<Hint >
Render hints on the page

Returns Promise<Hint >
- Defined in src/packages/hint/hint.ts:146

setHints

setHints(hints: HintItem []): this
Set the Hint items
Parameters
- hints: HintItem []
  The Hint items
Returns this
- Defined in src/packages/hint/hint.ts:92

setOption

setOption<K extends keyof HintOptions >(key: K , value: HintOptions [K ]): this
Set specific Hint option
Type Parameters
- K extends keyof HintOptions
Parameters
- key: K
  Option key
- value: HintOptions [K ]
  Option value
Returns this
Implementation of Package.setOption
- Defined in src/packages/hint/hint.ts:374

setOptions

setOptions(partialOptions: Partial<HintOptions >): this
Set Hint options
Parameters
- partialOptions: Partial<HintOptions >
  Hint options
Returns this
Implementation of Package.setOptions
- Defined in src/packages/hint/hint.ts:364

showHint

showHint(stepId: number): Hint
Show a specific hint on the page
Parameters
- stepId: number
  The hint step ID
Returns Hint
- Defined in src/packages/hint/hint.ts:219

showHintDialog

showHintDialog(stepId: number): Promise<undefined | Hint >
Show hint dialog for a specific hint
Parameters
- stepId: number
  The hint step ID
Returns Promise<undefined | Hint >
- Defined in src/packages/hint/hint.ts:279

showHints

showHints(): Promise<Hint >
Show all hints on the page

Returns Promise<Hint >
- Defined in src/packages/hint/hint.ts:232

Settings

Member Visibility

Theme

Class Hint

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Hint

Methods

addHint

Parameters

Returns this

addHints

Returns Promise<Hint >

Deprecated

callback

Type Parameters

Parameters

Returns | undefined | { hintClick?: hintClickCallback; hintClose?: hintCloseCallback; hintsAdded?: hintsAddedCallback; }[K ]

clone

Returns ThisType<Hint >

destroy

Returns Hint

disableCloseDialogOnWindowClick

Returns void

disableHintAutoRefresh

Returns this

enableCloseDialogOnWindowClick

Returns void

enableHintAutoRefresh

Returns this

getActiveHintSignal

Returns State <undefined | number>

getHint

Parameters

Returns undefined | HintItem

getHints

Returns HintItem []

getOption

Type Parameters

Parameters

Returns HintOptions [K ]

getRefreshesSignal

Returns State <number>

getTargetElement

Returns HTMLElement

hideHint

Parameters

Returns Promise<Hint >

hideHintDialog

Returns Hint

hideHints

Returns Promise<Hint >

isActive

Returns boolean

isRendered

Returns boolean

onhintclick

Parameters

Returns void

Deprecated

onHintClick

Parameters

Returns Hint

onhintclose

Parameters

Returns void

Deprecated

onHintClose

Parameters

Returns Hint

onhintsadded

Parameters

Returns void

Deprecated

onHintsAdded

Parameters

Returns Hint

refresh

Returns
| undefined
| {
hintClick?: hintClickCallback;
hintClose?: hintCloseCallback;
hintsAdded?: hintsAddedCallback;
}[K ]