Sanity Library Reference Docs
    Preparing search index...

    Interface DocumentListItem

    Interface for document list item

    interface DocumentListItem {
        _id: string;
        child?: ListItemChild;
        count?: ListItemCount;
        displayOptions?: ListItemDisplayOptions;
        i18n?: I18nTextRecord<"title">;
        icon?: ReactNode | ComponentType<{}>;
        id: string;
        schemaType: SchemaType;
        title?: string;
        type: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _id child? count? displayOptions? i18n? icon? id schemaType title? type

    Properties

    _id

    _id: string

    Document ID

    child?: ListItemChild

    List item child. See ListItemChild

    count?: ListItemCount

    Document schema type to show a live count for. Derived during serialization from displayOptions.showCount and the item's schema type and child; authoring it directly has no effect. See ListItemCount

    displayOptions?: ListItemDisplayOptions

    List item display options. See ListItemDisplayOptions

    i18n?: I18nTextRecord<"title">

    The i18n key and namespace used to populate the localized title. This is the recommend way to set the title if you are localizing your studio.

    icon?: ReactNode | ComponentType<{}>

    List item icon

    id: string

    List item id

    schemaType: SchemaType

    Document schema type. See SchemaType

    title?: string

    List item title. Note that the i18n key and namespace will take precedence.

    type: string

    List item type

    Settings

    Member Visibility

    On This Page

    Properties