JavaScript/jQuery SlideOut 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
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 SlideOut UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxSlideOut.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the SlideOut properties
}
});Angular
import SlideOut from "devextreme/ui/slide_out";
// ...
export class AppComponent {
constructor () {
SlideOut.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the SlideOut properties
}
});
}
}Vue
<template>
<div>
<DxSlideOut id="slideOut1" />
<DxSlideOut id="slideOut2" />
</div>
</template>
<script>
import DxSlideOut from "devextreme-vue/slide-out";
import SlideOut from "devextreme/ui/slide_out";
SlideOut.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the SlideOut properties
}
});
export default {
components: {
DxSlideOut
}
}
</script>React
import React, {useEffect} from "react";
import dxSlideOut from "devextreme/ui/slide_out";
import SlideOut from "devextreme-react/slide-out";
export default function App() {
useEffect(() => {
dxSlideOut.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the SlideOut properties
}
})
});
return (
<div>
<SlideOut id="slideOut1" />
<SlideOut id="slideOut2" />
</div>
)
}dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#mySlideOut").dxSlideOut("dispose");
$("#mySlideOut").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-slide-out ...
*ngIf="condition">
</dx-slide-out>Vue
<template>
<DxSlideOut ...
v-if="condition">
</DxSlideOut>
</template>
<script>
import DxSlideOut from 'devextreme-vue/slide-out';
export default {
components: {
DxSlideOut
}
}
</script>React
import React from 'react';
import SlideOut from 'devextreme-react/slide-out';
function DxSlideOut(props) {
if (!props.shouldRender) {
return null;
}
return (
<SlideOut ... >
</SlideOut>
);
}
class App extends React.Component {
render() {
return (
<DxSlideOut shouldRender="condition" />
);
}
}
export default App;See Also
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 SlideOut instance found in an element with the mySlideOut ID:
// Modular approach
import SlideOut from "devextreme/ui/slide_out";
...
let element = document.getElementById("mySlideOut");
let instance = SlideOut.getInstance(element) as SlideOut;
// Non-modular approach
let element = document.getElementById("mySlideOut");
let instance = DevExpress.ui.dxSlideOut.getInstance(element);See Also
hideMenu()
A Promise that is resolved after the menu is hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
showMenu()
A Promise that is resolved after the menu is shown. It is a native Promise or a jQuery.Promise when you use jQuery.
toggleMenuVisibility(showing)
A Promise that is resolved after the menu is shown/hidden. It is a native Promise or a jQuery.Promise when you use jQuery.
You can use this method instead of the showMenu() and hideMenu() methods.