Sanity Library Reference Docs
    Preparing search index...

    Interface DocumentDefinition

    interface DocumentDefinition {
        __experimental_formPreviewTitle?: boolean;
        __experimental_omnisearch_visibility?: boolean;
        __experimental_search?: { mapWith?: string; path: string; weight: number }[];
        fields: FieldDefinition<
            | "string"
            | "number"
            | "boolean"
            | "object"
            | "text"
            | "crossDatasetReference"
            | "reference"
            | "block"
            | "document"
            | "array"
            | "date"
            | "datetime"
            | "file"
            | "geopoint"
            | "image"
            | "globalDocumentReference"
            | "slug"
            | "url"
            | "email",
            undefined,
        >[];
        orderings?: SortOrdering[];
    }

    Hierarchy

    Index

    Properties

    __experimental_formPreviewTitle?: boolean

    Determines whether the large preview title is displayed in the document pane form

    __experimental_omnisearch_visibility?: boolean
    __experimental_search?: { mapWith?: string; path: string; weight: number }[]

    Unused. Use the new field-level search config.

    fields: FieldDefinition<
        | "string"
        | "number"
        | "boolean"
        | "object"
        | "text"
        | "crossDatasetReference"
        | "reference"
        | "block"
        | "document"
        | "array"
        | "date"
        | "datetime"
        | "file"
        | "geopoint"
        | "image"
        | "globalDocumentReference"
        | "slug"
        | "url"
        | "email",
        undefined,
    >[]

    Object must have at least one field. This is validated at Studio startup.

    orderings?: SortOrdering[]