JavaScript/jQuery Accordion Methods
beginUpdate()
Prevents the UI component from refreshing until the endUpdate() method is called.
The beginUpdate() and endUpdate() methods prevent the UI component from excessive updates when you are changing multiple UI component settings at once. After the beginUpdate() method is called, the UI component does not update its UI until the endUpdate() method is called.
See Also
collapseItem(index)
A Promise that is resolved if the item is collapsed and rejected otherwise. It is a native Promise or a jQuery.Promise when you use jQuery.
defaultOptions(rule)
defaultOptions is a static method that the UI component class supports. The following code demonstrates how to specify default properties for all instances of the Accordion UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxAccordion.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Accordion properties
}
});Angular
import Accordion from "devextreme/ui/accordion";
// ...
export class AppComponent {
constructor () {
Accordion.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Accordion properties
}
});
}
}Vue
<template>
<div>
<DxAccordion id="accordion1" />
<DxAccordion id="accordion2" />
</div>
</template>
<script>
import DxAccordion from "devextreme-vue/accordion";
import Accordion from "devextreme/ui/accordion";
Accordion.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Accordion properties
}
});
export default {
components: {
DxAccordion
}
}
</script>React
import React, {useEffect} from "react";
import dxAccordion from "devextreme/ui/accordion";
import Accordion from "devextreme-react/accordion";
export default function App() {
useEffect(() => {
dxAccordion.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the Accordion properties
}
})
});
return (
<div>
<Accordion id="accordion1" />
<Accordion id="accordion2" />
</div>
)
}dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#myAccordion").dxAccordion("dispose");
$("#myAccordion").remove();Use this method only if the UI component was created with jQuery or pure JavaScript. In Angular, Vue, and React, use conditional rendering:
Angular
<dx-accordion ...
*ngIf="condition">
</dx-accordion>Vue
<template>
<DxAccordion ...
v-if="condition">
</DxAccordion>
</template>
<script>
import DxAccordion from 'devextreme-vue/accordion';
export default {
components: {
DxAccordion
}
}
</script>React
import React from 'react';
import Accordion from 'devextreme-react/accordion';
function DxAccordion(props) {
if (!props.shouldRender) {
return null;
}
return (
<Accordion ... >
</Accordion>
);
}
class App extends React.Component {
render() {
return (
<DxAccordion shouldRender="condition" />
);
}
}
export default App;See Also
expandItem(index)
A Promise that is resolved if the item is expanded and rejected otherwise. It is a native Promise or a jQuery.Promise when you use jQuery.
getDataSource()
Gets the DataSource instance.
See Also
- Call Methods: Angular | Vue | React | jQuery | AngularJS | Knockout
- Data Layer - Overview
- Data Layer - DataSource Examples
getInstance(element)
getInstance is a static method that the UI component class supports. The following code demonstrates how to get the Accordion instance found in an element with the myAccordion ID:
// Modular approach
import Accordion from "devextreme/ui/accordion";
...
let element = document.getElementById("myAccordion");
let instance = Accordion.getInstance(element) as Accordion;
// Non-modular approach
let element = document.getElementById("myAccordion");
let instance = DevExpress.ui.dxAccordion.getInstance(element);See Also
registerKeyHandler(key, handler)
A handler. Accepts the keydown event as the argument. It is a EventObject or a jQuery.Event when you use jQuery.
The key argument accepts one of the following values:
- "backspace"
- "tab"
- "enter"
- "escape"
- "pageUp"
- "pageDown"
- "end"
- "home"
- "leftArrow"
- "upArrow"
- "rightArrow"
- "downArrow"
- "del"
- "space"
- "F"
- "A"
- "asterisk"
- "minus"
A custom handler for a key cancels the default handler for this key.
See Also
updateDimensions()
A Promise that is resolved after the update is completed. It is a native Promise or a jQuery.Promise when you use jQuery.