Interface DocumentList

Interface for document list

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

Hierarchy (View Summary)

GenericList
- DocumentList

Index

Properties

canHandleIntent? child defaultLayout? displayOptions? id initialValueTemplates? menuItemGroups menuItems options schemaTypeName? title? type

Properties

`Optional`canHandleIntent

canHandleIntent?: IntentChecker

Can handle intent. See IntentChecker

child

child: Child

Document list child. See Child

`Optional`defaultLayout

defaultLayout?: PreviewLayoutKey

List layout key.

`Optional`displayOptions

displayOptions?: ListDisplayOptions

List display options. See ListDisplayOptions

id

id: string

Node ID

`Optional`initialValueTemplates

initialValueTemplates?: (
InitialValueTemplateItem
| InitialValueTemplateItemBuilder
)[]

List initial values array. See InitialValueTemplateItem and InitialValueTemplateItemBuilder

menuItemGroups

menuItemGroups: MenuItemGroup[]

List menu item groups array. See MenuItemGroup

menuItems

menuItems: MenuItem[]

List menu items array. See MenuItem

options

options: DocumentListOptions

Document list options. See DocumentListOptions

`Optional`schemaTypeName

schemaTypeName?: string

Document schema type name

`Optional`title

title?: string

Node ID

type

type: "documentList"

List type