Enode — API Reference
    Preparing search index...

    Type Alias TourStep

    type TourStep = {
        advanceOn?: "click";
        body: string;
        placement?: TourPlacement;
        target: string;
        title: string;
    }
    Index

    Properties

    advanceOn?: "click"

    How the step advances. Default: the card's Next/Done button, with the target inert. "click" makes the spotlit target itself clickable and hides Next — clicking the target advances (or, on the last step, finishes as done) while the target's own onClick runs normally. Use it to hand the user over to a flow (e.g. "click Create schedule" → the drawer that opens carries its own tour, chaining naturally via its TourAutoStart). The body copy must tell the user to click.

    body: string

    Already-translated step narration.

    placement?: TourPlacement
    target: string

    Matches an element's data-tour attribute; a missing/hidden target skips the step.

    title: string

    Already-translated step heading (authored via literal t("...")).