TextComponent
Extends
Section titled “Extends”Properties
Section titled “Properties”| Property | Type | Description | Overrides | Inherited from |
|---|---|---|---|---|
allowHtml? |
boolean |
Interpret a safe subset of HTML formatting tags in the text (after interpolation): , , , , , . Other tags are removed; markup is never inserted as HTML. Defaults to false. |
- | - |
canGrow? |
boolean |
Grow height to fit the content. | - | - |
conditions? |
ConditionalStyle[] |
- | - | ComponentBase.conditions |
format? |
ValueFormat |
Format applied to every interpolated value. | - | - |
growToHeight? |
boolean |
Stretch the component down to the bottom of its band once the band height is known, e.g. so bordered table cells line up when a neighbour grows. | - | ComponentBase.growToHeight |
height |
number |
- | - | ComponentBase.height |
id |
string |
Unique within the template. | - | ComponentBase.id |
name? |
string |
Optional display name for the designer. | - | ComponentBase.name |
style? |
StyleProps |
Inline style, applied over the named style. | - | ComponentBase.style |
styleName? |
string |
Name of a style in template.styles. |
- | ComponentBase.styleName |
text |
string |
Text with {{ expression }} placeholders. |
- | - |
type |
"text" |
- | ComponentBase.type |
- |
visible? |
string |
JavaScript expression; the component is hidden when it evaluates falsy. | - | ComponentBase.visible |
width |
number |
- | - | ComponentBase.width |
wordWrap? |
boolean |
Wrap long lines. Defaults to true. | - | - |
x |
number |
Position relative to the band’s top-left corner, in template units. | - | ComponentBase.x |
y |
number |
- | - | ComponentBase.y |