JavaScript/jQuery NavBar 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 NavBar UI component in an application executed on the desktop.
jQuery
DevExpress.ui.dxNavBar.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the NavBar properties
}
});Angular
import NavBar from "devextreme/ui/nav_bar";
// ...
export class AppComponent {
constructor () {
NavBar.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the NavBar properties
}
});
}
}Vue
<template>
<div>
<DxNavBar id="navBar1" />
<DxNavBar id="navBar2" />
</div>
</template>
<script>
import DxNavBar from "devextreme-vue/nav-bar";
import NavBar from "devextreme/ui/nav_bar";
NavBar.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the NavBar properties
}
});
export default {
components: {
DxNavBar
}
}
</script>React
import React, {useEffect} from "react";
import dxNavBar from "devextreme/ui/nav_bar";
import NavBar from "devextreme-react/nav-bar";
export default function App() {
useEffect(() => {
dxNavBar.defaultOptions({
device: { deviceType: "desktop" },
options: {
// Here go the NavBar properties
}
})
});
return (
<div>
<NavBar id="navBar1" />
<NavBar id="navBar2" />
</div>
)
}dispose()
After calling this method, remove the DOM element associated with the UI component:
$("#myNavBar").dxNavBar("dispose");
$("#myNavBar").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-nav-bar ...
*ngIf="condition">
</dx-nav-bar>Vue
<template>
<DxNavBar ...
v-if="condition">
</DxNavBar>
</template>
<script>
import DxNavBar from 'devextreme-vue/nav-bar';
export default {
components: {
DxNavBar
}
}
</script>React
import React from 'react';
import NavBar from 'devextreme-react/nav-bar';
function DxNavBar(props) {
if (!props.shouldRender) {
return null;
}
return (
<NavBar ... >
</NavBar>
);
}
class App extends React.Component {
render() {
return (
<DxNavBar 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 NavBar instance found in an element with the myNavBar ID:
// Modular approach
import NavBar from "devextreme/ui/nav_bar";
...
let element = document.getElementById("myNavBar");
let instance = NavBar.getInstance(element) as NavBar;
// Non-modular approach
let element = document.getElementById("myNavBar");
let instance = DevExpress.ui.dxNavBar.getInstance(element);See Also
registerKeyHandler(key, handler)
A handler. Accepts the keydown event as the argument. It is a dxEvent 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.