Class GenericListBuilder<TList, ConcreteImpl>`Abstract`

Class for building generic lists

Type Parameters

TList extends BuildableGenericList
ConcreteImpl

Hierarchy (View Summary)

GenericListBuilder
- DocumentListBuilder
- ListBuilder

Implements

Serializable<GenericList>

Methods

canHandleIntent

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

child

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

`Abstract`clone

clone(_withSpec?: object): ConcreteImpl
Clone generic list builder (allows for options overriding)
Parameters
- Optional_withSpec: object
  generic list options.
Returns ConcreteImpl
generic list builder.
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:330

defaultLayout

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

getCanHandleIntent

getCanHandleIntent(): TList["canHandleIntent"]
Get generic list can handle intent

Returns TList["canHandleIntent"]
generic list can handle intent
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:243

getChild

getChild(): TList["child"]
Get generic list child

Returns TList["child"]
generic list child
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:228

getDefaultLayout

getDefaultLayout(): TList["defaultLayout"]
Get generic list layout

Returns TList["defaultLayout"]
generic list layout
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:183

getI18n

getI18n(): TList["i18n"]
Get i18n key and namespace used to populate the localized title

Returns TList["i18n"]
the i18n key and namespace used to populate the localized title
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:168

getId

getId(): TList["id"]
Get generic list ID

Returns TList["id"]
generic list ID
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:138

getInitialValueTemplates

getInitialValueTemplates(): TList["initialValueTemplates"]
Get generic list initial value templates

Returns TList["initialValueTemplates"]
generic list initial value templates
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:281

getMenuItemGroups

getMenuItemGroups(): TList["menuItemGroups"]
Get generic list menu item groups

Returns TList["menuItemGroups"]
generic list menu item groups
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:213

getMenuItems

getMenuItems(): TList["menuItems"]
Get generic list menu items

Returns TList["menuItems"]
generic list menu items
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:198

getShowIcons

getShowIcons(): boolean
Get generic list display options

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

getTitle

getTitle(): TList["title"]
Get generic list title

Returns TList["title"]
generic list title
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:153

i18n

i18n(i18n: I18nTextRecord<"title">): ConcreteImpl
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 ConcreteImpl
component builder based on i18n key and ns provided
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:161

id

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

initialValueTemplates

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

menuItemGroups

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

menuItems

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

serialize

serialize(options?: SerializeOptions): GenericList
Serialize generic list
Parameters
- options: SerializeOptions = ...
  serialization options. See SerializeOptions
Returns GenericList
generic list object based on path provided in options. See GenericList
Implementation of Serializable.serialize
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:289

showIcons

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

title

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