UI Widgets

dxAccordion

The Accordion widget contains several panels displayed one under another. These panels can be collapsed or expanded by an end user, which makes this widget very useful for presenting information in a limited amount of space.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Accordion from "devextreme/ui/accordion"
Type:

Object

dxActionSheet

The ActionSheet widget is a sheet containing a set of buttons located one under the other. These buttons usually represent several choices relating to a single task.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import ActionSheet from "devextreme/ui/action_sheet"
Type:

Object

dxAutocomplete

The Autocomplete widget is a textbox that provides suggestions while a user types into it.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Autocomplete from "devextreme/ui/autocomplete"
Type:

Object

dxBox

The Box widget allows you to arrange various elements within it. Separate and adaptive, the Box widget acts as a building block for the layout.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Box from "devextreme/ui/box"
Type:

Object

dxButton

The Button widget is a simple button that performs specified commands when a user clicks it.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Button from "devextreme/ui/button"
Type:

Object

dxButtonGroup

The ButtonGroup is a widget that contains a set of toggle buttons and can be used as a mode switcher.

import ButtonGroup from "devextreme/ui/button_group"
Type:

Object

dxCalendar

The Calendar is a widget that displays a calendar and allows an end user to select the required date within a specified date range.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Calendar from "devextreme/ui/calendar"
Type:

Object

dxCheckBox

The CheckBox is a small box, which when selected by the end user, shows that a particular feature has been enabled or a specific option has been chosen.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import CheckBox from "devextreme/ui/check_box"
Type:

Object

dxColorBox

The ColorBox is a widget that allows an end user to enter a color or pick it out from the drop-down editor.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import ColorBox from "devextreme/ui/color_box"
Type:

Object

dxContextMenu

The ContextMenu widget displays a single- or multi-level context menu. An end user invokes this menu by a right click or a long press.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import ContextMenu from "devextreme/ui/context_menu"
Type:

Object

dxDataGrid

The DataGrid is a widget that represents data from a local or remote source in the form of a grid. This widget offers such basic features as sorting, grouping, filtering, as well as more advanced capabilities, like state storing, export to Excel, master-detail interface, and many others.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import DataGrid from "devextreme/ui/data_grid"
Type:

Object

dxDateBox

The DateBox is a widget that displays date and time in a specified format, and enables a user to pick or type in the required date/time value.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import DateBox from "devextreme/ui/date_box"
Type:

Object

dxDeferRendering

The DeferRendering is a widget that waits for its content to be ready before rendering it. While the content is getting ready, the DeferRendering displays a loading indicator.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import DeferRendering from "devextreme/ui/defer_rendering"
Type:

Object

See Also

dxDiagram CTP

The Diagram widget provides a visual interface to help you design new and modify existing diagrams.

NOTE
DevExtreme Diagram is available as a community technology preview (CTP). Should you have any questions or suggestions prior to its official release, please email your comments to support@devexpress.com.
import Diagram from "devextreme/ui/diagram"
Type:

Object

dxDrawer

The Drawer is a dismissible or permanently visible panel used for navigation in responsive web application layouts.

import Drawer from "devextreme/ui/drawer"
Type:

Object

dxDropDownBox

The DropDownBox widget consists of a text field, which displays the current value, and a drop-down field, which can contain any UI element.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import DropDownBox from "devextreme/ui/drop_down_box"
Type:

Object

dxDropDownButton

The DropDownButton is a button that opens a drop-down menu.

import DropDownButton from "devextreme/ui/drop_down_button"
Type:

Object

dxFileManager CTP

The FileManager is a widget that allows users to upload, select, and manage files and directories in different file storages.

NOTE
DevExtreme FileManager is available as a community technology preview (CTP). Should you have any questions or suggestions prior to its official release, please email your comments to support@devexpress.com.
import FileManager from "devextreme/ui/file_manager"
Type:

Object

dxFileUploader

The FileUploader widget enables an end user to upload files to the server. An end user can select files in the file explorer or drag and drop files to the FileUploader area on the page.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import FileUploader from "devextreme/ui/file_uploader"
Type:

Object

dxFilterBuilder

The FilterBuilder widget allows a user to build complex filter expressions with an unlimited number of filter conditions, combined by logical operations using the UI.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import FilterBuilder from "devextreme/ui/filter_builder"
Type:

Object

dxForm

The Form widget represents fields of a data object as a collection of label-editor pairs. These pairs can be arranged in several groups, tabs and columns.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Form from "devextreme/ui/form"
Type:

Object

dxGallery

The Gallery is a widget that displays a collection of images in a carousel. The widget is supplied with various navigation controls that allow a user to switch between images.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Gallery from "devextreme/ui/gallery"
Type:

Object

dxHtmlEditor CTP

HtmlEditor is a WYSIWYG editor that allows you to format textual and visual content and to output it in HTML or Markdown. HtmlEditor is built on top of and requires Quill.

NOTE
DevExtreme HtmlEditor is available as a community technology preview (CTP). Should you have any questions or suggestions prior to its official release, please email your comments to support@devexpress.com.
import HtmlEditor from "devextreme/ui/html_editor"
Type:

Object

dxList

The List is a widget that represents a collection of items in a scrollable list.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import List from "devextreme/ui/list"
Type:

Object

dxLoadIndicator

The LoadIndicator is a UI element notifying the viewer that a process is in progress.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import LoadIndicator from "devextreme/ui/load_indicator"
Type:

Object

dxLoadPanel

The LoadPanel is an overlay widget notifying the viewer that loading is in progress.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import LoadPanel from "devextreme/ui/load_panel"
Type:

Object

dxLookup

The Lookup is a widget that allows an end user to search for an item in a collection shown in a drop-down menu.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Lookup from "devextreme/ui/lookup"
Type:

Object

dxMap

The Map is an interactive widget that displays a geographic map with markers and routes.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Map from "devextreme/ui/map"
Type:

Object

dxMenu

The Menu widget is a panel with clickable items. A click on an item opens a drop-down menu, which can contain several submenus.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Menu from "devextreme/ui/menu"
Type:

Object

dxMultiView

The MultiView is a widget that contains several views. An end user navigates through the views by swiping them in the horizontal direction.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import MultiView from "devextreme/ui/multi_view"
Type:

Object

dxNavBar

The NavBar is a widget that navigates the application views.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import NavBar from "devextreme/ui/nav_bar"
Type:

Object

dxNumberBox

The NumberBox is a widget that displays a numeric value and allows a user to modify it by typing in a value, and incrementing or decrementing it using the keyboard or mouse.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import NumberBox from "devextreme/ui/number_box"
Type:

Object

dxPivotGrid

The PivotGrid is a widget that allows you to display and analyze multi-dimensional data from a local storage or an OLAP cube.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import PivotGrid from "devextreme/ui/pivot_grid"
Type:

Object

dxPivotGridFieldChooser

A complementary widget for the PivotGrid that allows you to manage data displayed in the PivotGrid. The field chooser is already integrated in the PivotGrid and can be invoked using the context menu. If you need to continuously display the field chooser near the PivotGrid widget, use the PivotGridFieldChooser widget.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import PivotGridFieldChooser from "devextreme/ui/pivot_grid_field_chooser"
Type:

Object

Both the PivotGridFieldChooser and the PivotGrid must be bound to one and the same instance of the PivotGridDataSource. Create the PivotGridDataSource individually and then assign it to both widgets as shown in the code above.

View Demo

See Also

dxPopover

The Popover is a widget that shows notifications within a box with an arrow pointing to a specified UI element.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Popover from "devextreme/ui/popover"
Type:

Object

dxPopup

The Popup widget is a pop-up window overlaying the current view.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Popup from "devextreme/ui/popup"
Type:

Object

dxProgressBar

The ProgressBar is a widget that shows current progress.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import ProgressBar from "devextreme/ui/progress_bar"
Type:

Object

dxRadioGroup

The RadioGroup is a widget that contains a set of radio buttons and allows an end user to make a single selection from the set.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import RadioGroup from "devextreme/ui/radio_group"
Type:

Object

dxRangeSlider

