Sanity Library Reference Docs
    Preparing search index...

    Interface DocumentList

    Interface for document list

    interface DocumentList {
        canHandleIntent?: IntentChecker;
        child: Child;
        currentMaxWidth?: number;
        defaultLayout?: PreviewLayoutKey;
        displayOptions?: ListDisplayOptions;
        i18n?: I18nTextRecord<"title">;
        id: string;
        initialValueTemplates?: (
            InitialValueTemplateItem
            | InitialValueTemplateItemBuilder
        )[];
        maxWidth?: number;
        menuItemGroups: MenuItemGroup[];
        menuItems: MenuItem[];
        minWidth?: number;
        options: DocumentListOptions;
        schemaTypeName?: string;
        title?: string;
        type: "documentList";
    }

    Hierarchy (View Summary)

    Index

    Properties

    canHandleIntent? child currentMaxWidth? defaultLayout? displayOptions? i18n? id initialValueTemplates? maxWidth? menuItemGroups menuItems minWidth? options schemaTypeName? title? type

    Properties

    canHandleIntent?: IntentChecker

    Can handle intent. See IntentChecker

    child: Child

    Document list child. See Child

    currentMaxWidth?: number

    Maximum width of the list pane before it is manually resized, in pixels. Defaults to 350

    defaultLayout?: PreviewLayoutKey

    List layout key.

    displayOptions?: ListDisplayOptions

    List display options. See ListDisplayOptions

    i18n?: I18nTextRecord<"title">
    id: string

    Node ID

    initialValueTemplates?: (
        InitialValueTemplateItem
        | InitialValueTemplateItemBuilder
    )[]

    List initial values array. See InitialValueTemplateItem and InitialValueTemplateItemBuilder

    maxWidth?: number

    Maximum width of the list pane in pixels. Defaults to 640

    menuItemGroups: MenuItemGroup[]

    List menu item groups array. See MenuItemGroup

    menuItems: MenuItem[]

    List menu items array. See MenuItem

    minWidth?: number

    Minimum width of the list pane in pixels. Defaults to 320

    options: DocumentListOptions

    Document list options. See DocumentListOptions

    schemaTypeName?: string

    Document schema type name

    title?: string

    Node ID

    type: "documentList"

    List type

    Settings

    Member Visibility

    On This Page

    Properties