Class ComponentViewBuilder

Class for building a component view.

Hierarchy (View Summary)

GenericViewBuilder<Partial<ComponentView>, ComponentViewBuilder>
- ComponentViewBuilder

Index

Methods

clone component getComponent getIcon getId getOptions getTitle icon id options serialize title

Methods

clone

clone(
withSpec?: Partial<ComponentView<Record<string, any>>>,
): ComponentViewBuilder
Clone Component view builder (allows for options overriding)
Parameters
- OptionalwithSpec: Partial<ComponentView<Record<string, any>>>
  partial for component view option. See ComponentView
Returns ComponentViewBuilder
component view builder. See ComponentViewBuilder
Overrides GenericViewBuilder.clone
- Defined in packages/sanity/src/structure/structureBuilder/views/ComponentView.ts:114

component

component(component: UserViewComponent): ComponentViewBuilder
Set view Component
Parameters
- component: UserViewComponent
  component view component. See UserViewComponent
Returns ComponentViewBuilder
component view builder based on component view provided. See ComponentViewBuilder
- Defined in packages/sanity/src/structure/structureBuilder/views/ComponentView.ts:59

getComponent

getComponent(): UserViewComponent
Get view Component

Returns UserViewComponent
Partial component view. See ComponentView
- Defined in packages/sanity/src/structure/structureBuilder/views/ComponentView.ts:66

getIcon

getIcon(): ReactNode | ComponentType<{}>
Get generic view icon

Returns ReactNode | ComponentType<{}>
generic view icon
Inherited from GenericViewBuilder.getIcon
- Defined in packages/sanity/src/structure/structureBuilder/views/View.ts:74

getId

getId(): string
Get generic view ID

Returns string
generic view ID
Inherited from GenericViewBuilder.getId
- Defined in packages/sanity/src/structure/structureBuilder/views/View.ts:44

getOptions

getOptions(): Record<string, any>
Get view Component options

Returns Record<string, any>
component view options. See ComponentView
- Defined in packages/sanity/src/structure/structureBuilder/views/ComponentView.ts:81

getTitle

getTitle(): string
Get generic view title

Returns string
generic view title
Inherited from GenericViewBuilder.getTitle
- Defined in packages/sanity/src/structure/structureBuilder/views/View.ts:59

icon

icon(icon: ReactNode | ComponentType<{}>): ComponentViewBuilder
Set generic view icon
Parameters
- icon: ReactNode | ComponentType<{}>
  generic view icon
Returns ComponentViewBuilder
generic view builder based on icon provided.
Inherited from GenericViewBuilder.icon
- Defined in packages/sanity/src/structure/structureBuilder/views/View.ts:67

id

id(id: string): ComponentViewBuilder
Set generic view ID
Parameters
- id: string
  generic view ID
Returns ComponentViewBuilder
generic view builder based on ID provided.
Inherited from GenericViewBuilder.id
- Defined in packages/sanity/src/structure/structureBuilder/views/View.ts:38

options

options(options: { [key: string]: any }): ComponentViewBuilder
Set view Component options
Parameters
- options: { [key: string]: any }
  component view options
Returns ComponentViewBuilder
component view builder based on options provided. See ComponentViewBuilder
- Defined in packages/sanity/src/structure/structureBuilder/views/ComponentView.ts:74

serialize

serialize(options?: SerializeOptions): ComponentView
Serialize view Component
Parameters
- options: SerializeOptions = ...
  serialization options. See SerializeOptions
Returns ComponentView
component view based on path provided in options. See ComponentView
Overrides GenericViewBuilder.serialize
- Defined in packages/sanity/src/structure/structureBuilder/views/ComponentView.ts:90

title

title(title: string): ComponentViewBuilder
Set generic view title
Parameters
- title: string
  generic view title
Returns ComponentViewBuilder
generic view builder based on title provided and (if provided) its ID.
Inherited from GenericViewBuilder.title
- Defined in packages/sanity/src/structure/structureBuilder/views/View.ts:52