Class ComponentBuilder

Class for building components

Implements

Serializable<Component>

Index

Methods

child clone component getChild getComponent getI18n getId getMenuItemGroups getMenuItems getOptions getTitle i18n id menuItemGroups menuItems options serialize title

Methods

child

child(child: Child): ComponentBuilder
Set Component child
Parameters
- child: Child
  child component
Returns ComponentBuilder
component builder based on child component provided
- Defined in packages/sanity/src/structure/structureBuilder/Component.ts:140

clone

clone(withSpec?: BuildableComponent): ComponentBuilder
Clone component builder (allows for options overriding)
Parameters
- OptionalwithSpec: BuildableComponent
  component builder options
Returns ComponentBuilder
cloned builder
- Defined in packages/sanity/src/structure/structureBuilder/Component.ts:259

component

component(component: UserComponent): ComponentBuilder
Set component
Parameters
- component: UserComponent
  user built component
Returns ComponentBuilder
component builder based on component provided
- Defined in packages/sanity/src/structure/structureBuilder/Component.ts:155

getChild

getChild(): Child
Get Component child

Returns Child
child component
- Defined in packages/sanity/src/structure/structureBuilder/Component.ts:147

getComponent

getComponent(): UserComponent
Get Component

Returns UserComponent
component
- Defined in packages/sanity/src/structure/structureBuilder/Component.ts:162

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/Component.ts:132

getId

getId(): string
Get ID

Returns string
ID
- Defined in packages/sanity/src/structure/structureBuilder/Component.ts:102

getMenuItemGroups

getMenuItemGroups(): (MenuItemGroupBuilder | MenuItemGroup)[]
Get Component menu item groups

Returns (MenuItemGroupBuilder | MenuItemGroup)[]
menu item groups
- Defined in packages/sanity/src/structure/structureBuilder/Component.ts:207

getMenuItems

getMenuItems(): (MenuItemBuilder | MenuItem)[]
Get Component menu items

Returns (MenuItemBuilder | MenuItem)[]
menu items
- Defined in packages/sanity/src/structure/structureBuilder/Component.ts:192

getOptions

getOptions(): { [key: string]: unknown }
Get Component options

Returns { [key: string]: unknown }
component options
- Defined in packages/sanity/src/structure/structureBuilder/Component.ts:177

getTitle

getTitle(): string
Get Component title

Returns string
title
- Defined in packages/sanity/src/structure/structureBuilder/Component.ts:117

i18n

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

id

id(id: string): ComponentBuilder
Set Component ID
Parameters
- id: string
  component ID
Returns ComponentBuilder
component builder based on ID provided
- Defined in packages/sanity/src/structure/structureBuilder/Component.ts:95

menuItemGroups

menuItemGroups(
menuItemGroups: (MenuItemGroupBuilder | MenuItemGroup)[],
): ComponentBuilder
Set Component menu item groups
Parameters
- menuItemGroups: (MenuItemGroupBuilder | MenuItemGroup)[]
  component menu item groups
Returns ComponentBuilder
component builder based on menuItemGroups provided
- Defined in packages/sanity/src/structure/structureBuilder/Component.ts:200

menuItems

menuItems(menuItems: (MenuItemBuilder | MenuItem)[]): ComponentBuilder
Set Component menu items
Parameters
- menuItems: (MenuItemBuilder | MenuItem)[]
  component menu items
Returns ComponentBuilder
component builder based on menuItems provided
- Defined in packages/sanity/src/structure/structureBuilder/Component.ts:185

options

options(options: { [key: string]: unknown }): ComponentBuilder
Set Component options
Parameters
- options: { [key: string]: unknown }
  component options
Returns ComponentBuilder
component builder based on options provided
- Defined in packages/sanity/src/structure/structureBuilder/Component.ts:170

serialize

serialize(options?: SerializeOptions): Component
Serialize component
Parameters
- options: SerializeOptions = ...
  serialization options
Returns Component
component object based on path provided in options
Implementation of Serializable.serialize
- Defined in packages/sanity/src/structure/structureBuilder/Component.ts:220

title

title(title: string): ComponentBuilder
Set Component title
Parameters
- title: string
  component title
Returns ComponentBuilder
component builder based on title provided (and ID)
- Defined in packages/sanity/src/structure/structureBuilder/Component.ts:110