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[];
        orderings?: SortOrdering[];
    }

    Hierarchy

    Index

    Properties

    __experimental_formPreviewTitle? __experimental_omnisearch_visibility? __experimental_search? fields orderings?

    Properties

    Optional Alpha__experimental_formPreviewTitle

    __experimental_formPreviewTitle?: boolean

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

    Optional Alpha__experimental_omnisearch_visibility

    __experimental_omnisearch_visibility?: boolean

    Optional__experimental_search

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

    Unused. Use the new field-level search config.

    fields: FieldDefinition[]

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

    orderings?: SortOrdering[]

    Settings

    Member Visibility

    On This Page

    Properties