Class DocumentBuilder

constructor

• new DocumentBuilder(
      _context: StructureContext,
      spec?: PartialDocumentNode,
  ): DocumentBuilder

  Parameters

  • _context: StructureContext

    Structure context. See StructureContext
  • Optionalspec: PartialDocumentNode

  Returns DocumentBuilder

Readonly[serializableMarker]

child

• child(child: Child): DocumentBuilder

  Set Document child

  Parameters

  • child: Child

    document child

  Returns DocumentBuilder

  document builder based on child provided. See DocumentBuilder

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

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
  Copy

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

getChild

• getChild(): Child

  Get Document child

  Returns Child

  document child. See PartialDocumentNode

getDocumentId

• getDocumentId(): string

  Get Document ID

  Returns string

  document ID. See DocumentOptions

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

getId

• getId(): string

  Get Document Builder ID

  Returns string

  document ID. See PartialDocumentNode

getInitialValueTemplate

• getInitialValueTemplate(): string

  Get Document Template

  Returns string

  document template. See DocumentOptions

getInitialValueTemplateParameters

• getInitialValueTemplateParameters(): Record<string, unknown>

  Get Document's initial value Template parameters

  Returns Record<string, unknown>

  document template parameters. See DocumentOptions

getSchemaType

• getSchemaType(): string

  Get Document Type

  Returns string

  document type. See DocumentOptions

getTitle

• getTitle(): string

  Get Document title

  Returns string

  document title. See PartialDocumentNode

getViews

• getViews(): (View | ViewBuilder)[]

  Get Document views

  Returns (View | ViewBuilder)[]

  document views. See ViewBuilder and View

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

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

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

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

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

singleton

• singleton(singletonId: string): DocumentBuilder

  Configure the document builder to render a singleton.

  Sugar for .schemaType(<schemaType>).documentId(<documentId>), where both values are read from the singleton definition registered under the provided singleton definition id in the document.singletons configuration. A SerializeError is thrown immediately if no such definition exists.

  The singleton's generated initial value template (the template tagged with the singleton definition id) is also selected if it exists, so the singleton's initial value applies deterministically even when the type has multiple templates.

  Subsequent .documentId(...), .schemaType(...), or .initialValueTemplate(...) calls override these defaults, preserving the immutable-builder ergonomics of the rest of DocumentBuilder.

  Parameters

  • singletonId: string

    the singleton definition id

  Returns DocumentBuilder

  document builder configured for the singleton

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

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