@onjmin/dtm
    Preparing search index...

    Type Alias TourOptions

    startTour のオプション。

    type TourOptions = {
        labels?: Partial<TourLabels>;
        onEnd?: (completed: boolean) => void;
        root?: ParentNode;
        steps: TourStep[];
        storageKey?: string | null;
    }
    Index

    Properties

    labels? onEnd? root? steps storageKey?

    Properties

    labels?: Partial<TourLabels>

    文言の差し替え。

    onEnd?: (completed: boolean) => void

    終了時に呼ばれる。最後まで見たかどうかが渡る。

    root?: ParentNode

    target にセレクタを書いたときの検索基点（既定 document）。 DAWのルート要素を渡すと、同一ページに複数マウントしていても取り違えない。

    steps: TourStep[]

    表示するステップ列。空なら何もしない。

    storageKey?: string | null

    「もう見た」フラグの保存先キー（既定 "dtm-tour-seen"）。 最後まで進むか、スキップ／中断したときに記録する。null で記録しない。

    Settings

    Member Visibility

    On This Page

    Properties