StructuredContent extension

Native Word SDT (w:sdt) fields for documents. Supports inline and block structured content tags for dynamic templates with full Word compatibility.

Use Case

Form templates - Create fillable documents with inline text fields and block content areas
Contract generation - Dynamic clauses and terms that map to Word content controls
Document automation - Programmatically update specific sections while preserving structure

Quick Start

// Insert inline field for customer name
editor.commands.insertStructuredContentInline({
  attrs: {
    id: '1',
    alias: 'Customer Name'
  },
  text: 'John Doe'
});

// Insert block field for terms section
editor.commands.insertStructuredContentBlock({
  attrs: {
    id: '2',
    alias: 'Terms & Conditions'
  },
  html: '<p>Please review the terms...</p>'
});

// Update inline field content
editor.commands.updateStructuredContentById('1', {
  text: 'Jane Smith'
});

// Update block field content and attributes
editor.commands.updateStructuredContentById('2', {
  html: '<p>Updated terms and conditions...</p>',
  attrs: { alias: 'Legal Terms' }
});

// Get all structured content tags
const allTags = editor.helpers.structuredContentCommands.getStructuredContentTags(editor.state);
console.log(`Document contains ${allTags.length} SDT fields`);

Options

Configure the extension behavior:

structuredContentClass

string

default:"sd-structured-content-block-tag"

CSS class for the block

htmlAttributes

Object

HTML attributes for structured content blocks

Attributes

Node attributes that can be set and retrieved:

string

Unique identifier for the structured content block

The id attribute must be a numeric string for valid DOCX output (per ECMA-376 §17.5.2.18). Use Date.now().toString() or sequential integers instead of UUIDs.

tag

string

Content control tag (e.g., ‘block_table_sdt’)

alias

string

default:"Structured content"

Display name for the block

Commands

`insertStructuredContentInline`

Inserts a structured content inline at selection. Parameters:

options

StructuredContentInlineInsert

required

`insertStructuredContentBlock`

Inserts a structured content block at selection. Parameters:

options

StructuredContentBlockInsert

required

`updateStructuredContentById`

Updates a single structured content field by its unique ID. IDs are unique identifiers, so this will update at most one field. If the updated node does not match the schema, it will not be updated. Parameters:

string

required

Unique identifier of the field

options

StructuredContentUpdate

required

`deleteStructuredContent`

Removes a structured content. Parameters:

structuredContentTags

Array<any>

required

`deleteStructuredContentById`

Removes a structured content by ID. Parameters:

idOrIds

string | Array<string>

required

`deleteStructuredContentAtSelection`

Removes a structured content at cursor, preserving its content.

`appendRowsToStructuredContentTable`

Append multiple rows to the end of a table inside a structured content block. Each inner array represents the cell values for one new row. Example:

editor.commands.appendRowsToStructuredContentTable({
  id: "block-123",
  tableIndex: 0,
  rows: [
    ["A", "B"],
    ["C", "D"],
  ],
  copyRowStyle: true,
});

Parameters:

options

StructuredContentTableAppendRowsOptions

required

Append configuration

Helpers

`getStructuredContentBlockTags`

Get all block-level structured content tags in the document Example:

const blocks = editor.helpers.getStructuredContentBlockTags(editor.state);
console.log(`Found ${blocks.length} structured content blocks`);

Parameters:

state

any

required

`getStructuredContentInlineTags`

Get all inline structured content tags in the document Example:

const inlines = editor.helpers.getStructuredContentInlineTags(editor.state);
console.log(`Found ${inlines.length} inline fields`);

Parameters:

state

any

required

`getStructuredContentTablesById`

Find all tables inside a structured content block by ID Example:

const tables = editor.helpers.getStructuredContentTablesById(
  "block-123",
  editor.state
);
console.log(`Block contains ${tables.length} table(s)`);

Parameters:

string

required

Structured content block ID

state

any

required

`getStructuredContentTags`

Get all structured content tags (inline and block) in the document Example:

const allTags = editor.helpers.getStructuredContentTags(editor.state);
console.log(`Found ${allTags.length} structured content elements`);

Parameters:

state

any

required

`getStructuredContentTagsById`

Get structured content tag(s) by ID Example:

const field = editor.helpers.getStructuredContentTagsById(
  "field-123",
  editor.state
);
if (field.length) console.log("Found field:", field[0].node.attrs);

Parameters:

idOrIds

string | Array<string>

required

Single ID or array of IDs to find

state

any

required

Types

`StructuredContentInlineInsert`

Show Properties

text

string

Text content to insert

json

Object

ProseMirror JSON

attrs

Object

Node attributes

`StructuredContentBlockInsert`

Show Properties

html

string

HTML content to insert

json

Object

ProseMirror JSON

attrs

Object

Node attributes

`StructuredContentUpdate`

Show Properties

text

string

Replace content with text (only for structured content inline)

html

string

Replace content with HTML (only for structured content block)

json

Object

Replace content with ProseMirror JSON (overrides html)

attrs

Object

Update attributes only (preserves content)

`StructuredContentTableAppendRowsOptions`

Show Properties

string

required

Structured content block identifier

tableIndex

number

Index of the table inside the block

rows

Array<Array<string>> | Array<string>

required

Cell values to append

copyRowStyle

boolean

Clone the last row’s styling when true

Source Code

View on GitHub →

Getting Started

Core

AI

Modules

Extensions

Solutions

Resources

StructuredContent extension

Use Case

Quick Start

Options

Attributes

Commands

`insertStructuredContentInline`

`insertStructuredContentBlock`

`updateStructuredContentById`

`deleteStructuredContent`

`deleteStructuredContentById`

`deleteStructuredContentAtSelection`

`appendRowsToStructuredContentTable`

Helpers

`getStructuredContentBlockTags`

`getStructuredContentInlineTags`

`getStructuredContentTablesById`

`getStructuredContentTags`

`getStructuredContentTagsById`

Types

`StructuredContentInlineInsert`

`StructuredContentBlockInsert`

`StructuredContentUpdate`

`StructuredContentTableAppendRowsOptions`

Source Code

Getting Started

Core

AI

Modules

Extensions

Solutions

Resources

​Use Case

​Quick Start

​Options

​Attributes

​Commands

​insertStructuredContentInline

​insertStructuredContentBlock

​updateStructuredContentById

​deleteStructuredContent

​deleteStructuredContentById

​deleteStructuredContentAtSelection

​appendRowsToStructuredContentTable

​Helpers

​getStructuredContentBlockTags

​getStructuredContentInlineTags

​getStructuredContentTablesById

​getStructuredContentTags

​getStructuredContentTagsById

​Types

​StructuredContentInlineInsert

​StructuredContentBlockInsert

​StructuredContentUpdate

​StructuredContentTableAppendRowsOptions

​Source Code

Use Case

Quick Start

Options

Attributes

Commands

`insertStructuredContentInline`

`insertStructuredContentBlock`

`updateStructuredContentById`

`deleteStructuredContent`

`deleteStructuredContentById`

`deleteStructuredContentAtSelection`

`appendRowsToStructuredContentTable`

Helpers

`getStructuredContentBlockTags`

`getStructuredContentInlineTags`

`getStructuredContentTablesById`

`getStructuredContentTags`

`getStructuredContentTagsById`

Types

`StructuredContentInlineInsert`

`StructuredContentBlockInsert`

`StructuredContentUpdate`

`StructuredContentTableAppendRowsOptions`

Source Code