Class ListItemBuilder

constructor

• new ListItemBuilder(
      _context: StructureContext,
      spec?: ListItemInput,
  ): ListItemBuilder

  Parameters

  • _context: StructureContext

    Structure context. See StructureContext
  • Optionalspec: ListItemInput

  Returns ListItemBuilder

Readonly[serializableMarker]

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

clone

• clone(withSpec?: PartialListItem): ListItemBuilder

  Clone list item builder

  Parameters

  • OptionalwithSpec: PartialListItem

    partial list item options. See PartialListItem

  Returns ListItemBuilder

  list item builder based on context and spec provided. See ListItemBuilder

getChild

• getChild(): UnserializedListItemChild

  Get list item child

  Returns UnserializedListItemChild

  list item child. See PartialListItem

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

getIcon

• getIcon(): ReactNode | ComponentType<{}>

  Get list item icon

  Returns ReactNode | ComponentType<{}>

  list item icon. See PartialListItem

getId

• getId(): string

  Get list item ID

  Returns string

  list item ID. See PartialListItem

getSchemaType

• getSchemaType(): string | SchemaType

  Get list item schema type

  Returns string | SchemaType

  list item schema type. See PartialListItem

getShowCount

• getShowCount(): boolean

  Check if list item should show a live document count

  Returns boolean

  true if it should show the count, false if not, undefined if not set

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

getTitle

• getTitle(): string

  Get list item title

  Returns string

  list item title. See PartialListItem

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

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

id

• id(id: string): ListItemBuilder

  Set list item ID

  Parameters

  • id: string

  Returns ListItemBuilder

  list item builder based on ID provided. See ListItemBuilder

schemaType

• schemaType(schemaType: string | SchemaType): ListItemBuilder

  Set list item schema type

  Parameters

  • schemaType: string | SchemaType

    list item schema type. See SchemaType

  Returns ListItemBuilder

  list item builder based on schema type provided. See ListItemBuilder

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

showCount

• showCount(enabled?: boolean): ListItemBuilder

  Set if list item should show a live document count.

  The badge counts every document of the item's schema type. It is withheld, with a development warning, unless the item resolves a document schema type and its child is proven to list every document of that type: the built-in document type child, or a document list carrying the default whole-type query at the default api version.

  Parameters

  • enabled: boolean = true

  Returns ListItemBuilder

  list item builder based on showCount provided. See ListItemBuilder

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

singleton

• singleton(singletonId: string): ListItemBuilder

  Configure the list item to render a singleton.

  Sugar for declaring a list item with sensible defaults derived from the singleton definition:

  • id defaults to the singleton definition id.
  • title defaults to the definition's title, falling back to the schema type's title. Singletons sharing a schema type therefore share a title unless their definitions set one—list item ids must be unique, titles need not be.
  • icon defaults to the definition's icon, falling back to the schema type's icon.
  • child defaults to a S.document().singleton(<id>) node.
  • schemaType is set to the definition's schema type.

  Each default can be overridden via the standard list-item chain (.title(...), .icon(...), .id(...), .child(...))—before or after this call.

  A SerializeError is thrown immediately if no singleton definition exists for the provided id.

  Parameters

  • singletonId: string

    the singleton definition id

  Returns ListItemBuilder

  list item builder configured for the singleton

title

• title(title: string): ListItemBuilder

  Set list item title

  Parameters

  • title: string

  Returns ListItemBuilder

  list item builder based on title provided. See ListItemBuilder