Class DocumentBuilder

A DocumentBuilder is used to build a document node.

Implements

Serializable<DocumentNode>

Constructors

constructor

new DocumentBuilder(
_context: StructureContext,
spec?: PartialDocumentNode,
): DocumentBuilder
Parameters
- _context: StructureContext
  Structure context. See StructureContext
- Optionalspec: PartialDocumentNode
Returns DocumentBuilder
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:98

Methods

child

child(child: Child): DocumentBuilder
Set Document child
Parameters
- child: Child
  document child
Returns DocumentBuilder
document builder based on child provided. See DocumentBuilder
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:158

clone

clone(withSpec?: PartialDocumentNode): DocumentBuilder
Clone Document builder
Parameters
- withSpec: PartialDocumentNode = {}
  partial document node specification used to extend the cloned builder. See PartialDocumentNode
Returns DocumentBuilder
document builder based on context and spec provided. See DocumentBuilder
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:373

defaultPanes

defaultPanes(viewIds: string[]): DocumentBuilder
Set the view IDs to open as split panes by default when the document is opened. Pass an array of view IDs that match the IDs defined in views(). If specified with 2+ valid view IDs, the document will open in split-pane mode.
Parameters
- viewIds: string[]
  Array of view IDs to open as split panes
Returns DocumentBuilder
document builder with defaultPanes config. See DocumentBuilder
Example
```
S.document()
  .schemaType('article')
  .views([
    S.view.form().id('editor'),
    S.view.component(PreviewPane).id('preview').title('Preview')
  ])
  .defaultPanes(['editor', 'preview'])  // Opens both as split panes
```
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:275

documentId

documentId(documentId: string): DocumentBuilder
Set Document ID
Parameters
- documentId: string
  document ID
Returns DocumentBuilder
document builder with document based on ID provided. See DocumentBuilder
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:173

getChild

getChild(): Child
Get Document child

Returns Child
document child. See PartialDocumentNode
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:165

getDocumentId

getDocumentId(): string
Get Document ID

Returns string
document ID. See DocumentOptions
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:188

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
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:150

getId

getId(): string
Get Document Builder ID

Returns string
document ID. See PartialDocumentNode
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:120

getInitialValueTemplate

getInitialValueTemplate(): string
Get Document Template

Returns string
document template. See DocumentOptions
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:230

getInitialValueTemplateParameters

getInitialValueTemplateParameters(): Record<string, unknown>
Get Document's initial value Template parameters

Returns Record<string, unknown>
document template parameters. See DocumentOptions
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:237

getSchemaType

getSchemaType(): string
Get Document Type

Returns string
document type. See DocumentOptions
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:208

getTitle

getTitle(): string
Get Document title

Returns string
document title. See PartialDocumentNode
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:135

getViews

getViews(): (View | ViewBuilder)[]
Get Document views

Returns (View | ViewBuilder)[]
document views. See ViewBuilder and View
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:252

i18n

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

id

id(id: string): DocumentBuilder
Set Document Builder ID
Parameters
- id: string
  document builder ID
Returns DocumentBuilder
document builder based on ID provided. See DocumentBuilder
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:113

initialValueTemplate

initialValueTemplate(
templateId: string,
parameters?: Record<string, unknown>,
): DocumentBuilder
Set Document Template
Parameters
- templateId: string
  document template ID
- Optionalparameters: Record<string, unknown>
  document template parameters
Returns DocumentBuilder
document builder with document based on template provided. See DocumentBuilder
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:217

schemaType

schemaType(documentType: string | SchemaType): DocumentBuilder
Set Document Type
Parameters
- documentType: string | SchemaType
  document type
Returns DocumentBuilder
document builder with document based on type provided. See DocumentBuilder
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:196

serialize

serialize(options?: SerializeOptions): DocumentNode
Serialize Document builder
Parameters
- options: SerializeOptions = ...
  serialization options. See SerializeOptions
Returns DocumentNode
document node based on path, index and hint provided in options. See DocumentNode
Implementation of Serializable.serialize
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:283

title

title(title: string): DocumentBuilder
Set Document title
Parameters
- title: string
  document title
Returns DocumentBuilder
document builder based on title provided (and ID). See DocumentBuilder
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:128

views

views(views: (View | ViewBuilder)[]): DocumentBuilder
Set Document views
Parameters
- views: (View | ViewBuilder)[]
  document views. See ViewBuilder and View
Returns DocumentBuilder
document builder with document based on views provided. See DocumentBuilder
- Defined in packages/sanity/src/structure/structureBuilder/Document.ts:245

Class DocumentBuilder

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DocumentBuilder

Methods

child

Parameters

Returns DocumentBuilder

clone

Parameters

Returns DocumentBuilder

defaultPanes

Parameters

Returns DocumentBuilder

Example

documentId

Parameters

Returns DocumentBuilder

getChild

Returns Child

getDocumentId

Returns string

getI18n

Returns I18nTextRecord<"title">

getId

Returns string

getInitialValueTemplate

Returns string

getInitialValueTemplateParameters

Returns Record<string, unknown>

getSchemaType

Returns string

getTitle

Returns string

getViews

Returns (View | ViewBuilder)[]

i18n

Parameters

Returns DocumentBuilder

id

Parameters

Returns DocumentBuilder

initialValueTemplate

Parameters

Returns DocumentBuilder

schemaType

Parameters

Returns DocumentBuilder

serialize

Parameters

Returns DocumentNode

title

Parameters

Returns DocumentBuilder

views

Parameters

Returns DocumentBuilder

Settings

On This Page