Configuration

An object defining configuration options for the dxList widget.

activeStateEnabled

A Boolean value specifying whether or not the widget changes its state when interacting with a user.

Type: Boolean
Default Value: true

This option is used when the widget is displayed on a platform whose guidelines include the active state change for widgets.

Show Example:
AngularJS
Knockout
jQuery

autoPagingEnabled

A Boolean value specifying whether or not to load the next page from the data source when the list is scrolled to the bottom.

Type: Boolean
Default Value: true

You can also load the next page's data on the "More" button click. Assign true to the showNextButton option to display the "more" button.

Show Example:
AngularJS
Knockout
jQuery

collapsibleGroups

Specifies whether or not an end-user can collapse groups.

Type: Boolean
Default Value: false

This option makes sense if the grouped option is set to true.

If the collapsibleGroups option is set to true, the down arrow is displayed to the right of a group header. An end-user can collapse or expand a group simply clicking the group header.

View Demo

Show Example:
AngularJS
Knockout
jQuery

contentReadyAction

Deprecated

Use the onContentReady option instead.

dataSource

A data source used to fetch data to be displayed by the widget.

Default Value: null

You can assign an array directly to this option as well as use the Data Source provided by the DevExtreme library.

To display widget items, a default template can be used. This template is based on the data source fields that are listed in the Default Item Template section of the widget's API. Alternatively, you can implement a custom item template.

See Also
Show Example:
AngularJS
Knockout
jQuery

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

Type: Boolean
Default Value: false

Create an observable variable and assign it to this option to specify the availability of the widget at runtime.

Show Example:
AngularJS
Knockout
jQuery

editConfig

An object used to set configuration options for the dxList's edit mode.

Type: Object

If you make the dxList widget editable, set the required edit mode. For this purpose, use the deleteEnabled and/or selectionEnabled fields of the editConfig configuration object.

The dxList widget comes with several predefined modes for item deletion and selection. You can set the required mode using the deleteType and/or selectionType fields of the editConfig configuration object. The predefined modes enclose a specific item appearance and control elements for deletion and selection. You can also specify a custom HTML template for selectable/deletable list items using the itemTemplate option of the editConfig configuration object. In this case, the selectItem, deleteItem and unselectItem widget methods will be useful.

View Demo

Show Example:
AngularJS
Knockout
jQuery

editEnabled

Specifies whether the item list represented by this widget is editable.

Type: Boolean
Default Value: false

When this option is set to true, the item list becomes editable. Once it is editable, list items can be selected or deleted. To set the required edit mode, use the editConfig configuration option.

In addition, items in an editable list can be selected or deleted from code using the selectItem, deleteItem and unselectItem methods.

You can perform certain actions when an item is deleted, selected or deselected. For this purpose, handle the corresponding events using the onItemDeleted or onSelectionChanged configuration option.

focusStateEnabled

Specifies whether or not the widget can be focused.

Type: Boolean
Default Value: false

grouped

A Boolean value specifying whether or not to display a grouped list.

Type: Boolean
Default Value: false

If this option is set to 'true', the object assigned to the items option should include the key and items properties. The key property specifies the group caption in the list. The items property represents an array listing the group items.

View Demo

Show Example:
AngularJS
Knockout
jQuery

groupRender

Deprecated

Use the groupTemplate option instead.

groupTemplate

The name of the template used to display a group header.

Type: String|function|DOM Node|jQuery
Function parameters:
groupData: Object

The group object to be rendered.

groupIndex: Number

The index of the group to be rendered.

groupElement: Object

An HTML element of the group to be rendered.

Return Value: String|jQuery

A template name or a template container.

Default Value: "group"

NOTE: A binding context of a group template is the data source object that corresponds to the currently rendered group. So, you can bind template elements to the group object's fields directly (see the code above). To access another binding context within a group template, use the Knockout/Angular binding variables.

View Demo

Show Example:
AngularJS
Knockout
jQuery

height

Specifies the height of the widget.

Type: Number|String|function
Return Value: Number|String

The widget height.

Default Value: undefined

The option can hold a value of the following types.

  • number
    The height of the widget in pixels

  • string
    A CSS measurement of the widget height (e.g., "55px", "80%", "auto" and "inherit")

  • function
    A function returning the widget height (e.g., height:function(){ return baseHeight - 10 + "%"; })

hint

Specifies the text of the hint displayed for the widget.

Type: String
Default Value: undefined

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

Type: Boolean
Default Value: false

indicateLoading

Specifies whether or not to show the loading panel when the DataSource bound to the widget is loading data.

Type: Boolean
Default Value: true
NOTE
This option affects only the load panel displayed when bound DataSource is loading data after the load() method is called. The load indicator displayed when the list is being updated is always enabled regardless the option value.

itemClickAction

Deprecated

Use the onItemClick option instead.

itemDeleteAction

Deprecated

Use the onItemDeleted option instead.

itemHoldAction

Deprecated

Use the onItemHold option instead.

itemHoldTimeout

The time period in milliseconds before the onItemHold event is raised.

Type: Number
Default Value: 750

Show Example:
AngularJS
Knockout
jQuery

itemRender

Deprecated

Use the itemTemplate option instead.

itemRenderedAction

Deprecated

Use the onItemRendered option instead.

itemReorderAction

Deprecated

Use the onItemReordered option instead.

items

An array of items displayed by the widget.

Type: Array

You can use the dataSource option instead. Unlike the items option, the dataSource option can take on the DataSource configuration object as well as a simple array.

itemSelectAction

Deprecated

Use the onSelectionChanged option instead.

A function performed when a widget item is selected.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

itemData: Object

The data that is bound to the selected item.

itemElement: jQuery

An HTML element representing the item.

itemIndex: Number

Specifies the index of the just selected item.

Default Value: null

Assign a function to perform a custom action when a widget item is selected.

Alternatively, you can assign a URL to which the browser will navigate when a widget item is selected.

itemSwipeAction

Deprecated

Use the onItemSwipe option instead.

itemTemplate

The template to be used for rendering items.

Type: String|function|DOM Node|jQuery
Function parameters:
itemData: Object

The item object to be rendered.

itemIndex: Number

The index of the item to be rendered.

itemElement: jQuery

An HTML element of the item to be rendered.

Return Value: String|DOM Node|jQuery

A template name or a template container.

Default Value: "item"
See Also

NOTE: A binding context of an item template is the data source object that corresponds to the currently rendered item. So, you can bind template elements to the item object's fields directly (see the code above). To access another binding context within an item template, use Knockout/Angular binding variables.

Show Example:
AngularJS
Knockout
jQuery

itemUnselectAction

Deprecated

Use the onSelectionChanged option instead.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

itemData: Object

The data that is bound to the unselected item.

itemElement: jQuery

An HTML element of the item.

itemIndex: Number

Specifies the index of the item being unselected. In a grouped list, the index is the object with group and item indexes: { group: 0, item: 0 }.

Default Value: null

nextButtonText

The text displayed on the button used to load the next page from the data source.

Type: String
Default Value: "More"

Show Example:
AngularJS
Knockout
jQuery

noDataText

The text or HTML markup displayed by the widget if the item collection is empty.

Type: String
Default Value: "No data to display"

onContentReady

A handler for the contentReady event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

Default Value: null

Assign a function to perform a custom action when widget content is ready.

onDisposing

A handler for the disposing event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

Default Value: null

Assign a function to perform a custom action when you dispose of this component.

onItemClick

A handler for the itemClick event.

Type: function|String
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

itemData: Object

The data that is bound to the clicked item.

itemElement: jQuery

An HTML element of the item.

itemIndex: Number|Object

Specifies the index of the clicked item. In a grouped list, the index represents an object defining group and item indexes: { group: 0, item: 0 }.

Default Value: null

Assign a function to perform a custom action when a widget item is clicked.

To navigate to a specific URL when the itemClick event fires, assign that URL directly to this option.

onItemContextMenu

A handler for the itemContextMenu event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

itemData: Object

The data that is bound to the item.

itemElement: jQuery

