Text value

Learn how to define textual content.

This content type defines static or dynamic text values such as titles, colors, and URLs for text schemas.

Examples

Here are some examples of static and dynamic content:

1234567
{
  "type": "text",
  "value": {
    "type": "static",
    "value": "Hello, world!"
  }
}

These are the properties common to static and dynamic values:

The following properties are available for static values:

type string: The type of the value. Always static for static values.
value string: The value itself.
Good to know
You can use placeholders to insert values from other attributes into the text.

The following properties are available for dynamic values:

type string: The type of the value. Always dynamic for dynamic values.
expression string: The CQL expression that evaluates to the value.
nullable boolean: Whether the value can be null.
This value must match the optional property of the associated attribute. In other words, if the attribute is optional, then the value is nullable.
Default:false
default(optional) string|null: The default value to use when the evaluation fails, results in null, or produces an incompatible type.