Class FormViewBuilder

Class for building a form view.

Hierarchy (View Summary)

GenericViewBuilder<Partial<BaseView>, FormViewBuilder>
- FormViewBuilder

Index

Methods

clone getIcon getId getTitle icon id serialize title

Methods

clone

clone(withSpec?: Partial<FormView>): FormViewBuilder
Clone Form view builder (allows for options overriding)
Parameters
- OptionalwithSpec: Partial<FormView>
  Partial form view builder options. See FormView
Returns FormViewBuilder
form view builder. See FormViewBuilder
Overrides GenericViewBuilder.clone
- Defined in packages/sanity/src/structure/structureBuilder/views/FormView.ts:42

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

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<{}>): FormViewBuilder
Set generic view icon
Parameters
- icon: ReactNode | ComponentType<{}>
  generic view icon
Returns FormViewBuilder
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): FormViewBuilder
Set generic view ID
Parameters
- id: string
  generic view ID
Returns FormViewBuilder
generic view builder based on ID provided.
Inherited from GenericViewBuilder.id
- Defined in packages/sanity/src/structure/structureBuilder/views/View.ts:38

serialize

serialize(options?: SerializeOptions): FormView
Serialize Form view builder
Parameters
- options: SerializeOptions = ...
  Serialize options. See SerializeOptions
Returns FormView
form view builder based on path provided in options. See FormView
Overrides GenericViewBuilder.serialize
- Defined in packages/sanity/src/structure/structureBuilder/views/FormView.ts:30

title

title(title: string): FormViewBuilder
Set generic view title
Parameters
- title: string
  generic view title
Returns FormViewBuilder
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