Sanity Library Reference Docs
    Preparing search index...

    Interface ObjectFormNode<T, S>

    interface ObjectFormNode<
        T = { [key in string]: unknown },
        S extends ObjectSchemaType = ObjectSchemaType,
    > {
        changed: boolean;
        focused?: boolean;
        focusPath: Path;
        id: string;
        level: number;
        path: Path;
        readOnly?: boolean;
        schemaType: S;
        validation: FormNodeValidation[];
        value: T;
    }

    Type Parameters

    Index

    Properties

    changed focused? focusPath id level path readOnly? schemaType validation value

    Properties

    changed: boolean

    Whether the node has changes in a draft.

    focused?: boolean

    Whether the node is focused.

    focusPath: Path

    The focus path of the form node.

    id: string

    The unique identifier of the node.

    level: number

    The level of the node in the form hierarchy.

    path: Path

    The path of the node in the form hierarchy.

    readOnly?: boolean

    Whether the node is read-only.

    schemaType: S

    The schema type of the node.

    validation: FormNodeValidation[]

    The validation markers of the node.

    value: T

    The value of the node.

    Settings

    Member Visibility

    On This Page

    Properties