Sanity Library Reference Docs
    Preparing search index...

    Interface DocumentListInput

    Interface for document list input

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    canHandleIntent?: IntentChecker

    If input can handle intent. See IntentChecker

    child?: Child

    Input child of type Child

    currentMaxWidth?: number

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

    defaultLayout?: PreviewLayoutKey

    Input default layout.

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

    Input id

    initialValueTemplates?: (
        InitialValueTemplateItem
        | InitialValueTemplateItemBuilder
    )[]

    Input initial value array. See InitialValueTemplateItem and InitialValueTemplateItemBuilder

    maxWidth?: number

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

    menuItemGroups?: (MenuItemGroup | MenuItemGroupBuilder)[]

    Input menu items groups. See MenuItemGroup and MenuItemGroupBuilder

    menuItems?: (MenuItem | MenuItemBuilder)[]

    Input menu items groups. See MenuItem and MenuItemBuilder

    minWidth?: number

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

    options: DocumentListOptions

    Document list options. See DocumentListOptions

    title: string

    Input title

    type?: string

    Node type

    Settings

    Member Visibility

    On This Page

    Properties