You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/marketplace/platform-supported-content/widgets/combobox.md
+25-21Lines changed: 25 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,7 +67,7 @@ When Context source is selected, the **Data source** section (required) configur
67
67
68
68
The database source type can be used to set the value of a string or integer attribute with options fetched from an attribute with the same type.
69
69
70
-
***Selection type**– (available in 2.0 and above) determines how other [listen to widget](/refguide/listen-to-grid-source/) data sources perceive the data. This property can only be used with widgets using a [database data source](/refguide/database-source/).
70
+
***Selection type** (available in 2.0 and above) – Determines how other [listen to widget](/refguide/listen-to-grid-source/) data sources perceive the data. This property can only be used with widgets using a [database data source](/refguide/database-source/).
71
71
***Single** – Allows only a single item to be selected from the options list.
72
72
***Multi** – Allows multiple items to be selected from the options list.
73
73
***Caption** – Allows custom captions to be displayed on the options list.
@@ -81,26 +81,28 @@ The static source type can be used to set the value of a string attribute with m
81
81
82
82
The **General** section allows you to configure general behavior and captions for the combo box. The following configurations are available:
83
83
84
-
***Placeholder text** – captions that will be displayed when there is no data being selected
85
-
***No options text** – captions that will be used when filter results are empty, or shown when there is no data displayed in the combo box's options
86
-
***Clearable** – if enabled, this allows selected data to be cleared all at once
87
-
***Custom content** – allows custom widgets to be displayed in the combo box instead of normal text values
88
-
***Show footer** – if enabled, this allows custom widgets to be placed in a combo box's footer (as shown below). For example, you can include a link, button, or image in the footer. A popular choice is including a "new item" button in the footer:
84
+
***Placeholder text** – Captions that will be displayed when there is no data being selected
85
+
***No options text** – Captions that will be used when filter results are empty, or shown when there is no data displayed in the combo box's options
86
+
***Clearable** – If enabled, this allows selected data to be cleared all at once
87
+
***Custom content** – Allows custom widgets to be displayed in the combo box instead of normal text values
88
+
***Show footer** – If enabled, this allows custom widgets to be placed in a combo box's footer (as shown below). For example, you can include a link, button, or image in the footer. A popular choice is including a "new item" button in the footer:
89
+
89
90
{{< figure src="/attachments/appstore/platform-supported-content/widgets/combobox/show-footer.png" alt="Shows a footer which can house custom widgets." class="no-border" >}}
90
91
91
92
#### Multi Selection (Reference Set)
92
93
93
94
The **Multi selection (reference set)** section allows you to configure combo box behavior for reference set type datasource. The following configurations are available:
94
95
95
-
***Selection Method** – configures the behavior for selecting options
96
-
***Checkbox** – displays a checkbox on the left side of each option. Selected items will be marked by check marks.
97
-
***Row click** – each selected item will be filtered out from the displayed options. Items can deselected by clicking the {{% icon name="remove" %}} on each of the displayed selected items.
98
-
***Show selected item as** – you can choose to display selected item as labels with {{% icon name="remove" %}} buttons which allow those items to be deselected (shown at the top of this screenshot), or as simple comma-separated text (shown at the bottom):
96
+
***Selection Method** – Configures the behavior for selecting options.
97
+
***Checkbox** – Displays a checkbox on the left side of each option. Selected items will be marked by check marks.
98
+
***Row click** – Each selected item will be filtered out from the displayed options. Items can deselected by clicking the {{% icon name="remove" %}} on each of the displayed selected items.
99
+
***Show selected item as** – Allows you to display selected items as labels with {{% icon name="remove" %}} buttons which allow those items to be deselected (shown at the top of this screenshot), or display selected items as simple comma-separated text (shown at the bottom):
99
100
100
101
{{< figure src="/attachments/appstore/platform-supported-content/widgets/combobox/combobox-showselected.png" alt="Show selected item as list or labels examples" class="no-border" >}}
102
+
101
103
{{% alert color="info" %}}The **Show selected item as** property is only available for the **Checkbox** selection method without custom content.{{% /alert %}}
102
104
103
-
***Show Select All** – you can choose to enable a "Show select all" button that will be displayed on the top of the options list. It allows the end-user to click it and select or deselect all options at once:
105
+
***Show Select All** – Allows you can choose to enable a "Show select all" button that will be displayed on the top of the options list. It allows the end-user to click it and select or deselect all options at once:
@@ -120,9 +122,10 @@ For more information, see [Editability Section](/refguide/common-widget-properti
120
122
121
123
The following configurations are available:
122
124
123
-
***On change** – executes an action when the attribute value changes
124
-
***On enter action** – executes an action when the user sets focus on the widget
125
-
***On leave action** – executes an action when the user moves focus away from the widget
125
+
***On change** – Executes an action when the attribute value changes.
126
+
***On enter action** – Executes an action when the user sets focus on the widget.
127
+
***On leave action** – Executes an action when the user moves focus away from the widget.
128
+
***On filter input change** – Executes an action when the filter input value changes.
126
129
127
130
### Accessibility Tab {#accessibility}
128
131
@@ -134,8 +137,8 @@ The **Advanced** tab allows you to configure settings for features that is beyon
134
137
135
138
***Performance group**
136
139
137
-
***Lazy loading** – allows the user to configure when to load the combo box's options data. Set it to **yes** to ensure that the data is not loaded until the user opens the options menu.
138
-
***Loading type** – allows the user to configure the loading animation of a combo box.
140
+
***Lazy loading** – Allows the user to configure when to load the combo box's options data. Set it to **yes** to ensure that the data is not loaded until the user opens the options menu.
141
+
***Loading type** – Allows the user to configure the loading animation of a combo box.
139
142
140
143
{{% alert color="info" %}}
141
144
Lazy loading always fetches 100 data items for each request. Pagination is triggered when the user scrolls to the bottom of the options menu.
@@ -152,13 +155,14 @@ Using a **caption type** expression disables lazy load due to a technical limita
152
155
***Multiple selection**
153
156
This setting is only applicable for combo boxes with multiple item selections.
154
157
155
-
***Selected items sorting** – allows user to configure the sorting mechanism to display the selected items.
156
-
* **Caption** - if selected, this settings displays selected items based on their captions, regardless of user's selected sequence.
157
-
* **Default** - if selected, this settings does not do any sorting on the client side. Instead, it keeps the sorting from the saved values given from datasource.
158
-
If the target attribute value is set (that is, if the multiple selection is set to **association**) the data will already sorted based on values from the API and combobox will display it as it is. Otherwise, if there is no target attribute (that is, if the multiple selection is set to **database**) the selected items are displayed based on user's selected sequence.
158
+
***Selected items sorting** – Allows user to configure the sorting mechanism to display the selected items.
159
+
* **Caption** - If selected, this settings displays selected items based on their captions, regardless of user's selected sequence.
160
+
* **Default** - If selected, this settings does not do any sorting on the client side. Instead, it keeps the sorting from the saved values given from data source.
161
+
If the target attribute value is set (that is, if the multiple selection is set to **association**) the data will already sorted based on values from the API and combo box will display it as it is. Otherwise, if there is no target attribute (that is, if the multiple selection is set to **database**) the selected items are displayed based on user's selected sequence.
159
162
160
163
***Filter**
161
-
***Filter type** – allows the user to type into the input and filter displayable options on the combo box.
164
+
***Filter type** – Allows the user to type into the input and filter displayable options on the combo box.
165
+
***Debounce interval** – The debounce interval (default 200 ms) delays applying filters while the user types to reduce server requests and unnecessary filtering. It debounces both data source filter operations (lazy-loading database queries), and **On filter input change** event action triggers.
0 commit comments