Class ListBuilder

A ListBuilder is used to build a list of items in the structure tool.

Hierarchy (View Summary)

GenericListBuilder<BuildableList, ListBuilder>
- ListBuilder

Methods

canHandleIntent

canHandleIntent(canHandleIntent?: IntentChecker): ListBuilder
Set generic list can handle intent
Parameters
- OptionalcanHandleIntent: IntentChecker
  generic list intent checker. See IntentChecker
Returns ListBuilder
generic list builder based on can handle intent provided.
Inherited from GenericListBuilder.canHandleIntent
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:236

child

child(child: Child): ListBuilder
Set generic list child
Parameters
- child: Child
  generic list child. See Child
Returns ListBuilder
generic list builder based on child provided (clone).
Inherited from GenericListBuilder.child
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:221

clone

clone(withSpec?: BuildableList): ListBuilder
Clone list builder and return new list builder based on context and spec provided
Parameters
- OptionalwithSpec: BuildableList
  list options. See BuildableList
Returns ListBuilder
new list builder based on context and spec provided. See ListBuilder
Overrides GenericListBuilder.clone
- Defined in packages/sanity/src/structure/structureBuilder/List.ts:212

defaultLayout

defaultLayout(defaultLayout: PreviewLayoutKey): ListBuilder
Set generic list layout
Parameters
- defaultLayout: PreviewLayoutKey
  generic list layout key.
Returns ListBuilder
generic list builder based on layout provided.
Inherited from GenericListBuilder.defaultLayout
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:176

getCanHandleIntent

getCanHandleIntent(): IntentChecker
Get generic list can handle intent

Returns IntentChecker
generic list can handle intent
Inherited from GenericListBuilder.getCanHandleIntent
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:243

getChild

getChild(): Child
Get generic list child

Returns Child
generic list child
Inherited from GenericListBuilder.getChild
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:228

getDefaultLayout

getDefaultLayout(): PreviewLayoutKey
Get generic list layout

Returns PreviewLayoutKey
generic list layout
Inherited from GenericListBuilder.getDefaultLayout
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:183

getI18n

getI18n(): I18nTextRecord<"title">
Get i18n key and namespace used to populate the localized title

Returns I18nTextRecord<"title">
the i18n key and namespace used to populate the localized title
Inherited from GenericListBuilder.getI18n
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:168

getId

getId(): string
Get generic list ID

Returns string
generic list ID
Inherited from GenericListBuilder.getId
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:138

getInitialValueTemplates

getInitialValueTemplates(): any[]
Get generic list initial value templates

Returns any[]
generic list initial value templates
Inherited from GenericListBuilder.getInitialValueTemplates
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:281

getShowIcons

getShowIcons(): boolean
Get generic list display options

Returns boolean
generic list display options (specifically showIcons)
Inherited from GenericListBuilder.getShowIcons
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:260

getTitle

getTitle(): string
Get generic list title

Returns string
generic list title
Inherited from GenericListBuilder.getTitle
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:153

i18n

i18n(i18n: I18nTextRecord<"title">): ListBuilder
Set the i18n key and namespace used to populate the localized title.
Parameters
- i18n: I18nTextRecord<"title">
  the key and namespaced used to populate the localized title.
Returns ListBuilder
component builder based on i18n key and ns provided
Inherited from GenericListBuilder.i18n
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:161

id

id(id: string): ListBuilder
Set generic list ID
Parameters
- id: string
  generic list ID
Returns ListBuilder
generic list builder based on ID provided.
Inherited from GenericListBuilder.id
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:131

initialValueTemplates

initialValueTemplates(templates: any): ListBuilder
Set generic list initial value templates
Parameters
- templates: any
  generic list initial value templates. See InitialValueTemplateItemBuilder
Returns ListBuilder
generic list builder based on templates provided.
Inherited from GenericListBuilder.initialValueTemplates
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:268

items

items(
items: (ListItemBuilder | Divider | ListItem | DividerBuilder)[],
): ListBuilder
Set list builder based on items provided
Parameters
- items: (ListItemBuilder | Divider | ListItem | DividerBuilder)[]
  list items. See ListItemBuilder, ListItem and Divider
Returns ListBuilder
list builder based on items provided. See ListBuilder
- Defined in packages/sanity/src/structure/structureBuilder/List.ts:150

menuItemGroups

menuItemGroups(
menuItemGroups: (MenuItemGroupBuilder | MenuItemGroup)[],
): ListBuilder
Set generic list menu item groups
Parameters
- menuItemGroups: (MenuItemGroupBuilder | MenuItemGroup)[]
  generic list menu item groups. See MenuItemGroup and MenuItemGroupBuilder
Returns ListBuilder
generic list builder based on menu item groups provided.
Inherited from GenericListBuilder.menuItemGroups
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:206

menuItems

menuItems(menuItems: (MenuItemBuilder | MenuItem)[]): ListBuilder
Set generic list menu items
Parameters
- menuItems: (MenuItemBuilder | MenuItem)[]
  generic list menu items. See MenuItem and MenuItemBuilder
Returns ListBuilder
generic list builder based on menu items provided.
Inherited from GenericListBuilder.menuItems
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:191

serialize

serialize(options?: SerializeOptions): List
Serialize list builder
Parameters
- options: SerializeOptions = ...
  serialization options. See SerializeOptions
Returns List
list based on path in options. See List
Overrides GenericListBuilder.serialize
- Defined in packages/sanity/src/structure/structureBuilder/List.ts:165

showIcons

showIcons(enabled?: boolean): ListBuilder
Set generic list display options
Parameters
- enabled: boolean = true
  allow / disallow for showing icons
Returns ListBuilder
generic list builder based on display options (showIcons) provided.
Inherited from GenericListBuilder.showIcons
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:251

title

title(title: string): ListBuilder
Set generic list title
Parameters
- title: string
  generic list title
Returns ListBuilder
generic list builder based on title and ID provided.
Inherited from GenericListBuilder.title
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:146

Class ListBuilder

Hierarchy (View Summary)

Index

Methods

Methods

canHandleIntent

Parameters

Returns ListBuilder

child

Parameters

Returns ListBuilder

clone

Parameters

Returns ListBuilder

defaultLayout

Parameters

Returns ListBuilder

getCanHandleIntent

Returns IntentChecker

getChild

Returns Child

getDefaultLayout

Returns PreviewLayoutKey

getI18n

Returns I18nTextRecord<"title">

getId

Returns string

getInitialValueTemplates

Returns any[]

getItems

Returns (ListItemBuilder | Divider | ListItem | DividerBuilder)[]

getMenuItemGroups

Returns (MenuItemGroupBuilder | MenuItemGroup)[]

getMenuItems

Returns (MenuItemBuilder | MenuItem)[]

getShowIcons

Returns boolean

getTitle

Returns string

i18n

Parameters

Returns ListBuilder

id

Parameters

Returns ListBuilder

initialValueTemplates

Parameters

Returns ListBuilder

items

Parameters

Returns ListBuilder

menuItemGroups

Parameters

Returns ListBuilder

menuItems

Parameters

Returns ListBuilder

serialize

Parameters

Returns List

showIcons

Parameters

Returns ListBuilder

title

Parameters

Returns ListBuilder

Settings

On This Page