switchyard
    Preparing search index...

    Interface StateOptions<C>

    interface StateOptions<C extends State = State> {
        children?: EnumClass<C>;
        final?: boolean;
        history?: "shallow" | "deep";
        regions?: Record<string, EnumClass<C>>;
    }

    Type Parameters

    Index
    children?: EnumClass<C>

    The child states of a compound state, as their own enum.

    final?: boolean

    Entering a final state completes its parent.

    history?: "shallow" | "deep"

    Re-entering through .history resumes the last active child (shallow) or descendant (deep).

    regions?: Record<string, EnumClass<C>>

    Parallel regions inside this state, each with its own enum: { bold: Toggle, italic: Toggle }.