Class GenericViewBuilder<TView, ConcreteImpl>`Abstract`

Class for building generic views.

Type Parameters

TView extends Partial<BaseView>
ConcreteImpl

Hierarchy (View Summary)

GenericViewBuilder
- ComponentViewBuilder
- FormViewBuilder

Implements

Serializable<BaseView>

Index

Methods

clone getIcon getId getTitle icon id serialize title

Methods

`Abstract`clone

clone(withSpec?: Partial<BaseView>): ConcreteImpl
Clone generic view builder (allows for options overriding)
Parameters
- OptionalwithSpec: Partial<BaseView>
  Partial generic view builder options. See BaseView
Returns ConcreteImpl
Generic view builder.
- Defined in packages/sanity/src/structure/structureBuilder/views/View.ts:111

getIcon

getIcon(): TView["icon"]
Get generic view icon

Returns TView["icon"]
generic view icon
- Defined in packages/sanity/src/structure/structureBuilder/views/View.ts:74

getId

getId(): TView["id"]
Get generic view ID

Returns TView["id"]
generic view ID
- Defined in packages/sanity/src/structure/structureBuilder/views/View.ts:44

getTitle

getTitle(): TView["title"]
Get generic view title

Returns TView["title"]
generic view title
- Defined in packages/sanity/src/structure/structureBuilder/views/View.ts:59

icon

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

id

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

serialize

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

title

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