Text
Element type: Dictionary
This component allows you to display a text to the end user.
Keys
| Name | Type | Possible values | Required |
|---|---|---|---|
| Type | String | Text | Required |
| Text | String | - | Required |
| TextFontConfiguration | Dictionary (Font) | - | |
| Margins | Dictionary (Margins) | - | |
| Border | Dictionary (Border) | - | |
| Condition PRO | Dictionary (Condition) | - |
Detail
Type Required
Type: String
Explanation: The type of the component which has to be Text
Text Required
Type:String
Explanation: The text which will be displayed as content.
Since Octory 3.1.0, the text is rendered as Markdown. The following is supported:
- headings, with one to six leading
#characters **bold**and_italic_`code`- bulleted and numbered lists
- links, written
[label](https://example.com)
The styles come from the component's TextFontConfiguration: a heading is drawn larger and heavier than the body text, relative to the font you configured, so a text component keeps following your font styles.
Plain text without any Markdown syntax is displayed exactly as before, so existing configurations are unaffected. To show a character that Markdown would interpret, escape it with a backslash, for example \*.
TextFontConfiguration
Type: Dictionary (Font)
Explanation: Allow to customize the font to use for the text.
Margins
Type: Dictionary (Margins)
Explanation: Add padding to the component's sides.
Border
Type: Dictionary (Border)
Explanation: Add a top or bottom border to a component.
Condition PRO
Type: Dictionary (Condition)
Explanation: Allows to hide or show the component using a boolean expression.
Example
The following displays an innovative stub text.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<!-- ... -->
<key>Slides</key>
<array>
<dict>
<key>Containers</key>
<array>
<dict>
<key>Components</key>
<array>
<dict>
<key>Type</key>
<string>Text</string>
<key>Text</key>
<string>Lorem ipsum dolor sit amet...</string>
</dict>
</array>
</dict>
</array>
</dict>
</array>
<!-- ... -->
</dict>
</plist>