Skip to content
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions concepts/05 UI Components/TagBox/03 Overview/00 Overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
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.

This overview highlights TagBox elements, key features, and what to explore next.
11 changes: 11 additions & 0 deletions concepts/05 UI Components/TagBox/03 Overview/05 Elements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<img src="/images/TagBox/tagbox-elements.png" alt="TagBox elements"/>

1. [Label](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#label)
2. [Selected Items](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#selectedItems)
3. [Clear Button](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#showClearButton) (optional)
4. [Selection Controls](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#showSelectionControls)
5. [Items](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/items/)
6. [Placeholder](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#placeholder)
7. [Dropdown Button](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#showDropDownButton) (optional)
8. [Group Caption](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#groupTemplate)
9. [Grouped Items](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#grouped)
29 changes: 29 additions & 0 deletions concepts/05 UI Components/TagBox/03 Overview/10 Key Features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
- **Data Binding**
TagBox supports loading and updating data from different [data source](/Documentation/ApiReference/Data_Layer/DataSource/) types.

- **Tag Creation**
TagBox supports [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.

- **Selection Options**
TagBox supports configurable selection functionality. 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).

- **Searching and Filtering**
The TagBox component supports [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.

- **Grouping**
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).

- **Paging**
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.

- **Form Support**
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"*.

- **Accessibility and RTL**
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.

- **Customization Settings**
You can customize TagBox visual elements as your needs dictate, including the component [label](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#label) and [styling mode](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/#stylingMode). TagBox also supports 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).

- **Customization with Templates**
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).
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
- [Getting Started with TagBox](/Documentation/Guide/UI_Components/TagBox/Getting_Started_with_TagBox/)

- [API](/Documentation/ApiReference/UI_Components/dxTagBox/Configuration/)

- [Demos](https://js.devexpress.com/Demos/WidgetsGallery/Demo/TagBox/Overview/)
Binary file added images/TagBox/tagbox-elements.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading