Configuration

An object defining configuration options for the List widget.

accessKey

Specifies the shortcut key that sets focus on the widget.

Type: String
Default Value: null

The value of this option will be passed to the accesskey attribute of the HTML element that underlies the widget.

activeStateEnabled

Specifies 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

allowItemDeleting

Specifies whether or not an end user can delete list items.

Type: Boolean
Default Value: false
Show Example:
AngularJS
Knockout
jQuery

allowItemReordering

Specifies whether or not an end user can reorder list items.

Type: Boolean
Default Value: false
NOTE
The item reordering feature requires the useNativeScrolling option to be set to false in Windows Phone 8 and Android.
See Also
Show Example:
AngularJS
Knockout
jQuery

autoPagingEnabled

Deprecated

Use the pageLoadMode option instead.

Show Example:
AngularJS
Knockout
jQuery

bounceEnabled

A Boolean value specifying whether to enable or disable the bounce-back effect.

Type: Boolean
Default Value: true

If the option is set to true, you can scroll the list content up (down) even if you have reached the bottom (top) boundary. But when you release the content, it returns to the bound position. If the option value is false, you can scroll the list content until you reach the boundary.

See Also
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.

See Also

View Demo

Show Example:
AngularJS
Knockout
jQuery

dataSource

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

Default Value: null

This option accepts one of the following.

  • Array of objects
    A simple JavaScript array containing a collection of plain objects.

  • URL
    A URL to JSON data or to a service returning data in JSON format.

  • DataSource or its configuration object
    A DataSource is an object that provides a handy API for data processing. A DataSource is a stateful object, which means that it saves data processing settings and applies them each time data is loaded. All underlying data access logic of a DataSource is isolated in a Store. A Store provides an API for reading and modifying data. Unlike the DataSource, a Store is a stateless object.

NOTE
If the data source is specified using the dataSource option, use the items option only for reading. Updating data items using the items option may cause unexpected results.

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.

Show Example:
AngularJS
Knockout
jQuery

disabled

Specifies whether the widget responds to user interaction.

Type: Boolean
Default Value: false

Show Example:
AngularJS
Knockout
jQuery

elementAttr

Specifies the attributes to be attached to the widget's root element.

Type: Object
Default Value: {}

You can configure this option in an ASP.NET MVC Control as follows:

