Skip to content

Commit 88b02ac

Browse files
TagBox: Add Overview (#7520) (#7989)
1 parent 1067c88 commit 88b02ac

File tree

5 files changed

+48
-0
lines changed

5 files changed

+48
-0
lines changed
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
TagBox is a UI component that allows users to select values from a list. The component displays selected items in its input area as tags. TagBox supports multiple item selection and can allow users to add new values.
2+
3+
This overview highlights TagBox elements, key features, and what to explore next.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<img src="/images/TagBox/tagbox-elements.png" alt="TagBox elements"/>
2+
3+
1. [Label](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#label)
4+
2. [Selected Items](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#selectedItems)
5+
3. [Clear Button](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#showClearButton) (optional)
6+
4. [Selection Controls](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#showSelectionControls)
7+
5. [Items](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/items/)
8+
6. [Placeholder](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#placeholder)
9+
7. [Dropdown Button](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#showDropDownButton) (optional)
10+
8. [Group Caption](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#groupTemplate)
11+
9. [Grouped Items](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#grouped)
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
- **Data Binding**
2+
TagBox supports loading and updating data from different [data source](/Documentation/ApiReference/Data_Layer/DataSource/) types.
3+
4+
- **Tag Creation**
5+
TagBox can accept [custom values](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#acceptCustomValue). You can configure TagBox to update its data source on [custom item creation](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#onCustomItemCreating) or save changes temporarily.
6+
7+
- **Selection Options**
8+
You can enable and configure selection functionality for the DevExtreme TagBox. You can specify the [maximum number of tags](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#maxDisplayedTags) the component displays and [enable selection checkboxes](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#showSelectionControls) (including a "Select All" checkbox).
9+
10+
- **Searching and Filtering**
11+
The TagBox component includes [configurable search functionality](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#searchEnabled). You can specify a [search mode](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#searchMode), change the component [search delay](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#searchTimeout), and configure which [item fields to search](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#searchExpr). TagBox also supports minimum and maximum search query definitions.
12+
13+
- **Grouping**
14+
You can group items within the TagBox dropdown list. To enable grouping, set [grouped](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#grouped) to `true` and specify **DataSource**.[group](/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#group) in the component [dataSource](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#dataSource).
15+
16+
- **Paging**
17+
DevExtreme TagBox supports paging within the component dropdown list. You can implement this feature to load large data sets in chunks. To enable paging, specify a [DataSource](/Documentation/ApiReference/Data_Layer/DataSource/) instance as the TagBox **dataSource** and configure the [paginate](/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#paginate) and [pageSize](/Documentation/ApiReference/Data_Layer/DataSource/Configuration/#pageSize) properties.
18+
19+
- **Form Support**
20+
TagBox is a supported editor type in the DevExtreme [Form](/Documentation/Guide/UI_Components/Form/Overview/) component. To integrate TagBox within a Form, set a Form item's [editorType](/Documentation/ApiReference/UI_Components/dxForm/Item_Types/SimpleItem/#editorType) property to *"dxTagBox"*.
21+
22+
- **Accessibility and RTL**
23+
TagBox [conforms](/Documentation/Guide/UI_Components/TagBox/Accessibility/) to WCAG 2.x, European Accessibility Act (EAA), and Americans with Disabilities Act (ADA) standards. The component supports keyboard navigation and custom key handlers. TagBox also ships with right-to-left (RTL) representation support.
24+
25+
- **Customization Settings**
26+
You can customize TagBox visual elements, including the component [label](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#label) and [styling mode](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#stylingMode). TagBox also allows you to add input area [buttons](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/buttons/) and includes two predefined options: a [clear button](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#showClearButton) and a [dropdown button](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#showDropDownButton).
27+
28+
- **Customization with Templates**
29+
DevExtreme TagBox supports extended visual element customization with templates. You can specify custom HTML markup for the following component elements: <a href="/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#tagTemplate">tags</a>, [dropdown items](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#itemTemplate), the TagBox [input field](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#fieldTemplate), and [dropdown group headers](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#groupTemplate).
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
- [Getting Started with TagBox](/Documentation/Guide/UI_Components/TagBox/Getting_Started_with_TagBox/)
2+
3+
- [API](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/)
4+
5+
- [Demos](https://js.devexpress.com/Demos/WidgetsGallery/Demo/TagBox/Overview/)

images/TagBox/tagbox-elements.png

93 KB
Loading

0 commit comments

Comments
 (0)