The RangeSlider is a widget that allows an end user to choose a range of numeric values.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import RangeSlider from "devextreme/ui/range_slider"
Type:

Object

dxResizable

The Resizable widget enables its content to be resizable in the UI.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Resizable from "devextreme/ui/resizable"
Type:

Object

Read Guides

See Also

dxResponsiveBox

The ResponsiveBox widget allows you to create an application or a website with a layout adapted to different screen sizes.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import ResponsiveBox from "devextreme/ui/responsive_box"
Type:

Object

dxScheduler

The Scheduler is a widget that represents scheduled data and allows a user to manage and edit it.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Scheduler from "devextreme/ui/scheduler"
Type:

Object

dxScrollView

The ScrollView is a widget that enables a user to scroll its content.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import ScrollView from "devextreme/ui/scroll_view"
Type:

Object

dxSelectBox

The SelectBox widget is an editor that allows an end user to select an item from a drop-down list.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import SelectBox from "devextreme/ui/select_box"
Type:

Object

dxSlideOut

The SlideOut widget is a classic slide-out menu paired with a view. An end user opens the menu by swiping away the view.

Included in: dx.all.js
import SlideOut from "devextreme/ui/slide_out"
Type:

Object

dxSlideOutView

The SlideOutView widget is a classic slide-out menu paired with a view. This widget is very similar to the SlideOut with only one difference - the SlideOut always contains the List in the slide-out menu, while the SlideOutView can hold any collection there.

Included in: dx.all.js
import SlideOutView from "devextreme/ui/slide_out_view"
Type:

Object

Read Guides

See Also

dxSlider

The Slider is a widget that allows an end user to set a numeric value on a continuous range of possible values.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Slider from "devextreme/ui/slider"
Type:

Object

dxSpeedDialAction

The SpeedDialAction is a button that performs a custom action. It can be represented by a Floating Action Button (FAB) or a button in a speed dial menu opened with the FAB.

import SpeedDialAction from "devextreme/ui/speed_dial_action"
Type:

Object

When there is only one SpeedDialAction on a page, it is represented by a Floating Action Button (FAB).

When there are multiple SpeedDialActions, they are collected in a speed dial menu that can contain up to five actions. In this case, the FAB opens the menu. You can use the floatingActionButtonConfig object to change the maximum number of actions, and the FAB's position and icons in the opened and closed states.

View Demo

See Also

dxSwitch

The Switch is a widget that can be in two states: "On" and "Off".

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Switch from "devextreme/ui/switch"
Type:

Object

dxTabPanel

The TabPanel is a widget consisting of the Tabs and MultiView widgets. It automatically synchronizes the selected tab with the currently displayed view and vice versa.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import TabPanel from "devextreme/ui/tab_panel"
Type:

Object

dxTabs

The Tabs is a tab strip used to switch between pages or views. This widget is included in the TabPanel widget, but you can use the Tabs separately as well.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Tabs from "devextreme/ui/tabs"
Type:

Object

dxTagBox

The TagBox widget is an editor that allows an end user to select multiple items from a drop-down list.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import TagBox from "devextreme/ui/tag_box"
Type:

Object

dxTextArea

The TextArea is a widget that enables a user to enter and edit a multi-line text.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import TextArea from "devextreme/ui/text_area"
Type:

Object

dxTextBox

The TextBox is a widget that enables a user to enter and edit a single line of text.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import TextBox from "devextreme/ui/text_box"
Type:

Object

dxTileView

The TileView widget contains a collection of tiles. Tiles can store much more information than ordinary buttons, that is why they are very popular in apps designed for touch devices.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import TileView from "devextreme/ui/tile_view"
Type:

Object

dxToast

The Toast is a widget that provides pop-up notifications.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Toast from "devextreme/ui/toast"
Type:

Object

dxToolbar

The Toolbar is a widget containing items that usually manage screen content. Those items can be plain text or widgets.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Toolbar from "devextreme/ui/toolbar"
Type:

Object

dxTooltip

The Tooltip widget displays a tooltip for a specified element on the page.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Tooltip from "devextreme/ui/tooltip"
Type:

Object

dxTreeList