Razor C#
Razor VB
@(Html.DevExtreme().WidgetName()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)
@(Html.DevExtreme().WidgetName() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

Type: Boolean
Default Value: false
Default for generic: true

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.

See Also

View Demo

Show Example:
AngularJS
Knockout
jQuery

groupTemplate

The template to be used for rendering item groups. Specifies a custom template for a group caption.

Type: template
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|DOM Node|jQuery

A template name or container.

Default Value: 'group'

If you use the Angular, AngularJS or Knockout library, you can implement this template with the dxTemplate markup component. This template's binding context depends on the library you use.

In Angular apps, a group's object and index extend the standard binding context (a component instance). Access the former using the input variable that is declared after the let and before of keywords, and the latter by the variable that is set to the index property.

In AngularJS apps, a group's object and index extend the standard binding context (the scope). Access the former using an alias that you specify in the dx-item-alias directive, and the latter the $index variable. Use AngularJS binding variables if you need to access another binding context from the template.

In Knockout apps, you can bind template elements directly to a group object's fields. Use the $index variable to get the item's index. Use Knockout binding variables if you need to access another binding context from the template.

See Also

View Demo

Show Example:
AngularJS
Knockout
jQuery

height

Specifies the widget's height.

Return Value: Number|String

The widget height.

Default Value: undefined

This option accepts a value of one of the following types.

  • Number
    The height of the widget in pixels.

  • String
    A CSS-accepted measurement of height. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    height: function() {
        return window.innerHeight / 1.5;
    }

hint

Specifies text for a hint that appears when a user pauses on the widget.

Type: String
Default Value: undefined

hoverStateEnabled

Specifies whether the widget changes its state when a user pauses on it.

Type: Boolean
Default Value: true

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 the 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 of the option value.

itemDeleteMode

Specifies the way a user can delete items from the list.

Type: String
Default Value: 'toggle'
Default for ios: 'slideItem'
Default for android: 'swipe'
Default for windows: 'context'
Default for generic: 'static'
Accepted Values: 'static' | 'toggle' | 'slideButton' | 'slideItem' | 'swipe' | 'context'
NOTE
If List items are supplied with the context menu, this option is ignored in favor of the menuMode option.

When using the widget as an ASP.NET MVC Control, specify this option using the ListItemDeleteMode enum. This enum accepts the following values: Static, Toggle, SlideButton, SlideItem, Swipe and Context.

See Also

View Demo

Show Example:
AngularJS
Knockout
jQuery

itemHoldTimeout

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

Type: Number
Default Value: 750

Show Example:
AngularJS
Knockout
jQuery

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.

NOTE
If you need to modify the data source specified using the items option at runtime, do it only with the help of the items option. Updating data items using the dataSource option may cause unexpected results.

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.

itemTemplate

Specifies a custom template for an item.

Type: template
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 container.

Default Value: 'item'

If you use the Angular, AngularJS or Knockout library, you can implement this template with the dxTemplate markup component. This template's binding context depends on the library you use.

In Angular apps, an item's object and index extend the standard binding context (a component instance). Access the former using the input variable that is declared after the let and before of keywords, and the latter by the variable that is set to the index property.

In AngularJS apps, an item's object and index extend the standard binding context (the scope). Access the former using an alias that you specify in the dx-item-alias directive, and the latter the $index variable. Use AngularJS binding variables if you need to access another binding context from the template.

In Knockout apps, you can bind template elements directly to an item object's fields. Use the $index variable to get the item's index. Use Knockout binding variables if you need to access another binding context from the template.

See Also
Show Example:
AngularJS
Knockout
jQuery

keyExpr

Specifies which data field provides keys for widget items.

Default Value: null
NOTE
The key value should be unique within the data array.
See Also

menuItems[]

Specifies the array of items for a context menu called for a list item.

Type: Array
Default Value: []

menuMode

Specifies whether an item context menu is shown when a user holds or swipes an item.

Type: String
Default Value: 'context'
Default for ios: 'slide'
Accepted Values: 'context' | 'slide'

When using the widget as an ASP.NET MVC Control, specify this option using the ListMenuMode enum. This enum accepts the following values: Context and Slide.

See Also

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. Executed when the widget's content is ready. This handler may be executed multiple times during the widget's lifetime depending on the number of times its content changes.

Type: function
Function parameters:

Information about the event.

Object structure:
component: Object
element: jQuery

The widget's container.

model: Object

The model data. Available only when using Knockout.

Default Value: null

onDisposing

A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.

Type: function
Function parameters:

Information about the event.

Object structure:
component: Object
element: jQuery

The widget's container.

model: Object

The model data. Available only if you use Knockout.

Default Value: null

onGroupRendered

A handler for the groupRendered event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget's instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

groupData: Object

The data that is bound to the group item.

groupElement: jQuery

An HTML element of the group.

groupIndex: Number

Specifies the index of the rendered group.

Default Value: null

Assign a function to perform a custom action after an item group element is rendered.

onInitialized

A handler for the initialized event. Executed only once, after the widget is initialized.

Type: function
Function parameters:

Information about the event.

Object structure:
component: Object
element: jQuery

The widget's container.

Default Value: null

You cannot access elements in the widget because this handler is executed before they are ready. Use the onContentReady handler instead.

onItemClick

A handler for the itemClick event.

Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget's instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

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.

See Also

onItemContextMenu

A handler for the itemContextMenu event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget's instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

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 }.

jQueryEvent: jQuery.Event

Specifies the jQuery event that caused action execution.

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's instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

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.

See Also

onItemDeleting

A handler for the itemDeleting event. Executed before an item is deleted from the data source.

Type: function
Function parameters:

Information about the event.

Object structure:
component: Object

Provides access to the widget's instance.

element: jQuery

The widget's container.

model: Object

The model data. Available only if you use Knockout.

itemData: Object

The data of the to-be-deleted item.

itemElement: jQuery

The item's container.

itemIndex: Number|Object

The index of the to-be-deleted item.
In a grouped list, the index represents an object defining group and item indexes: { group: 0, item: 0 }.

Allows you to cancel the item deletion.

Default Value: null

To cancel item deletion, assign true to the cancel field of the handler parameter. To perform an asynchronous action before deleting an item, assign a jQuery.Promise to the cancel field. The item will be deleted once the Deferred object of this Promise is resolved. The code below adds a confirmation dialog displayed before the item is deleted.

JavaScript
var widgetOptions = {
    onItemDeleting: function(e) {
        var d = $.Deferred();
        DevExpress.ui.dialog.confirm("Do you really want to delete the item?")
            .done(function(value) { 
                d.resolve(!value);
            })
            .fail(d.reject);
        e.cancel = d.promise();
    }
}

Note that the onItemDeleted and onItemDeleting handlers are not executed if an item is deleted from the data source without using the widget's UI or API.

onItemHold

A handler for the itemHold event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget's instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

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's instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data available for binding against the element. Available only in the Knockout approach.

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's instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

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 after reordering. In a grouped list, the index represents an object defining the group and item indexes: { group: 0, item: 0 }. This field holds the same value as toIndex.

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.

See Also

onItemSwipe

A handler for the itemSwipe event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget's instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

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.

See Also
Show Example:
AngularJS
Knockout
jQuery

onOptionChanged

A handler for the optionChanged event. Executed after an option of the widget is changed.

Type: function
Function parameters:

Information about the event.

Object structure:
component: Object
name: String

A short name of the option whose value has been changed.

fullName: String

A full name of the option whose value has been changed; contains a full hierarchy of the option.

value: any

A new value for the option.

element: jQuery

The widget's container.

model: Object

The model data. Available only if you use Knockout.

Default Value: null

onPageLoading

A handler for the pageLoading event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget's instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

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's instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

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.

See Also

onScroll

A handler for the scroll event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget's instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

jQueryEvent: jQuery.Event

Specifies 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.

See Also

onSelectAllValueChanged

A handler for the selectAllValueChanged event.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget's instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

value: Boolean

Specifies the select all check box state.

Default Value: null

Assign a function to perform a custom action when the select all check box value is changed.

Note that this event fires only if the selectionMode option is set to 'all'.

See Also

onSelectionChanged

A handler for the selectionChanged event. Raised after an item is selected or unselected.

Type: function
Function parameters:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget's instance.

element: jQuery

An HTML element of the widget.

model: Object

Provides access to the data that is available for binding against the element. Available only in the Knockout approach.

addedItems: Array

An array of items added to selection.

removedItems: Array

An array of items removed from selection.

Default Value: null

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

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...'

pageLoadMode

Specifies whether the next page is loaded when a user scrolls the widget to the bottom or when the "next" button is clicked.

Type: String
Default Value: 'scrollBottom'
Default for android below version 4: 'nextButton'
Default for desktop: 'nextButton'
Accepted Values: 'scrollBottom' | 'nextButton'

When using the widget as an ASP.NET MVC Control, specify this option using the ListPageLoadMode enum. This enum accepts the following values: ScrollBottom and NextButton.

See Also

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...'

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.
See Also
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

Switches the widget to a right-to-left representation.

Type: Boolean
Default Value: false

When this option is set to true, the widget text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

JavaScript
DevExpress.config({
    rtlEnabled: true
});

scrollByContent

A Boolean value specifying if the list is scrolled by content.

Type: Boolean
Default Value: true
Show Example:
AngularJS
Knockout
jQuery

scrollByThumb

A Boolean value specifying if the list is scrolled using the scrollbar.

Type: Boolean
Default Value: false
Show Example:
AngularJS
Knockout
jQuery

scrollingEnabled

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

Type: Boolean
Default Value: true

selectAllMode

Specifies the mode in which all items are selected.

Type: String
Default Value: 'page'
Accepted Values: 'page' | 'allPages'

The selectAllMode specifies how records should be selected on clicking the "Select All" check box. The following modes are available:

  • 'page'
    Selects items on the currently rendered pages.

  • 'allPages'
    Selects items on all pages.

NOTE
The selectAllMode applies only if the selectionMode is set to all and the selection controls are shown.
See Also

View Demo

selectedItemKeys

Specifies an array of currently selected item keys.

Type: Array

The item keys can be specified using the keyExpr option or the key option within the underlying Store.

See Also

selectedItems

An array of currently selected item objects.

Type: Array

selectionMode

Specifies item selection mode.

Type: String
Default Value: 'none'
Accepted Values: 'none' | 'multiple' | 'single' | 'all'

This option accepts the following values.

  • 'none'
    Selection is disabled.

  • 'single'
    A user can select only a single item.

  • 'multiple'
    A user can select several items.

  • 'all'
    The multiple mode with a check box that selects/unselects all items.
    Note that if paging is enabled, the select all check box selects only items that have been already loaded.

    NOTE
    The check box that selects/unselects all items is displayed only if the showSelectionControls option is enabled. Otherwise, the 'all' mode works as 'multiple'.

    When using the widget as an ASP.NET MVC Control, specify this option using the ListSelectionMode enum. This enum accepts the following values: Single, Multiple, All and None.

See Also

View Demo

showNextButton

Deprecated

Use the pageLoadMode option instead.

showScrollbar

Specifies when the widget shows the scrollbar.

Type: String
Default Value: 'onScroll'
Default for android below version 4: 'onHover'
Default for desktop: 'onHover'
Accepted Values: 'onScroll' | 'onHover' | 'always' | 'never'

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

When using the widget as an ASP.NET MVC Control, specify this option using the ShowScrollbarMode enum. This enum accepts the following values: OnScroll, OnHover, Always and Never.

See Also
Show Example:
AngularJS
Knockout
jQuery

showSelectionControls

Specifies whether or not to display controls used to select list items.

Type: Boolean
Default Value: false
Show Example:
AngularJS
Knockout
jQuery

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Type: Number
Default Value: 0

The value of this option will be passed to the tabindex attribute of the HTML element that underlies the widget.

useNativeScrolling

Specifies whether or not the widget uses native scrolling.

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

visible

Specifies whether the widget is visible.

Type: Boolean
Default Value: true

width

Specifies the widget's width.

Return Value: Number|String

The widget width.

Default Value: undefined

This option accepts a value of one of the following types.

  • Number
    The width of the widget in pixels.

  • String
    A CSS-accepted measurement of width. For example, "55px", "80%", "auto", "inherit".

  • Function
    A function returning either of the above. For example:

    JavaScript
    width: function() {
        return window.innerWidth / 1.5;
    }