@dxos/app-toolkit - v0.16.0
    Preparing search index...

    Type Alias Step

    One stop of a guided tour.

    target must be a control, not a container: the card is placed beside it and a viewport-sized target pushes the card off-screen.

    type Step = {
        before?: (
            capabilities: CapabilityManager.CapabilityManager,
        ) => void | Promise<void>;
        description: string;
        id?: string;
        placement?: Tour.StepPlacement;
        target: string | (() => HTMLElement | null);
        title: string;
    }
    Index

    Properties

    before? description id? placement? target title

    Properties

    before?: (
        capabilities: CapabilityManager.CapabilityManager,
    ) => void | Promise<void>

    Runs before the step shows and may bring the target into being (open a sidebar); awaited.

    description: string
    id?: string

    Defaults to the step's one-based position.

    placement?: Tour.StepPlacement
    target: string | (() => HTMLElement | null)

    A selector, or a function resolving the element; the tour waits for it to appear.

    title: string

    Settings

    Member Visibility

    On This Page

    Properties