API: Show or Hide Navigation Bar
These JavaScript API calls allow you to customize whether to show or hide the Navigation Bar for specific pages or state conditions.
In this article
Requirements
- Integration of our JavaScript API into your webpage
- Sample code to run within the app and download for integration into your own project is available here.
- Best practices for working with the JavaScript API are available here.
- App Settings
- Content > JavaScript API > Access JavaScript API = By Import
Triggers via API Functions
Show Navigation Bar
This function shows the Navigation Bar. The Navigation Bar will be shown on subsequent pages, ignoring the configuration in the app settings.
The Navigation Bar will continue to be shown until another JavaScript function is called to hide or reset the Navigation Bar, or until a content refresh occurs.
Format | kp_navigationBarVisibility_show(); |
Hide Navigation Bar
This function turns off the Navigation Bar. The Navigation Bar will be hidden on subsequent pages, ignoring the configuration in the app settings.
The Navigation Bar will continue to be hidden until another JavaScript function is called to hide or reset the Navigation Bar, or until a content refresh occurs.
Format | kp_navigationBarVisibility_hide(); |
Reset Navigation Bar
This function resets the Navigation Bar to the configuration set in the app settings.
Format | kp_navigationBarVisibility_reset(); |
Sample Code
- This sample code relies on the JavaScript APIs built into Kiosk Pro and will not run successfully in other browsers or within our in-app help interface.
- To run sample code, set the app's homepage to kioskgroup.com/navigation-bar-api
- To download a .zip of sample code, click here.
Change Log
- Added in version 9.4.5