Sanity Library Reference Docs
    Preparing search index...

    The fields, activities, guards, and outgoing routes for one stage visit. A stage with no transitions is terminal: entering it completes the instance, and it cannot declare activities. Put completion work in the source stage or give the working stage an outgoing transition.

    Guards are registered on entry and retracted on exit. editable overrides are keyed by in-scope field name and apply while the stage is current. Each combines with the field's own edit condition using AND, so an override can restrict editing but cannot open a field whose baseline is closed. An unlisted field inherits its baseline.

    interface Stage {
        activities?: Activity[];
        description?: string;
        editable?: Record<string, Editable>;
        fields?: FieldEntry[];
        groups?: Group[];
        guards?: {
            description?: string;
            match: {
                actions: ("create" | "update" | "delete" | "publish" | "unpublish")[];
                idPatterns?: string[];
                idRefs?: string[];
                types?: string[];
            };
            metadata?: { [key: string]: string };
            name: string;
            predicate?: string;
            title?: string;
        }[];
        name: string;
        semantics?: Semantic[];
        title?: string;
        transitions?: Transition[];
    }
    Index

    Properties

    activities?: Activity[]
    description?: string
    editable?: Record<string, Editable>
    fields?: FieldEntry[]
    groups?: Group[]
    guards?: {
        description?: string;
        match: {
            actions: ("create" | "update" | "delete" | "publish" | "unpublish")[];
            idPatterns?: string[];
            idRefs?: string[];
            types?: string[];
        };
        metadata?: { [key: string]: string };
        name: string;
        predicate?: string;
        title?: string;
    }[]
    name: string
    semantics?: Semantic[]
    title?: string
    transitions?: Transition[]