Navigator
The Navigator interface represents the state and the identity of the user agent. It allows scripts to query it and to register themselves to carry on some activities.
A Navigator object can be retrieved using the read-only window.navigator property.
Properties
Doesn't inherit any properties.
Standard properties
Navigator.connectionRead only- Provides a
NetworkInformationobject containing information about the network connection of a device. Navigator.cookieEnabledRead only- Returns false if setting a cookie will be ignored and true otherwise.
Navigator.credentialsRead only- Returns the
CredentialsContainerinterface which exposes methods to request credentials and notify the user agent when interesting events occur such as successful sign in or sign out. Navigator.deviceMemoryRead only- Returns the amount of device memory in gigabytes. This value is an approximation given by rounding to the nearest power of 2 and dividing that number by 1024.
Navigator.doNotTrackRead only- Reports the value of the user's do-not-track preference. When this value is "yes", your web site or application should not track the user.
Navigator.geolocationRead only- Returns a
Geolocationobject allowing accessing the location of the device. Navigator.hidRead only- Returns an
HIDobject providing methods for connecting to HID devices, listing attached HID devices, and event handlers for connected HID devices. Navigator.hardwareConcurrencyRead only- Returns the number of logical processor cores available.
Navigator.keyboardRead only- Returns a
Keyboardobject which provides access to functions that retrieve keyboard layout maps and toggle capturing of key presses from the physical keyboard. Navigator.languageRead only- Returns a
DOMStringrepresenting the preferred language of the user, usually the language of the browser UI. Thenullvalue is returned when this is unknown. Navigator.languagesRead only- Returns an array of
DOMStringrepresenting the languages known to the user, by order of preference. Navigator.locksRead only- Returns a
LockManagerobject which provides methods for requesting a newLockobject and querying for an existingLockobject Navigator.maxTouchPointsRead only- Returns the maximum number of simultaneous touch contact points are supported by the current device.
Navigator.mediaCapabilitiesRead only- Returns a
MediaCapabilitiesobject that can expose information about the decoding and encoding capabilities for a given format and output capabilities. Navigator.mediaDevicesRead only- Returns a reference to a
MediaDevicesobject which can then be used to get information about available media devices (MediaDevices.enumerateDevices()), find out what constrainable properties are supported for media on the user's computer and user agent (MediaDevices.getSupportedConstraints()), and to request access to media usingMediaDevices.getUserMedia(). Navigator.mediaSessionRead only- Returns
MediaSessionobject which can be used to provide metadata that can be used by the browser to present information about the currently-playing media to the user, such as in a global media controls UI. Navigator.onLineRead only- Returns a
Booleanindicating whether the browser is working online. Navigator.permissionsRead only- Returns a
Permissionsobject that can be used to query and update permission status of APIs covered by the Permissions API. Navigator.presentationRead only- Returns a reference to the
PresentationAPI. Navigator.serialRead only- Returns a
Serialobject, which represents the entry point into theWeb Serial APIto enable the control of serial ports. Navigator.serviceWorkerRead only- Returns a
ServiceWorkerContainerobject, which provides access to registration, removal, upgrade, and communication with theServiceWorkerobjects for the associated document. Navigator.storageRead only- Returns the singleton
StorageManagerobject used for managing persistence permissions and estimating available storage on a site-by-site/app-by-app basis. Navigator.userAgentRead only- Returns the user agent string for the current browser.
Navigator.vendorRead only- Returns the vendor name of the current browser (e.g., "Netscape6").
Navigator.webdriverRead only- Indicates whether the user agent is controlled by automation.
Navigator.xrRead only- Returns
XRSystemobject, which represents the entry point into the WebXR API.
Non-standard properties
Navigator.buildID- Returns the build identifier of the browser. In modern browsers this property now returns a fixed timestamp as a privacy measure, e.g.
20181001000000in Firefox 64 onwards. Navigator.contactsRead only- Returns a
ContactsManagerinterface which allows users to select entries from their contact list and share limited details of the selected entries with a website or application. Navigator.securitypolicy- Returns an empty string. In Netscape 4.7x, returns "US & CA domestic policy" or "Export policy".
Navigator.standalone- Returns a boolean indicating whether the browser is running in standalone mode. Available on Apple's iOS Safari only.
Navigator.wakeLockRead only- Returns a
WakeLockinterface you can use to request screen wake locks and prevent screen from dimming, turning off, or showing a screen saver.
Deprecated properties
Navigator.appCodeNameRead only- Returns the internal "code" name of the current browser. Do not rely on this property to return the correct value.
Navigator.appNameRead only- Returns a
DOMStringwith the official name of the browser. Do not rely on this property to return the correct value. Navigator.appVersionRead only- Returns the version of the browser as a
DOMString. Do not rely on this property to return the correct value. Navigator.activeVRDisplaysRead only- Returns an array containing every
VRDisplayobject that is currently presenting (VRDisplay.ispresentingistrue). Navigator.batteryRead only- Returns a
BatteryManagerobject you can use to get information about the battery charging status. Navigator.mimeTypesRead only- Returns an
MimeTypeArraylisting the MIME types supported by the browser. Navigator.oscpuRead only- Returns a string that represents the current operating system.
Navigator.platformRead only- Returns a string representing the platform of the browser. Do not rely on this function to return a significant value.
Navigator.pluginsRead only- Returns a
PluginArraylisting the plugins installed in the browser. Navigator.productRead only- Always returns
'Gecko', on any browser. This property is kept only for compatibility purpose. Navigator.productSubRead only- Returns the build number of the current browser (e.g., "20060909").
Navigator.vendorSubRead only- Returns the vendor version number (e.g. "6.1").
Methods
Doesn't inherit any method.
Navigator.canShare()- Returns
trueif a call toNavigator.share()would succeed. Navigator.clearAppBadge()- Clears a badge on the current app's icon and returns a
Promisethat resolves withundefined. Navigator.getBattery()- Returns a promise that resolves with a
BatteryManagerobject that returns information about the battery charging status. Navigator.javaEnabled()Read only- Returns false.
Navigator.registerProtocolHandler()- Allows web sites to register themselves as a possible handler for a given protocol.
Navigator.requestMediaKeySystemAccess()- Returns a
Promisefor a MediaKeySystemAccess object. Navigator.sendBeacon()- Used to asynchronously transfer a small amount of data using HTTP from the User Agent to a web server.
Navigator.setAppBadge()- Sets a badge on the icon associated with this app and returns a
Promisethat resolves withundefined. Navigator.share()- Invokes the native sharing mechanism of the current platform.
Navigator.vibrate()- Causes vibration on devices with support for it. Does nothing if vibration support isn't available.
Deprecated methods
Navigator.getVRDisplays()- Returns a promise that resolves to an array of
VRDisplayobjects representing any available VR devices connected to the computer. Navigator.getUserMedia()- After having prompted the user for permission, returns the audio or video stream associated to a camera or microphone on the local computer.
Navigator.taintEnabled()- Returns
false. JavaScript taint/untaint functions removed in JavaScript 1.2.
Specifications
| Specification |
|---|
| HTML Standard (HTML) # the-navigator-object |
Browser compatibility
BCD tables only load in the browser