The FullscreenOptions dictionary's navigationUI property is used when calling requestFullscreen() to specify to what extent the user agent should include its standard user interface while the element is presented in full-screen mode.
Syntax
let fullscreenOptions = {
navigationUI: value
};
Value
The value of the navigationUI property must be one of the following strings. The default is "auto".
"hide"- The browser's navigation interface will be hidden and the entire dimensions of the screen will be allocated to the display of the element.
"show"- The browser will present page navigation controls and possibly other user interface; the dimensions of the element (and the perceived size of the screen) will be clamped to leave room for this user interface.
"auto"- The browser will choose which of the above settings to apply. This is the default value.
Example
In this example, the entire document is placed into full-screen mode by calling requestFullscreen() on the document's Document.documentElement, which is the document's root <html> element.
let elem = document.documentElement;
elem.requestFullscreen({ navigationUI: "show" }).then({}).catch(err => {
alert(`An error occurred while trying to switch into full-screen mode: ${err.message} (${err.name})`);
});The promise's resolve handler does nothing, but if the promise is rejected, an error message is displayed by calling alert().
Specifications
| Specification | Status | Comment |
|---|---|---|
| Fullscreen APIThe definition of 'FullscreenOptions' in that specification. | Living Standard | Initial definition |
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
See also
FullscreenOptions.navigationUI by Mozilla Contributors is licensed under CC-BY-SA 2.5.
