@onjmin/dtm
    Preparing search index...

    Type Alias TourStep

    ツアーの1ステップ。

    type TourStep = {
        before?: (target: Element | null) => boolean | undefined;
        body: string;
        branches?: TourBranch[];
        placement?: "auto" | "top" | "bottom";
        target?: string | (() => Element | null | undefined);
        title: string;
    }
    Index

    Properties

    before?: (target: Element | null) => boolean | undefined

    表示直前に呼ばれる。対象要素(解決できていれば)が渡る。 false を返すとこのステップを飛ばす。

    body: string

    吹き出しの本文。HTMLを書ける。

    branches?: TourBranch[]

    目的別の分岐。指定すると「次へ」の代わりに選択肢ボタンを並べ、 選ばれた枝のステップ列で以降を差し替える。

    「カバーを作りたい」「自動作曲したい」「自分で打ち込みたい」のように 入口の目的がはっきり分かれる場合、全員に同じ順路を歩かせるより短く終わる。

    placement?: "auto" | "top" | "bottom"

    吹き出しを対象の上下どちらに出すか。既定 "auto"(入る方を選ぶ)。 対象が画面に対して大きすぎる場合は "auto" でも画面下部に固定される。

    target?: string | (() => Element | null | undefined)

    ハイライトする要素。CSSセレクタ(root の中を検索)か、要素を返す関数。 省略すると画面中央のカードだけを出す(導入・締めのステップ向け)。

    解決できない・非表示(display:none や 0 サイズ)の場合、そのステップは 自動的に飛ばされる。機能を切って使う利用者(features.midi: false 等)でも 存在しないUIを指して固まらないようにするため。

    title: string

    吹き出しの見出し。