An HTML element of the item.

itemIndex: Number|Object

Specifies an index of the item for which the context menu is displayed. In a grouped list, the index is specified as an object defining group and item indexes: { group: 0, item: 0 }.

Default Value: null

Assign a function to perform a custom action when the right mouse button is clicked when the pointer is over a widget item, or when the "sustained" (also known as a long press) touch action is performed.

onItemDeleted

A handler for the itemDeleted event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

itemData: Object

The data that is bound to the removed item.

itemElement: jQuery

An HTML element of the item.

itemIndex: Number|Object

Specifies the index of the item being deleted. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

Default Value: null

Assign a function to perform a custom action when a list item is deleted.

Note that the itemDeleted event is raised only if an item is deleted using the appropriate method of the widget or end-user interaction. If you delete an item from an observable array passed to the dataSource or items option, the widget entirely reloads the items array without raising the itemDeleted and itemDeleting events.

onItemDeleting

A handler for the itemDeleting event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

itemData: Object

The data that is bound to the item to be removed.

itemElement: jQuery

An HTML element of the item.

itemIndex: Number|Object

Specifies the index of the item being deleted.

Return Value: jQuery.Promise

A Promise of the jQuery Deferred object resolved if the item deletion is confirmed and rejected if deletion is canceled.

Default Value: null

You can use this option to add a confirmation dialog displayed when a widget item is deleted.

JavaScript
var widgetOptions = {
    onItemDeleting: function(e) {
        return DevExpress.ui.dialog.confirm("Do you really want to delete the item?");
    })
}

Assign a function to perform a custom action before a collection item is deleted.

Note that the itemDeleting event is raised only if an item is being deleted using the appropriate method of the widget or end-user interaction. If you delete an item from an observable array passed to the dataSource or items option, the widget entirely reloads the items array without raising the itemDeleted and itemDeleting events.

onItemHold

A handler for the itemHold event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

itemData: Object

The data that is bound to the item being held.

itemElement: jQuery

An HTML element of the item.

itemIndex: Number|Object

The index of the item being held. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

Default Value: null

Assign a function to perform a custom action when the widget's collection item is being held for a specified time period (see the itemHoldTimeout option).

Show Example:
AngularJS
Knockout
jQuery

onItemRendered

A handler for the itemRendered event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

itemData: Object

The data that is bound to the item to be rendered.

itemElement: jQuery

An HTML element of the item.

itemIndex: Number

Specifies the index of the rendered item.

Default Value: null

Assign a function to perform a custom action after a collection item is rendered.

onItemReordered

A handler for the itemReordered event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

itemData: Object

The data that is bound to the reordered item.

itemElement: jQuery

An HTML element of the item.

itemIndex: Number|Object

Specifies the current index of the item. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

fromIndex: Number

Specifies the previous index of the item. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

toIndex: Number

Specifies the current index of the item. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

Default Value: null

Assign a function to perform a custom action when a list item is moved to another position.

onItemSwipe

A handler for the itemSwipe event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

jQueryEvent: jQuery.Event

Specifies the jQuery event that caused action execution.

itemData: Object

The data that is bound to the swiped item.

itemElement: jQuery

An HTML element of the item.

itemIndex: Number|Object

The index of the swiped items. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }.

direction: String

Specifies whether the swipe operation is performed in the left or right direction.

Default Value: null

Assign a function to perform a custom action when an item is swiped.

Show Example:
AngularJS
Knockout
jQuery

onOptionChanged

A handler for the optionChanged event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

value: any

Specifies a new value for the option.

Default Value: null

Assign a function to perform a custom action after an option of the component is changed.

onPageLoading

A handler for the pageLoading event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

Default Value: null

Assign a function to perform a custom action before loading the next page when autopaging is enabled.

onPullRefresh

A handler for the pullRefresh event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

Default Value: null

Assign a function to perform a custom action before the list is refreshed as a result of the "pull down to refresh" gesture.

onScroll

A handler for the scroll event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

jQueryEvent: jQuery.Event

Holds the jQuery event that caused action execution.

scrollOffset: Object

