Mention
Technically, a text box that lets users have @-mentions and tags like the social media comment box.
Basic
Default Value
Enter the default string to be displayed when the widget is loaded. This can also be retrieved from the backend using query or loaded using low-code.
Placeholder
Specifies a hint that describes the expected value. The placeholder shows the hint text in the widget when nothing is selected or entered. This text disappears as soon as a value is entered in the control.
Mention List Data
Enter the JSON data that contains the users to be displayed as a list when the key '@' is pressed to tag someone. This data contains the list of hashtags shown when the user presses the '#' key.
{
"@": [
"Li Lei",
"Han Meimei"
],
"#": [
"friends",
"family",
"lifestyle",
"happybirthday",
"enjoyed",
"poor",
"fun"
]
}
Label
Represents the caption for the widget in the user interface. It is recommended to keep the label string short and convey the usage of the widget in the UI
Position
Left
Shows the label on the left side of the tree view
Top
Shows the label on top of the tree view
Alignment
Left
Align the text on the left corner of the label area
Right
Align the text on the right corner of the label area near the tree view
Width
Enter a number value to set the width of the widget. It can be set in terms of pixels and percentage.
Interaction
Event Handlers
Focus
This event is triggered when the widget receives focus, meaning it becomes the active element that can accept user input.
Blur
This event occurs when the user shifts the focus out of the widget. This can happen in different scenarios, such as when a user clicks outside an input widget they were typing in or when the user tabs to another field.
Change
The "Change" event is activated when the value of the widget is changed. When this event triggers, the associated action gets executed.
Mention
This event will be triggered when a user is mentioned in the comment.
Submit
This event will be triggered when the user submits the comment.
Disabled
Disables the user interaction with the element on the page. It visually indicates that the element is inactive and prevents users from interacting with it when applied. Shows a red-crossed warning symbol and can be customized to disable the widget according to certain conditions using low-code.
Layout
Hide
This sets whether the widget has to be displayed on the screen when the program is loaded. This shows/hides the widget both on desktop and mobile devices.
Widget Tooltip
This tooltip pops up when the user moves the mouse over the input area of the widget. It is commonly used to hint at the type of input the user needs to provide.
The tooltip will be immediately shown when the user's mouse hovers over the widget, and immediately hides when the user's mouse leaves. This information will be contextual, useful, and informative.
Advanced
Read Only
Makes the entire widget disabled, and denies users any action over the element. It is grayed out for users' view to show it is read-only.
Show Clear Button
Toggle this ON to enable the clear button the right which provides users the ability to clear out the text at once.
Validation
Required Field
Refers to the field that must be completed by the user, which means the field must be entered with a valid value before submitting the information.
Text Type
Text
Denotes the normal string of characters
Denotes the string must be in the 'email address' format
URL
Denotes the string must be in the web address format
Regex
Denotes the regular expression string and the value entered by the user must satisfy the regex format. For example - consider this regex:
^[A-Za-z][A-Za-z0-9_]{7,29}$
This validates: (1) If the entered value starts with alphabets and not numbers (2) If the length of the string is more than 8 characters and less than 30 characters
Minimum Length
Enter the value for a minimum number of characters to be allowed, for example - 20. This means that the widget must have a minimum length of 20 characters to be entered by the user. The program will automatically validate the user input against the specified constraint. If the user input does not meet this constraint, it will show an error and the user will need to enter a valid value.
Maximum Length
Enter the value for a maximum number of characters in the field, for example - 250. This means that the widget must not exceed the maximum length of 250 characters. The program will automatically validate the user input against the specified constraint. If the user input exceeds the limit, it stops the keyboard entry into the widget.
Custom Rule
Apart from validating the entry using the regex rule, users can also use this property to write low-code and check other aspects. For example - check if the city selected in the previous field matches the desired value, throw a custom message to the user even before capturing the entry on this field.
Style
Label
Set the colour for the label text. Recommended to set in contrast with the background.
Box Shadow
The is the colour of the shadow that is generated behind the widget box. The X and Y axis values can be altered such that the shadow can be set to fall anywhere behind the widget area. "x-offset" - a positive number specifies the shadow will be on the right of the box, and a negative number will put the shadow on the left of the box. "y-offset" - a negative one means the shadow will be above the box, and a positive number means the shadow will be below the box. "Blur" - if the number is set to 0 then the shadow will be sharp. It will more blurred as the number goes higher, and the shadow will extend further away. "Color" - sets the colour of the shadow. If the colour is not set, the box shadows are drawn in the foreground colour.
Background
Users can change the colour of the text background using this property. It has all the RGB colour ranges to pick from. It is recommended to use a corresponding background colour that shows the font clearly.
Tooltip Style
There are 3 types of styles that can be applied: "normal" - The text is shown normally, no style applied. "italic" - The text is cursive. "oblique" - A sloped version of the normal text.
Tooltip Size
Set the size of the text in px value - 12px
Tooltip Width
Set the tooltip text width.
Tooltip Font Family
Type the name of the font family. The reference to the list of font families can be found here: MDN web docs
Label Font Style
There are 3 types of styles that can be applied: "normal" - The text is shown normally, no style applied. "italic" - The text is cursive. "oblique" - A sloped version of the normal text.
Label Text Size
Set the size of the text in px value - 12p
Label Font Family
Type the name of the font family. The reference to the list of font families can be found here: MDN web docs
Text
Set the colour of the text. Recommended to set in contrast with the background.
Text Transform
This property specifies how to capitalize an element's text. It can be used to make text appear in all-uppercase or all-lowercase, or with each word capitalized. MDN web docs
Text Decoration
This property sets the appearance of decorative lines on text. Types are "underline", "overline", "line-though", "overline-underline".
Text Size
Set the size of the text in px value - 12px
Text Weight
Increase or decrease the thickness of the font using the list of numbers from 100-800.
Font Family
Type the name of the font family. The reference to the list of font families can be found here: MDN web docs
Font Style
There are 3 types of styles that can be applied: "normal" - The text is shown normally, no style applied. "italic" - The text is cursive. "oblique" - A sloped version of the normal text.
Border Color
Set the colour to the border lines. The border lines will be shown only if that is enabled.
Margin
This value is set in terms of "px" number which creates the space between the border and the content of the widget.
Padding
This value is set in terms of "px" number which creates the space between the border and outer elements.
Border Radius
This sets the radius of the widget's corners, enabling rounded corners on the widget. This value is defined in "px" terms.
Border Width
Set the thickness of the border of the widget using this value. It is defined using "px" terms.
Accent
An accent is a typically bright colour that contrasts with the more utilitarian background and foreground colours within a colour scheme. These are present in the visual style of many platforms (though not all).
On the web, an accent is sometimes used in input elements for the active portion of the control, for instance, the background of a checked checkbox. MSDN web docs
Validation Message
Set the colour of the validation text message. Recommended to set in contrast with the background, usually Red.
Last updated