DocsObject referenceView source

Text Variable

Text content. Plain string or rich TextRun[]. Insert it inline as '{{<id>}}' inside any string (rich text is flattened to plain text there), or reference it whole as 'var:<id>' in a field that accepts string o…

Metadata

Definition: #/$defs/TextVariable
Type: object
Source: spec/schemas/opf.schema.json

Field index

Field	Type	Req.	Description
type	const	yes	Variable kind. One of color, text, number, date, image, url or list.
value	string \| array<ref:TextRun>	—	Text this variable resolves to: a plain string, or TextRun[] for rich text.
required	boolean	—	Whether the variable must be filled. Defaults to true: a variable with no 'value' is unfilled, and an unfilled required variable is an error in a normal deck and expected in a template. Set false for an optional slot: an unfilled optional variable resolves to empty text (inline…
label	string	—	Optional short human label for forms and fill panels.
description	string	—	Optional prose describing what the variable is for, surfaced by pickers, fill forms and agents.
example	string \| array<ref:TextRun>	—	Illustrative text shown in fill forms and used when a template is previewed with examples. Never written to output.

`type`

typeconstrequiredyesdefault—

Variable kind. One of color, text, number, date, image, url or list.

type.json

{
  "type": "text"
}

`value`

typestring | array<ref:TextRun>requirednodefault—

Text this variable resolves to: a plain string, or TextRun[] for rich text.

value.json

{
  "value": "value-value"
}

`required`

typebooleanrequirednodefaulttrue

Whether the variable must be filled. Defaults to true: a variable with no 'value' is unfilled, and an unfilled required variable is an error in a normal deck and expected in a template. Set false for an optional slot: an unfilled optional variable resolves to empty text (inline…

required.json

{
  "required": true
}

`label`

typestringrequirednodefault—

Optional short human label for forms and fill panels.

label.json

{
  "label": "label-value"
}

`description`

typestringrequirednodefault—

Optional prose describing what the variable is for, surfaced by pickers, fill forms and agents.

description.json

{
  "description": "description-value"
}

`example`

typestring | array<ref:TextRun>requirednodefault—

Illustrative text shown in fill forms and used when a template is previewed with examples. Never written to output.

example.json

{
  "example": "example-value"
}