[]
        
(Showing Draft Content)

Inputman.TourStepConfig

TourStepConfig インターフェイス

単一の GcTour ステップの設定。

階層

  • TourStepConfig

プロパティ

オプション autoFocusTarget

autoFocusTarget: boolean

現在のステップのターゲット要素に自動フォーカスするかどうかを設定します。

オプション closeOnEsc

closeOnEsc: boolean

ESC キーを押したときに GcTour を閉じるかどうかを設定します。

オプション closeOnOverlayClick

closeOnOverlayClick: boolean

空白領域をクリックしたときにGcTourを閉じるかどうかを設定します。

オプション customTip

customTip: (context: TourCustomTipContext): void

カスタムチップのレンダリング関数を設定します。

型宣言

オプション description

description: string | ((): HTMLElement )

ステップの説明を設定します。

オプション disableInteraction

disableInteraction: boolean

ターゲット要素とのインタラクションを無効にするかどうかを設定します。

オプション disableNextButton

disableNextButton: boolean

「次へ」ボタンを無効にするかどうかを設定します。

オプション disablePreviousButton

disablePreviousButton: boolean

「前へ」ボタンを無効化するかどうかを設定します。

オプション highlightRadius

highlightRadius: number

ハイライト領域の半径を設定します。

オプション message

message: string | ((): HTMLElement )

カスタムメッセージ内容を設定します。

オプション offset

offset: number | number[]

ハイライト領域とターゲット要素との相対的なオフセット量を設定します。

オプション showCloseButton

showCloseButton: boolean

閉じるボタンを表示するかどうかを設定します。

オプション showOverlay

showOverlay: boolean

モーダルで表示するかどうかを設定します。

オプション target

target: TourTarget

ターゲット要素を設定します。

オプション tipClassName

tipClassName: string

チップのCSSクラス名を設定します。

オプション tipDirection

tipDirection: TipDirection

チップの方向を設定します。

オプション tipPosition

tipPosition: TipPosition

チップの位置を設定します。

オプション tipResource

チップのリソース構成を設定します。

オプション title

title: string | ((): HTMLElement )

ステップのタイトルを設定します。