JavaScript/jQuery Accordion API

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.

import Accordion from "devextreme/ui/accordion"

Type:

Object

View Demo Read Guides

Options

An object defining configuration options for the Accordion widget.

Name	Description
accessKey	Specifies the shortcut key that sets focus on the widget.
activeStateEnabled	Specifies whether or not the widget changes its state when interacting with a user.
animationDuration	A number specifying the time in milliseconds spent on the animation of the expanding or collapsing of a panel.
collapsible	Specifies whether all items can be collapsed or whether at least one item must always be expanded.
dataSource	Binds the widget to data.
deferRendering	Specifies whether to render the panel's content when it is displayed. If false, the content is rendered immediately.
disabled	Specifies whether the widget responds to user interaction.
elementAttr	Specifies the attributes to be attached to the widget's root element.
focusStateEnabled	Specifies whether the widget can be focused using keyboard navigation.
height	Specifies the widget's height.
hint	Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled	Specifies whether the widget changes its state when a user pauses on it.
itemComponent	An alias for the itemTemplate option specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
itemHoldTimeout	The time period in milliseconds before the onItemHold event is raised.
itemRender	An alias for the itemTemplate option specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
items	An array of items displayed by the widget.
itemTemplate	Specifies a custom template for items.
itemTitleComponent	An alias for the itemTitleTemplate option specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
itemTitleRender	An alias for the itemTitleTemplate option specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
itemTitleTemplate	Specifies a custom template for item titles.
keyExpr	Specifies which data field provides keys for widget items.
multiple	Specifies whether the widget can expand several items or only a single item at once.
noDataText	The text or HTML markup displayed by the widget if the item collection is empty.
onContentReady	A function that is executed when the widget's content is ready and each time the content is changed.
onDisposing	A function that is executed before the widget is disposed of.
onInitialized	A function used in JavaScript frameworks to save the widget instance.
onItemClick	A function that is executed when a collection item is clicked or tapped.
onItemContextMenu	A function that is executed when a collection item is right-clicked or pressed.
onItemHold	A function that is executed when a collection item has been held for a specified period.
onItemRendered	A function that is executed after a collection item is rendered.
onItemTitleClick	A function that is executed when an accordion item's title is clicked or tapped.
onOptionChanged	A function that is executed after a widget option is changed.
onSelectionChanged	A function that is executed when a collection item is selected or selection is canceled.
repaintChangesOnly	Specifies whether to repaint only those elements whose data changed.
rtlEnabled	Switches the widget to a right-to-left representation.
selectedIndex	The index number of the currently selected item.
selectedItem	The selected item object.
selectedItemKeys	Specifies an array of currently selected item keys.
selectedItems	An array of currently selected item objects.
tabIndex	Specifies the number of the element when the Tab key is used for navigating.
visible	Specifies whether the widget is visible.
width	Specifies the widget's width.

Methods

This section describes members used to manipulate the Accordion widget.

Name	Description
beginUpdate()	Prevents the widget from refreshing until the endUpdate() method is called.
collapseItem(index)	Collapses an item with a specific index.
defaultOptions(rule)	Specifies the device-dependent default configuration options for this component.
dispose()	Disposes of all the resources allocated to the Accordion instance.
element()	Gets the root widget element.
endUpdate()	Refreshes the widget after a call of the beginUpdate() method.
expandItem(index)	Expands an item with a specific index.
focus()	Sets focus on the widget.
getDataSource()	Gets the DataSource instance.
getInstance(element)	Gets the instance of a widget found using its DOM node.
instance()	Gets the widget's instance. Use it to access other methods of the widget.
off(eventName)	Detaches all event handlers from a single event.
off(eventName, eventHandler)	Detaches a particular event handler from a single event.
on(eventName, eventHandler)	Subscribes to an event.
on(events)	Subscribes to events.
option()	Gets all widget options.
option(optionName)	Gets the value of a single option.
option(optionName, optionValue)	Updates the value of a single option.
option(options)	Updates the values of several options.
registerKeyHandler(key, handler)	Registers a handler to be executed when a user presses a specific key.
repaint()	Repaints the widget without reloading data. Call it to update the widget's markup.
updateDimensions()	Updates the dimensions of the widget contents.

Events

This section describes events fired by this widget.

Name	Description
contentReady	Raised when the widget's content is ready.
disposing	Raised before the widget is disposed of.
initialized	Raised only once, after the widget is initialized.
itemClick	Raised when a collection item is clicked or tapped.
itemContextMenu	Raised when a collection item is right-clicked or pressed.
itemHold	Raised when a collection item has been held for a specified period.
itemRendered	Raised after a collection item is rendered.
itemTitleClick	Raised when an accordion item's title is clicked or tapped.
optionChanged	Raised after a widget option is changed.
selectionChanged	Raised when a collection item is selected or selection is canceled.

Default Item Template

This section lists the data source fields that are used in a default template for Accordion items.

Type:

Object

By default, a predefined item template is applied to display the items of this widget. This template is based on certain fields of the data source provided for this widget. Below is a list of these fields. If the default item template is not appropriate for your task, implement a custom item template based on these or other fields of your data source.

JavaScript/jQuery Accordion API

See Also

Options

See Also

Methods

See Also

Events

See Also

Default Item Template

See Also