React Accordion API

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

import Accordion from "devextreme-react/accordion"

Type: AccordionTypes.default

View Demo Read Guides

Props

An object defining configuration properties for the Accordion UI component.

Name	Description
accessKey	Specifies the shortcut key that sets focus on the UI component.
activeStateEnabled	Specifies whether or not the UI component 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 UI component 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 UI component responds to user interaction.
elementAttr	Specifies the global attributes to be attached to the UI component's container element.
focusStateEnabled	Specifies whether the UI component can be focused using keyboard navigation.
height	Specifies the UI component's height.
hint	Specifies text for a hint that appears when a user pauses on the UI component.
hoverStateEnabled	Specifies whether the UI component changes its state when a user pauses on it.
itemComponent	An alias for the itemTemplate property 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 property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
items	An array of items displayed by the UI component.
itemTemplate	Specifies a custom template for items.
itemTitleComponent	An alias for the itemTitleTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
itemTitleRender	An alias for the itemTitleTemplate property 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 the key property that provides key values to access data items. Each key value must be unique.
multiple	Specifies whether the UI component can expand several items or only a single item at once.
noDataText	Specifies the text or HTML markup displayed by the UI component if the item collection is empty.
onContentReady	A function that is executed when the UI component's content is ready and each time the content is changed.
onDisposing	A function that is executed before the UI component is disposed of.
onInitialized	A function used in JavaScript frameworks to save the UI component 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 UI component property is changed.
onSelectionChanged	A function that is executed when a collection item is expanded or collapsed.
repaintChangesOnly	Specifies whether to repaint only those elements whose data changed.
rtlEnabled	Switches the UI component to a right-to-left representation.
selectedIndex	The index number of the currently expanded item.
selectedItem	The expanded item object.
selectedItemKeys	Specifies an array of currently expanded item keys.
selectedItems	An array of currently expanded item objects.
tabIndex	Specifies the number of the element when the Tab key is used for navigating.
visible	Specifies whether the UI component is visible.
width	Specifies the UI component's width.

Methods

This section describes members used to manipulate the Accordion UI component.

Name	Description
beginUpdate()	Prevents the UI component 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 properties for this component.
dispose()	Disposes of all the resources allocated to the Accordion instance.
element()	Gets the root UI component element.
endUpdate()	Refreshes the UI component after a call of the beginUpdate() method.
expandItem(index)	Expands an item with a specific index.
focus()	Sets focus on the UI component.
getDataSource()	Gets the DataSource instance.
getInstance(element)	Gets the instance of a UI component found using its DOM node.
instance()	Gets the UI component's instance. Use it to access other methods of the UI component.
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 UI component properties.
option(optionName)	Gets the value of a single property.
option(optionName, optionValue)	Updates the value of a single property.
option(options)	Updates the values of several properties.
registerKeyHandler(key, handler)	Registers a handler to be executed when a user presses a specific key.
repaint()	Repaints the UI component without reloading data. Call it to update the UI component's markup.
resetOption(optionName)	Resets a property to its default value.
updateDimensions()	Updates the dimensions of the UI component contents.

Events

This section describes events fired by this UI component.

Name	Description
contentReady	Raised when the UI component's content is ready.
disposing	Raised before the UI component is disposed of.
initialized	Raised only once, after the UI component 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 UI component property is changed.
selectionChanged	Raised when a collection item is expanded or collapsed.

React Accordion API

See Also

Props

See Also

Methods

See Also

Events

See Also