Specifies the current scroll offset in the following format { top: topOffset, left: leftOffset }.

reachedLeft: Boolean

Indicates whether the container's left boundary is reached.

reachedRight: Boolean

Indicates whether the container's right boundary is reached.

reachedTop: Boolean

Indicates whether the container's top boundary is reached.

reachedBottom: Boolean

Indicates whether the container's bottom boundary is reached.

Default Value: null

Assign a function to perform a custom action on each scroll gesture.

onSelectionChanged

A handler for the selectionChanged event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element.

Default Value: null

Assign a function to perform a custom action after a collection item is selected or unselected.

pageLoadingAction

Deprecated

Use the onPageLoading option instead.

pageLoadingText

Specifies the text shown in the pullDown panel, which is displayed when the list is scrolled to the bottom.

Type: String
Default Value: "Loading..."

pulledDownText

Specifies the text displayed in the pullDown panel when the list is pulled below the refresh threshold.

Type: String
Default Value: "Release to refresh..."

pullingDownText

Specifies the text shown in the pullDown panel while the list is being pulled down to the refresh threshold.

Type: String
Default Value: "Pull down to refresh..."

pullRefreshAction

Deprecated

Use the onPullRefresh option instead.

pullRefreshEnabled

A Boolean value specifying whether or not the widget supports the "pull down to refresh" gesture.

Type: Boolean
Default Value: false

If the option is set to true, list data is refreshed each time you pull down and release list contents.

NOTE
The "pull down to refresh" gesture is not supported by desktop browsers and Windows Phone devices. You can use it only in mobile themes except the Windows Phone theme.
Show Example:
AngularJS
Knockout
jQuery

refreshingText

Specifies the text displayed in the pullDown panel while the list is being refreshed.

Type: String
Default Value: "Refreshing..."

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

Type: Boolean
Default Value: false

If you need to switch the display of this DevExtreme component to right-to-left, enable a specifically designed configuration option - rtlEnabled. When this option is set to true, the text flows from right to left, and the layout the component's elements is reversed. To switch the entire application/site to a right-to-left representation, use the static DevExpress.rtlEnabled field.

scrollAction

Deprecated

Use the onScroll option instead.

scrollingEnabled

A Boolean value specifying whether to enable or disable list scrolling.

Type: Boolean
Default Value: true

selectedItems

An array of currently selected item objects.

Type: Array

selectionMode

Specifies whether the list supports single item selection or multi-selection.

Type: String
Default Value: 'multi'
Accepted Values: 'multi'|'single'

showNextButton

A Boolean value specifying whether the widget loads the next page automatically when you reach the bottom of the list or when a button is clicked.

Type: Boolean
Default Value: false

If this option is set to true, the widget shows a "Next Page" button, and loads the next page of data when you click this button.

NOTE: The default value of this option is false if your application is running on a mobile platform. If you run the application on the desktop, the default value is true.

Show Example:
AngularJS
Knockout
jQuery

showScrollbar

Specifies when the widget shows the scrollbar.

Type: String
Default Value: 'onScroll'
Accepted Values: 'onScroll'|'onHover'|'always'|'never'

Setting this option makes sense only when the useNativeScrolling option is set to false.

Show Example:
AngularJS
Knockout
jQuery

tabIndex

Specifies the widget tab index.

Type: Number
Default Value: 0

useNativeScrolling

Specifies whether or not the widget uses native scrolling.

Type: Boolean
Default Value: true
Default for android below version 4: false
Default for tizen: false
Default for desktop: false
Default for mac desktop: true

visible

A Boolean value specifying whether or not the widget is visible.

Type: Boolean
Default Value: true

width

Specifies the width of the widget.

Type: Number|String|function
Return Value: Number|String

The widget width.

Default Value: undefined

The option can hold a value of the following types.

  • numeric
    The widget width in pixels.
  • string
    A CSS measurement of the widget width (e.g., "55px", "80%", "auto" and "inherit").
  • function
    The function returning the widget width. For example, see the following code.

    JavaScript
    width: function () { 
        return baseWidth - 10 + "%";
    }