Sanity Library Reference Docs
    Preparing search index...

    Interface FormBuilderPropsAlpha

    interface FormBuilderProps {
        autoFocus?: boolean;
        changed: boolean;
        changesOpen?: boolean;
        collapsedFieldSets: StateTree<boolean>;
        collapsedPaths: StateTree<boolean>;
        compareValue?: Partial<SanityDocument>;
        focused: boolean;
        focusPath: Path;
        id: string;
        onChange: (changeEvent: PatchEvent) => void;
        onFieldGroupSelect: (path: Path, groupName: string) => void;
        onPathBlur: (path: Path) => void;
        onPathFocus: (path: Path) => void;
        onPathOpen: (path: Path) => void;
        onSetFieldSetCollapsed: (path: Path, collapsed: boolean) => void;
        onSetPathCollapsed: (path: Path, collapsed: boolean) => void;
        openPath?: Path;
        perspective?: TargetPerspective;
        presence: FormNodePresence[];
        readOnly?: boolean;
        schemaType: ObjectSchemaType;
        validation: ValidationMarker[];
        value: FormDocumentValue;
    }

    Hierarchy

    • Omit<
          ObjectFormNode,
          | "level"
          | "path"
          | "presence"
          | "validation"
          | "_allMembers"
          | "__unstable_computeDiff",
      >
      • FormBuilderProps
    Index

    Properties

    autoFocus? changed changesOpen? collapsedFieldSets collapsedPaths compareValue? focused focusPath id onChange onFieldGroupSelect onPathBlur onPathFocus onPathOpen onSetFieldSetCollapsed onSetPathCollapsed openPath? perspective? presence readOnly? schemaType validation value

    Properties

    autoFocus?: boolean
    changed: boolean

    Whether the current value is different to the value the node is being compared to.

    changesOpen?: boolean
    collapsedFieldSets: StateTree<boolean>
    collapsedPaths: StateTree<boolean>
    compareValue?: Partial<SanityDocument>
    focused: boolean

    Whether the node is focused.

    focusPath: Path

    The focus path of the form node.

    id: string

    The unique identifier of the node.

    onChange: (changeEvent: PatchEvent) => void
    onFieldGroupSelect: (path: Path, groupName: string) => void
    onPathBlur: (path: Path) => void
    onPathFocus: (path: Path) => void
    onPathOpen: (path: Path) => void
    onSetFieldSetCollapsed: (path: Path, collapsed: boolean) => void
    onSetPathCollapsed: (path: Path, collapsed: boolean) => void
    openPath?: Path
    perspective?: TargetPerspective
    presence: FormNodePresence[]
    readOnly?: boolean

    Whether the node is read-only.

    schemaType: ObjectSchemaType

    The schema type of the node.

    validation: ValidationMarker[]
    value: FormDocumentValue

    The value of the node.

    Settings

    Member Visibility

    On This Page

    Properties