Text

Displays a text.

Its size is automatically adjusted to fit the text, if not specified.

The Scrollable attribute allows the text to be scrolled if it doesn't fit in the object's size.

Text tutorial

Attributes

Common

ID

Sets the object's ID.

The ID identifies the object and is used to reference it in UISet actions, allowing to change its attributes dynamically.

The ID is not unique, it can be shared among multiple objects to quickly change a common attribute.

IDs can't be changed with a UISet action, but they can have a Value Binding assigned to them. Value Bindings on IDs allow an object to be dinamically attached to a set of attribute values.

E.g. the following Value Binding switches the ID of the object between mybutton1 and mybutton2 based on the value of the UISet button.address:

Value binding: ="mybutton" + ui('button', 'address')

UISet: UISet('button', 'address', '1') switches the ID to mybutton1 UISet('button', 'address', '2') switches the ID to mybutton2

Position and Size

Position

Sets the object's position.

The default value is: x0y0.

Attribute Values

Value	Description	Example
x<left>y<top>	Specify left/top coordinates in pixels.	x10y20

Flex Grow

Specifies if the objects should grow to fill the available space.

The default value is: true.

Attribute Values

Value	Description
true	Default value. Objects expand to fill the available space.
false	Objects do not grow to fill the available space.

Flex Shrink

Specifies if the objects should shrink to fit the available space.

The default value is: true.

Attribute Values

Value	Description
true	Default value. Objects shrink to fit the available space.
false	Objects do not shrink to fit the available space.

Width

Sets the object's width in pixels.

Minimum value is 1.

The default value is: auto.

Height

Sets the object's height in pixels.

Minimum value is 1.

The default value is: auto.

Text

Text

Specifies the text.

Scrollable

Controls the appearance of scrolling bars.

The default value is: false.

Attribute Values

Value	Description
false	Default value. No scrolling.
auto	Shows scrolling bars if content doesn't fit.
vertical	Shows the vertical scrolling bar.
horizontal	Shows the horizontal scrolling bar.
autovertical	Shows the vertical scrolling bar if the content doesn't fit.
autohorizontal	Shows the horizontal scrolling bar if the content doesn't fit.

Overflow

Specifies the text's overflow behavior.

The default value is: auto.

Attribute Values

Value	Description
auto	Default value. The text breaks automatically if a size is specified.
break-word	The text breaks automatically on whole words.
break-all	The text breaks automatically on any character.
ellipsis	The text won't break and will be truncated with an ellipsis.
no-wrap	The text won't automatically break.

Template

Defines an HTML template. The text parameter is split with pipe character (|) and each part is inserted in the template, replacing the %1;, %2;, $3;, etc. placeholders.

Attribute Values

Value	Description	Example
<string>	HTML template.	&lt;b&gt;%1;&lt;/b&gt; - %2;

Format

Specifies the text's format.

Selectable

Makes the text selectable.

The default value is: false.

Attribute Values

Value	Description
false	Default value. False.
true	True.

Auto Links

Detects urls, emails and phone numbers and displays them as hyperlinks. Phone numbers can be: E.164 format, [+]XXX XXX XXXX or [+]XXX-XXX-XXXX.

The default value is: false.

Attribute Values

Value	Description
false	Default value. Disabled.
true	Enabled.

Tooltip

A text displayed when hovering over the object, commonly used to display additional information.

Attribute Values

Value	Description	Example
<string>	Text to be displayed.	Set phasers to stun

CSS Style

note

This attribute has been deprecated since ver. 4.0

Layout

Text Align

Sets the horizontal alignment of the text.

The default value is: none.

Attribute Values

Value	Description
none	Default value. No alignment.
left	Left alignment.
right	Right alignment.
center	Center alignment.
justify	Justified alignment.

Vertical Align

Sets the vertical alignment of the text.

The default value is: top.

Attribute Values

Value	Description
top	Default value. Aligns the text to the top.
middle	Aligns the text to the middle.
bottom	Aligns the text to the bottom.

Padding

Specifies the text's padding.

Attribute Values

Value	Description	Example
<int>	Padding in pixels.	10
<integer list>	A list of integer values, separated by comma or space, that specify the sides' pixel padding in the following order: top, right, bottom, left.	10 20 10 20

Panel

Shows a panel that frames the object. Its style can be modified.

The default value is: false.

Attribute Values

Value	Description
true	Shows the panel.
false	Default value. Hides the panel.

Panel Color

Specifies the panel color.

The default value is: default.

Attribute Values

Value	Description
default	Default value. Default color.
primary	Primary color, used to highlight important areas.
warning	Warning color, used to highlight warning areas.
success	Success color, used to highlight success areas.
error	Error color, used to highlight error areas.
red,blue,yellow,green,yellow,purple,orange,green	Palette colors.
custom	Custom color, defined in the "Custom Color" attribute.

Panel Custom Color

Specifies the panel custom color.

Attribute Values

Value	Description	Example
<html color>	Color in any html accepted format.	#ff0000

Typography

Font Family

Specifies the font family.

The default value is: default.