The TreeList is a widget that represents data from a local or remote source in the form of a multi-column tree view. This widget offers such features as sorting, filtering, editing, selection, etc.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import TreeList from "devextreme/ui/tree_list"
Type:

Object

dxTreeView

The TreeView widget is a tree-like representation of textual data.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import TreeView from "devextreme/ui/tree_view"
Type:

Object

dxValidationGroup

The ValidationGroup is a widget that allows you to validate several editors simultaneously.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import ValidationGroup from "devextreme/ui/validation_group"
Type:

Object

View Demo Read Guides

You can use the DevExpress.validationEngine.validateGroup(group) method to validate a particular validation group by passing its instance as a parameter.

JavaScript
DevExpress.validationEngine.validateGroup($("#sampleGroup").dxValidationGroup("instance"));

In addition, you can access a validation group's configuration using the DevExpress.validationEngine.getGroupConfig(group) method. The returned configuration exposes the validators included to the group, the validate() method to validate the editors that are associated with the validators and the validated event that occurs after the group is validated.

NOTE
Nested validation groups are not supported.
See Also

dxValidationSummary

A widget for displaying the result of checking validation rules for editors.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import ValidationSummary from "devextreme/ui/validation_summary"
Type:

Object

dxValidator

A widget that is used to validate the associated DevExtreme editors against the defined validation rules.

Included in: dx.web.js, dx.viz-web.js, dx.all.js
import Validator from "devextreme/ui/validator"
Type:

Object

Errors and Warnings

This section lists errors and warnings that may occur in UI widgets.

Markup Components

This section describes components that can be used when defining a widget markup.

UI Events

The events used to handle user interaction with UI elements.

Included in: dx.web.js, dx.viz.js, dx.viz-web.js, dx.all.js

DevExtreme provides UI events for processing a user's interaction with a specific UI element. The DevExpress.events namespace exposes an API to work with the UI events.

The following code shows how to attach, trigger and then detach a dxhold event handler from a page element with the target ID. The timeout parameter specifies how long the target should be held to allow the handler to execute:

jQuery
JavaScript
var dxholdHandler = function(jQueryEvent) {
    alert(`The ${$(jQueryEvent.target).text()} element was held for ${jQueryEvent.data.timeout} ms.`);
};

$("#target").on("dxhold", { timeout: 1000 }, dxholdHandler); 
$("#target").trigger("dxhold");
$("#target").off("dxhold", dxholdHandler);

See jQuery documentation for details.

Angular
JavaScript
import { on, trigger, off } from "devextreme/events";
// ...
export class AppComponent implements AfterViewInit {
    ngAfterViewInit() {
        const dxholdHandler = (event) => {
            alert(`The ${event.target.textContent} element was held for ${event.data.timeout} ms.`);
            return true; // true - continues event propagation, false - stops
        }
        const target: HTMLElement = document.getElementById("target");

        on(target, "dxhold", { timeout: 1000 }, dxholdHandler);
        trigger(target, "dxhold");
        off(target, "dxhold", dxholdHandler);
    }
}
Knockout
HTML
JavaScript
<div id="target" data-bind="dxhold: { execute: dxholdHandler, timeout: 1000 }">
    Target element
</div>
var viewModel = {
    dxholdHandler: function(viewModel, jQueryEvent) {
        alert(`The ${$(jQueryEvent.target).text()} element was held for ${jQueryEvent.data.timeout} ms.`);
    }
}
NOTE
Knockout does not provide an API to unsubscribe from an event.

See Knockout documentation for details.

AngularJS
HTML
JavaScript
<div id="target" dx-hold="{ execute: 'dxholdHandler($event)', timeout: 1000 }">
    Target element
</div>
angular.module("DemoApp", ["dx"])
    .controller("DemoController", function DemoController($scope) {
        $scope.dxholdHandler = function(jQueryEvent) {
            alert(`The ${$(jQueryEvent.target).text()} element was held for ${jQueryEvent.data.timeout} ms.`);
        }
    });
NOTE
AngularJS does not provide an API to unsubscribe from an event.

CSS Classes

This section describes the DevExtreme CSS classes you can use to define the appearance of an element.