Sanity Library Reference Docs
    Preparing search index...

    Interface SanityFormConfig

    interface SanityFormConfig {
        arrays?: { collapseItems?: { enabled?: boolean; limit?: number } };
        components?: FormComponents;
        file?: {
            assetSources?: AssetSource[] | AssetSourceResolver;
            directUploads?: boolean;
        };
        image?: {
            assetSources?: AssetSource[]
            | AssetSourceResolver;
            directUploads?: boolean;
        };
        unstable?: {
            CustomMarkers?: FormBuilderCustomMarkersComponent;
            Markers?: FormBuilderMarkersComponent;
        };
    }
    Index

    Properties

    arrays?: { collapseItems?: { enabled?: boolean; limit?: number } }

    Array-related functionality.

    Type declaration

    • OptionalcollapseItems?: { enabled?: boolean; limit?: number }

      Renders long arrays with a limited number of items, collapsing the rest behind a "show all items" toggle so that a single long array doesn't push the rest of the document form out of view.

      • Optionalenabled?: boolean

        true

      • Optionallimit?: number

        4

    components?: FormComponents

    Components for the form.

    file?: {
        assetSources?: AssetSource[] | AssetSourceResolver;
        directUploads?: boolean;
    }

    Type declaration

    image?: {
        assetSources?: AssetSource[] | AssetSourceResolver;
        directUploads?: boolean;
    }
    unstable?: {
        CustomMarkers?: FormBuilderCustomMarkersComponent;
        Markers?: FormBuilderMarkersComponent;
    }

    these have not been migrated over