Tree Select

It is a hierarchical dropdown list, that organizes the data into parent-child format and presents it in a tree-branch view. This is the same as the Tree widget, with extra features added to it.

Basic

Tree Data

The JSON-formatted data that is served as the content of the widget. The format must depict the parent-child link among the values, allowing the widget to display in a tree format. The properties of the JSON content as below.

Property
Description

label

Label for the node

value

Value for the node which must be unique for the entire content

children

Array of children nodes

disabled

Make the node read-only

selectable

Specify if the node can be selectable

checkable

Specify if the node can be checked, if the type is checkbox

disableCheckbox

Make the node disable, when the type is checkbox

[
  {
    "label": "Asia",
    "value": "asia",
    "children": [
      {
        "label": "China",
        "value": "china",
        "children": [
          {
            "label": "Beijing",
            "value": "beijing"
          },
          {
            "label": "Shanghai",
            "value": "shanghai"
          }
        ]
      },
      {
        "label": "Japan",
        "value": "japan"
      }
    ]
  },
  {
    "label": "Europe",
    "value": "europe",
    "disabled": true,
    "children": [
      {
        "label": "England",
        "value": "england"
      },
      {
        "label": "France",
        "value": "france",
        "checkable": false
      },
      {
        "label": "Germany",
        "value": "germany",
        "disableCheckbox": true
      }
    ]
  },
  {
    "label": "North America",
    "value": "northAmerica"
  }
]

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.

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.

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.

Interaction

Event Handlers

Event
Description

Change

The "Change" event is activated when the value of the widget is changed. When this event triggers, the associated action gets executed.

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.

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.

Set the visibility

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.

Read-only

Select Type

Property
Description

Single Select

Allows the user to select only one option at a time

Multi Select

The users can pick more than one options from the list

Checkbox

Shows a checkbox as a prefix to each item on the list for the users to select using the checkbox

Default Values

Provide the JSON array of parent-child nodes which the user wants to display the nodes as the selected node by default.

Show Clear Button

Displays a small 'x' type button at the end of the widget, which helps the user to clear out the previous entries and selections.

Searchable

Enables the search feature for users to type and search. It filters down the results and shows the matching options.

Layout

Prefix Icon

Choose one from the set of icons that will be displayed as a prefix logo, just before the content.

Suffix Icon

Choose one from the set of icons that will be displayed as a suffix logo, just after the content.

Expanded Values

Provide the JSON array of parent-child nodes which the user wants to display the nodes as the expanded list by default.

Default Expand All Nodes

Toggle this to make all the nodes on the list to be displayed as the expanded list of tree.

Show Line

This creates a line-link among the nodes, showing the parent-child relation explicitly.

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.

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

Property
Description

Left

Shows the label on the left side of the widget entry

Top

Shows the label on top of the widget entry

Alignment

Property
Description

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.

Style

Property
Description

Label

Set the colour of the label text. Recommended to set in contrast with the background.

Text

Set the colour of the options' 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.

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.

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.

Tags

Set the colour for the chosen options and displayed as the selected items.

Tags Text

The colour for the 'x' mark on the chosen options.

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.

Prefix Icon Color

Choose a specific color for the icon that appears before the actual widget content.

Suffix Icon Color

Choose a specific color for the icon that appears after the actual widget content.

Prefix Icon Size

Set the size of the prefix icon in px value - 12px

Suffix Icon Size

Set the size of the suffix icon in px value - 12px

Last updated