Skip to main content

Tree-select

A tree-select widget captures user inputs from a specified list of permitted options in which each option can then have child options associated with it.

How to use Tree-select Widget

Displaying Data

Tree-select options can be populated from a data source like an API / Query by transforming the incoming data to an array of \(label, value\). The transformation can be performed using javascript. So if the data is an array, we can transform it using the Array.map function.

// Query1.data is assumed to be an array here
{{ Query1.data.map((row) => {
return { label: row.name, value: row.id, children: {label: row.child.label, value: row.child.value}}
})
}}

Filtering Data

A Tree-select widget can filter a dataset based on the user's input. The selected value can be passed to an API using{{ TreeSelect1.selectedOptionValue }} .

Form Submission

Tree-select widgets can capture from a fixed set of options inside a form such as gender, role, status.

info

Some forms need to be pre-filled data from a table or API. We can bind the data to the default property to enable this

{{ Table1.selectedRow.gender }}
/**
* Binding this to the default option will update the selected option
* of the TreeSelect widget with the gender of the selected row in Table1
*/

Read more about submitting Input data to an API below.

Sending widget data in the post body

Properties

Properties allow you to edit the widget, connect it with other widgets and customize the user actions.

Widget Properties

These properties allow you to edit the widget. All these properties are present in the property pane of the widget. The following table lists all the widget properties.

PropertyDescription
OptionsIt lets you set labels and values for different items/options in the list of the tree select widget. Options must be specified as an array of objects with a label and value property. The tree structure can be added to any option by adding the children field that should be an object.
Default ValueSets a default option that will be captured as user input unless the user changes it.
PlaceholderSets the Placeholder of the multi-select widget.
RequiredWhen turned on, it makes a user input required and disables any form submission until the user makes an input.
VisibleControls widget's visibility on the page. When turned off, the widget will not be visible when the app is published
DisabledDisables input/selection to the widget. The widget will remain visible to the user but user input/selection will not be allowed.
Animate LoadingControl’s widget’s loading animation on the page. When turned off, the widget will load without any skeletal animation. This can be controlled with JS until all the widgets are rendered.
Clear all SelectionsWhen turned on, it allows users to clear the selection, which was the default or the selection made by them.
Expand all by defaultIt shows a dropdown in an expanded state when turned on, revealing all the children options.
HeightIt configures how a widget’s height reacts to content changes. It has three possible configurations:
Fixed: The height of the widget remains as set using drag and resize.
Auto Height: The height of the widget reacts to content changes.
Auto Height with limits: Same as Auto height, with a configurable option to set the minimum and maximum number of rows that can be occupied by the widget.

Binding Properties

These properties help you share values between widgets and also allow you to easily access the widget property within Queries or JS functions.

PropertyDescriptionCode Snippet
selectedOptionValueThis is the value of the option displayed in a Single Select dropdown. It changes if the default value of the dropdown changes or the user selects an option.{{TreeSelect.selectedOptionLabel}}
selectedOptionLabelThis is the Label of the option displayed in a Tree-Select dropdown. This label changes if the default value of the dropdown changes or the user changes an option selection.{{TreeSelect.selectedOptionLabel}}
isDisabledThis property indicates whether the widget is disabled or not.{{TreeSelect.isDisabled}}
isValidThis property indicates whether the widget is valid or not.{{TreeSelect.isValid}}
isVisibleThis property indicates whether the widget is visible or not.{{TreeSelect.isVisible}}

Events

They are a set of actions that you can perform on the widget. The following table lists the actions:

EventsDescription
onOptionChangeTriggers an action when a user selects an option. See a list of supported actions.

Label

The property hosts a group of configurations that you can use to associate a display name and define a placement for the widget. These properties are usually useful when you want to design forms that follow a defined alignment for your form fields and give a professional look to your forms. Below are the properties that you can use:

LabelDescription
TextSets the label of the widget.
PositionSets the label position of the widget.
AlignmentSets the label alignment of the widget.
WidthSets the label width of the widget as the number of columns.

Let's understand these properties in detail.

Text

It allows you to set the display name for the Tree-select. For example, if you want the user to select a category and its subcategories of fruits, you can enter the text as "Fruits."

tip

You can leave the text empty if you don't want any display name for your Tree-select widget.

Position

It allows you to specify the placement of the label. You can select one of the available options:

  • Top - It allows you to align the text at the top of the Tree-select.
  • Left - It aligns the text to the left of the Tree-select. When you select Left alignment, you get additional settings that you can use to control the alignment and define the text's width.
    • Alignment - With the help of alignment, you can define the placement of the text in accordance with the position of the Tree-select. You can choose:
      • Left - It aligns the text to the widget's left boundary that is away from the Tree-select.
      • Right - It aligns the text closer to the Tree-select.
    • Width - With the help of width, you can define the number of columns in the grid that surrounds the widget. You can specify how close or far the text can be placed to the Tree-select.
  • Auto - It automatically adjusts the position of the text based on the Tree-select's height.
info

Columns are the dashed lines (-----) that surround a widget when you try to drag and drop it on the canvas.

How to set the label properties?

Styles

Style properties allow you to change the look and feel of the widget.

StyleDescription
Border RadiusAllows you to define curved corners.
Box ShadowAllows you to choose from the available shadow styles.
Label Font StyleAllows you to choose a font style, i.e., bold or italic.
Label Text ColorAllows you to set text color for the label.
Label Text SizeAllows you to set the size of the label.