Sanity Library Reference Docs
    Preparing search index...

    Interface BuildableList

    Interface for buildable list

    interface BuildableList {
        canHandleIntent?: IntentChecker;
        child?: Child;
        currentMaxWidth?: number;
        defaultLayout?: PreviewLayoutKey;
        displayOptions?: ListDisplayOptions;
        i18n?: I18nTextRecord<"title">;
        id?: string;
        initialValueTemplates?: (
            InitialValueTemplateItem
            | InitialValueTemplateItemBuilder
        )[];
        items?: (ListItem | ListItemBuilder | Divider | DividerBuilder)[];
        maxWidth?: number;
        menuItemGroups?: (MenuItemGroup | MenuItemGroupBuilder)[];
        menuItems?: (MenuItem | MenuItemBuilder)[];
        minWidth?: number;
        title?: string;
        type?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    canHandleIntent?: IntentChecker

    Can handle intent. See IntentChecker

    child?: Child

    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

    items?: (ListItem | ListItemBuilder | Divider | DividerBuilder)[]

    List items. See ListItem, ListItemBuilder and Divider

    maxWidth?: number

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

    menuItemGroups?: (MenuItemGroup | MenuItemGroupBuilder)[]

    List menu items groups array. See MenuItemGroup and MenuItemGroupBuilder

    menuItems?: (MenuItem | MenuItemBuilder)[]

    List menu items array. See MenuItem and MenuItemBuilder

    minWidth?: number

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

    title?: string

    Node ID

    type?: string

    Node type

    Settings

    Member Visibility

    On This Page

    Properties