Structure context. See StructureContext
Optionalspec: ListInputReadonly[serializableBrand consumed by isSerializable (avoids circular instanceof imports)
Set generic list can handle intent
OptionalcanHandleIntent: IntentCheckergeneric list intent checker. See IntentChecker
generic list builder based on can handle intent provided.
Clone list builder and return new list builder based on context and spec provided
OptionalwithSpec: BuildableListlist options. See BuildableList
new list builder based on context and spec provided. See ListBuilder
Set the maximum width of the list pane before it is manually resized
Maximum width in pixels before manual resizing
generic list builder with the current maximum width applied
Set generic list layout
generic list layout key.
generic list builder based on layout provided.
Get the maximum width of the list pane before it is manually resized
current maximum width in pixels
Get i18n key and namespace used to populate the localized title
the i18n key and namespace used to populate the localized title
Get generic list ID
generic list ID
Get generic list initial value templates
generic list initial value templates
Get list builder items
list items. See BuildableList
Get the maximum width of the list pane
maximum width in pixels
Get generic list menu item groups
generic list menu item groups
Get the minimum width of the list pane
minimum width in pixels
Get generic list display options
generic list display options (specifically showIcons)
Get generic list title
generic list title
Set the i18n key and namespace used to populate the localized title.
the key and namespaced used to populate the localized title.
component builder based on i18n key and ns provided
Set generic list ID
generic list ID
generic list builder based on ID provided.
Set generic list initial value templates
generic list initial value templates. See InitialValueTemplateItemBuilder
generic list builder based on templates provided.
Set list builder based on items provided
list items. See ListItemBuilder, ListItem and Divider
list builder based on items provided. See ListBuilder
Set the maximum width of the list pane
Maximum width in pixels
generic list builder with the maximum width applied
Set generic list menu item groups
generic list menu item groups. See MenuItemGroup and MenuItemGroupBuilder
generic list builder based on menu item groups provided.
Set generic list menu items
generic list menu items. See MenuItem and MenuItemBuilder
generic list builder based on menu items provided.
Set the minimum width of the list pane
Minimum width in pixels
generic list builder with the minimum width applied
Serialize list builder
serialization options. See SerializeOptions
list based on path in options. See List
Set generic list display options
allow / disallow for showing icons
generic list builder based on display options (showIcons) provided.
Append an item for each provided singleton definition id to the list.
Sugar for .items(singletonIds.map((id) => S.listItem().singleton(id))),
but additive: any items previously declared via .items(...) are
preserved and the singleton items are appended. Repeated .singletons()
calls keep appending.
Called without arguments, every singleton registered in
document.singletons is appended, in registration order.
Like every other S.list() chain, the caller must still set .id(...)
and .title(...) themselves; this helper does not produce a complete
list on its own.
The returned builder omits the items method at the type level, because
calling .items() afterwards would replace the whole items array and
silently discard the singleton items. See SingletonListBuilder.
Every id in singletonIds must refer to a registered singleton
definition, or a SerializeError is thrown immediately.
OptionalsingletonIds: string[]the singleton definition ids to render as list items. Defaults to every registered singleton definition id.
list builder with the singleton list items appended
Set generic list title
generic list title
generic list builder based on title and ID provided.
A
ListBuilderis used to build a list of items in the structure tool.