Class ListItemBuilder

Class for building list items

Hierarchy (View Summary)

ListItemBuilder
- DocumentListItemBuilder

Implements

Serializable<ListItem>

Index

Methods

child clone getChild getI18n getIcon getId getSchemaType getShowIcon getTitle i18n icon id schemaType serialize showIcon title

Methods

child

child(child: UnserializedListItemChild): ListItemBuilder
Set list item child
Parameters
- child: UnserializedListItemChild
  list item child. See UnserializedListItemChild
Returns ListItemBuilder
list item builder based on child provided. See ListItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/ListItem.ts:239

clone

clone(withSpec?: Partial): ListItemBuilder
Clone list item builder
Parameters
- OptionalwithSpec: Partial
  partial list item options. See PartialListItem
Returns ListItemBuilder
list item builder based on context and spec provided. See ListItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/ListItem.ts:340

getChild

getChild(): UnserializedListItemChild
Get list item child

Returns UnserializedListItemChild
list item child. See PartialListItem
- Defined in packages/sanity/src/structure/structureBuilder/ListItem.ts:247

getI18n

getI18n(): any
Get i18n key and namespace used to populate the localized title

Returns any
the i18n key and namespace used to populate the localized title
- Defined in packages/sanity/src/structure/structureBuilder/ListItem.ts:196

getIcon

getIcon(): ReactNode | ComponentType<{}>
Get list item icon

Returns ReactNode | ComponentType<{}>
list item icon. See PartialListItem
- Defined in packages/sanity/src/structure/structureBuilder/ListItem.ts:230

getId

getId(): string
Get list item ID

Returns string
list item ID. See PartialListItem
- Defined in packages/sanity/src/structure/structureBuilder/ListItem.ts:165

getSchemaType

getSchemaType(): any
Get list item schema type

Returns any
list item schema type. See PartialListItem
- Defined in packages/sanity/src/structure/structureBuilder/ListItem.ts:264

getShowIcon

getShowIcon(): boolean
Check if list item should show icon

Returns boolean
true if it should show the icon, false if not, undefined if not set
- Defined in packages/sanity/src/structure/structureBuilder/ListItem.ts:222

getTitle

getTitle(): string
Get list item title

Returns string
list item title. See PartialListItem
- Defined in packages/sanity/src/structure/structureBuilder/ListItem.ts:181

i18n

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

icon

icon(icon: ReactNode | ComponentType<{}>): ListItemBuilder
Set list item icon
Parameters
- icon: ReactNode | ComponentType<{}>
Returns ListItemBuilder
list item builder based on icon provided. See ListItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/ListItem.ts:204

id

id(id: string): ListItemBuilder
Set list item ID
Parameters
- id: string
Returns ListItemBuilder
list item builder based on ID provided. See ListItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/ListItem.ts:157

schemaType

schemaType(schemaType: any): ListItemBuilder
Set list item schema type
Parameters
- schemaType: any
  list item schema type. See SchemaType
Returns ListItemBuilder
list item builder based on schema type provided. See ListItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/ListItem.ts:256

serialize

serialize(options?: ListItemSerializeOptions): ListItem
Serialize list item builder
Parameters
- options: ListItemSerializeOptions = ...
  serialization options. See ListItemSerializeOptions
Returns ListItem
list item node based on path provided in options. See ListItem
Implementation of Serializable.serialize
- Defined in packages/sanity/src/structure/structureBuilder/ListItem.ts:278

showIcon

showIcon(enabled?: boolean): ListItemBuilder
Set if list item should show icon
Parameters
- enabled: boolean = true
Returns ListItemBuilder
list item builder based on showIcon provided. See ListItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/ListItem.ts:212

title

title(title: string): ListItemBuilder
Set list item title
Parameters
- title: string
Returns ListItemBuilder
list item builder based on title provided. See ListItemBuilder
- Defined in packages/sanity/src/structure/structureBuilder/ListItem.ts:173