Font Size

Specifies the font size in pixels or percentage (relative to the project's font size).

The default value is: 14.

Attribute Values

Value	Description	Example
<integer>	Font size in pixels.
<percentage>%	Relative font size in percentage.	90%

Font Color

Specifies the text CSS color.

Attribute Values

Value	Description	Example
<html color>	Color in any html accepted format.	#ff0000

Font Weight

Specifies the weight of the font.

The default value is: normal.

Attribute Values

Value	Description
normal	Default value. Normal.
bold	Bold.
bolder	Bolder.
lighter	Lighter.

Italic

Show the text in italics.

The default value is: false.

Attribute Values

Value	Description
false	Default value. Normal.
true	Italics.

Small Caps

Sets the font to small caps.

The default value is: false.

Attribute Values

Value	Description
false	Default value. Normal.
true	Small caps.

Decoration

Specifies the text decoration.

The default value is: none.

Attribute Values

Value	Description
none	Default value. No decoration.
underline	Underline.
overline	Overline.
line-through	Line through.

Line Height

Sets the line height of the text.

The default value is: 1.0.

Attribute Values

Value	Description
<float>	Specify the line height as a multiple of the font size.

Scrolling Animation

Scrolling Animation

Enables the scrolling animation.

The default value is: false.

Attribute Values

Value	Description
false	Default value. Disabled.
true	Enabled.

Scrolling Direction

Specifies the direction of the scrolling animation.

The default value is: left.

Attribute Values

Value	Description
left	Default value. Left.
right	Right.

Scrolling Speed

Specifies the speed of the scrolling animation.

Attribute Values

Value	Description
<string>	Speed in pixels per second.

Scrolling Paused

Pauses the scrolling animation.

The default value is: false.

Attribute Values

Value	Description
false	Default value. Playing.
true	Paused.

View

Visible

Sets the object's visibility.

The default value is: true.

Attribute Values

Value	Description
true	Default value. Visible.
false	Hidden.

Enabled

Specifies if the object is enabled or disabled. A disabled object appears as grayed out and can't be interacted with.

The default value is: true.

Attribute Values

Value	Description
true	Default value. Enabled.
false	Disabled.

Blink

Blinks the object at the specified speed.

The default value is: false.

Attribute Values

Value	Description
false	Default value. Not blinking.
slow	Blinks slowly.
fast	Blinks fast.

Transition

Specifies the transition effect when the object is shown or hidden.

The default value is: none.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Attribute Values

Value	Description
none	Default value. No transition.
fade	Fade in/out.
fade-left	Slide from left and fade in/out.
fade-right	Slide from right and fade in/out.
fade-up	Slide from top and fade in/out.
fade-down	Slide from bottom and fade in/out.
slide-left	Slide from left.
slide-right	Slide from right.
slide-up	Slide from top.
slide-down	Slide from bottom.
zoom-in	Zoom in.
zoom-out	Zoom out.
3d-flip-left	3D flip from left.
3d-flip-right	3D flip from right.

Transition Duration

Specifies the transition duration in milliseconds.

The default value is: 300.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Attribute Values

Value	Description
<integer>	Duration in milliseconds.

Transition Delay

Specifies the transition delay in milliseconds.

The default value is: 0.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Attribute Values

Value	Description
<integer>	Delay in milliseconds.

Opacity

Sets the object's opacity. Opacity is the degree to which content behind an object is hidden.

The default value is: 1.0.

Attribute Values

Value	Description
0	The object is fully transparent.
>0.0, <1.0	The object is translucent (content behind the element can be seen).
1.0	Default value. The object is fully opaque.

Rotation

Specifies the degrees by which the object is rotated. A positive number rotates it clockwise, while a negative value rotates it counter-clockwise.

The default value is: 0.

CSS Class

Specifies a CSS Class that applies to the object, useful to customize its appearance. Custom CSS Classes are specified within the custom.css file.

Margin

Specifies the margin of the object. The margin is the space outside the object's border.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Attribute Values

Value	Description	Example
<int>	Specify the margin in pixels for all sides of the object.
<top> <right> <bottom> <left>	Specify the margin in pixels for each side of the object.	10 20 30 40

View Scale

Specifies the scale of the object. The scale is the ratio between the object's size and the size of the view it is contained in.

The default value is: 1.0.

note

This attribute is experimental. It might not work properly and it might be modified or removed in a future release.

Attribute Values

Value	Description
<float>	Specify the scale for both width and height of the object.

Meta

Comment

Specifies a comment, visible only in the Project Editor. It can be used to add a note or a tag to the object. The filter in the object's SELECT panel applies to the comment as well.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Exclude

Excludes the object from the UI. Useful to temporarily hide an object without deleting it. Different from the "Visible" attribute, which hides the object in the UI but keeps it in the project, allowing it to be shown again with a UISet.

The default value is: false.

note

This attribute is static. Its value can't be changed dynamically with a uiSet command or with a value binding.

Attribute Values

Value	Description
false	Default value. Object is included in the UI.
true	Object is excluded from the UI.