Esta traducción está incompleta. Por favor, ayuda a traducir este artículo del inglés.

Add event listeners for the various stages of a navigation. A navigation consists of a frame in the browser transitioning from one URL to another, usually (but not always) in response to a user action like clicking a link or entering a URL in the location bar.

Compared with the webRequest API: navigations usually result in the browser making web requests, but the webRequest API is concerned with the lower-level view from the HTTP layer, while the webNavigation API is more concerned with the view from the browser UI itself.

Each event corresponds to a particular stage in the navigation. The sequence of events is like this:

Each navigation is a URL transition in a particular browser frame. The browser frame is identified by a tab ID and a frame ID. The frame may be the top-level browsing context in the tab, or may be a nested browsing context implemented as an iframe.

Each event's addListener() call accepts an optional filter parameter. The filter will specify one or more URL patterns, and the event will then only be fired for navigations in which the target URL matches one of the patterns.

The onCommitted event listener is passed two additional properties: a TransitionType indicating the cause of the navigation (for example, because the user clicked a link, or because the user selected a bookmark), and a TransitionQualifier providing further information about the navigation.

To use this API you need to have the "webNavigation" permission.

Types

webNavigation.TransitionType
Cause of the navigation: for example, the user clicked a link, or typed an address, or clicked a bookmark.
webNavigation.TransitionQualifier
Extra information about a transition.

Functions

webNavigation.getFrame()
Retrieves information about a particular frame. A frame may be the top-level frame in a tab or a nested iframe, and is uniquely identified by a tab ID and a frame ID.
webNavigation.getAllFrames()

Given a tab ID, retrieves information about all the frames it contains.

Events

webNavigation.onBeforeNavigate

Fired when the browser is about to start a navigation event.

webNavigation.onCommitted
Fired when a navigation is committed. At least part of the new document has been received from the server and the browser has decided to switch to the new document.
webNavigation.onDOMContentLoaded
Fired when the DOMContentLoaded event is fired in the page.
webNavigation.onCompleted
Fired when a document, including the resources it refers to, is completely loaded and initialized. This is equivalent to the DOM load event.
webNavigation.onErrorOccurred
Fired when an error occurs and the navigation is aborted. This can happen if either a network error occurred, or the user aborted the navigation.
webNavigation.onCreatedNavigationTarget
Fired when a new window, or a new tab in an existing window, is created to host a navigation: for example, if the user opens a link in a new tab.
webNavigation.onReferenceFragmentUpdated
Fired if the fragment identifier for a page is changed.
webNavigation.onTabReplaced

Fired when the contents of the tab is replaced by a different (usually previously pre-rendered) tab.

webNavigation.onHistoryStateUpdated
Fired when the page used the history API to update the URL displayed in the browser's location bar.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaFirefox for Android
TransitionQualifierChrome Soporte completo SiEdge Sin soporte NoFirefox Soporte completo 48
Notas
Soporte completo 48
Notas
Notas 'server_redirect' is limited to top-level frames and 'client_redirect' is not supplied when redirections are created by JavaScript.
Opera Soporte completo 17Firefox Android Soporte completo 48
Notas
Soporte completo 48
Notas
Notas 'server_redirect' is limited to top-level frames and 'client_redirect' is not supplied when redirections are created by JavaScript.
TransitionTypeChrome Soporte completo SiEdge Sin soporte NoFirefox Soporte completo 48
Notas
Soporte completo 48
Notas
Notas 'link' and 'auto_subframe' are partially supported as the default transition type for top-level frames and subframes respectively. 'reload' and 'form_submit' are supported. All other properties are unsupported.
Opera Soporte completo 17Firefox Android Soporte completo 48
Notas
Soporte completo 48
Notas
Notas 'link' and 'auto_subframe' are partially supported as the default transition type for top-level frames and subframes respectively. 'reload' and 'form_submit' are supported. All other properties are unsupported.
getAllFramesChrome Soporte completo SiEdge Soporte completo 14Firefox Soporte completo 47Opera Soporte completo 17Firefox Android Soporte completo 48
getFrameChrome Soporte completo SiEdge Soporte completo 14Firefox Soporte completo 47Opera Soporte completo 17Firefox Android Soporte completo 48
onBeforeNavigateChrome Soporte completo Si
Notas
Soporte completo Si
Notas
Notas If the filter parameter is empty, Chrome matches all URLs.
Edge Soporte completo 14
Notas
Soporte completo 14
Notas
Notas Filtering is not supported.
Firefox Soporte completo 45
Notas
Soporte completo 45
Notas
Notas Filtering is supported from version 50.
Notas If the filter parameter is empty, Firefox raises an exception.
Opera Soporte completo 17
Notas
Soporte completo 17
Notas
Notas If the filter parameter is empty, Opera matches all URLs.
Firefox Android Soporte completo 48
Notas
Soporte completo 48
Notas
Notas Filtering is supported from version 50.
Notas If the filter parameter is empty, Firefox raises an exception.
onCommittedChrome Soporte completo Si
Notas
Soporte completo Si
Notas
Notas If the filter parameter is empty, Chrome matches all URLs.
Edge Soporte completo 14
Notas
Soporte completo 14
Notas
Notas Filtering is not supported.
Firefox Soporte completo 45
Notas
Soporte completo 45
Notas
Notas Filtering is supported from version 50.
Notas If the filter parameter is empty, Firefox raises an exception.
Opera Soporte completo 17
Notas
Soporte completo 17
Notas
Notas If the filter parameter is empty, Opera matches all URLs.
Firefox Android Soporte completo 48
Notas
Soporte completo 48
Notas
Notas Filtering is supported from version 50.
Notas If the filter parameter is empty, Firefox raises an exception.
onCompletedChrome Soporte completo Si
Notas
Soporte completo Si
Notas
Notas If the filter parameter is empty, Chrome matches all URLs.
Edge Soporte completo 14
Notas
Soporte completo 14
Notas
Notas Filtering is not supported.
Firefox Soporte completo 45
Notas
Soporte completo 45
Notas
Notas Filtering is supported from version 50.
Notas If the filter parameter is empty, Firefox raises an exception.
Opera Soporte completo 17
Notas
Soporte completo 17
Notas
Notas If the filter parameter is empty, Opera matches all URLs.
Firefox Android Soporte completo 48
Notas
Soporte completo 48
Notas
Notas Filtering is supported from version 50.
Notas If the filter parameter is empty, Firefox raises an exception.
onCreatedNavigationTargetChrome Soporte completo Si
Notas
Soporte completo Si
Notas
Notas If a blocked popup is unblocked by the user, the event is still not sent.
Edge Soporte completo 14Firefox Soporte completo 54
Notas
Soporte completo 54
Notas
Notas If the filter parameter is empty, Firefox raises an exception.
Notas If a blocked popup is unblocked by the user, the event is then sent.
Opera Soporte completo 17
Notas
Soporte completo 17
Notas
Notas If a blocked popup is unblocked by the user, the event is still not sent.
Firefox Android Soporte completo 54
Notas
Soporte completo 54
Notas
Notas If the filter parameter is empty, Firefox raises an exception.
Notas If a blocked popup is unblocked by the user, the event is then sent.
Notas This event is only sent in the 'window.open()' case.
onDOMContentLoadedChrome Soporte completo Si
Notas
Soporte completo Si
Notas
Notas If the filter parameter is empty, Chrome matches all URLs.
Edge Soporte completo 14
Notas
Soporte completo 14
Notas
Notas Filtering is not supported.
Firefox Soporte completo 45
Notas
Soporte completo 45
Notas
Notas Filtering is supported from version 50.
Notas If the filter parameter is empty, Firefox raises an exception.
Opera Soporte completo 17
Notas
Soporte completo 17
Notas
Notas If the filter parameter is empty, Opera matches all URLs.
Firefox Android Soporte completo 48
Notas
Soporte completo 48
Notas
Notas Filtering is supported from version 50.
Notas If the filter parameter is empty, Firefox raises an exception.
onErrorOccurredChrome Soporte completo Si
Notas
Soporte completo Si
Notas
Notas If the filter parameter is empty, Chrome matches all URLs.
Edge Soporte completo 14
Notas
Soporte completo 14
Notas
Notas Filtering is not supported
Firefox Soporte completo 45
Notas
Soporte completo 45
Notas
Notas Filtering is supported from version 50.
Notas If the filter parameter is empty, Firefox raises an exception.
Opera Soporte completo 17
Notas
Soporte completo 17
Notas
Notas If the filter parameter is empty, Opera matches all URLs.
Firefox Android Soporte completo 48
Notas
Soporte completo 48
Notas
Notas Filtering is supported from version 50.
Notas If the filter parameter is empty, Firefox raises an exception.
onHistoryStateUpdatedChrome Soporte completo SiEdge Soporte completo 14
Notas
Soporte completo 14
Notas
Notas Filtering is not supported.
Firefox Soporte completo 47Opera Soporte completo 17Firefox Android Soporte completo 48
onReferenceFragmentUpdatedChrome Soporte completo Si
Notas
Soporte completo Si
Notas
Notas If the filter parameter is empty, Chrome matches all URLs.
Edge Soporte completo 14
Notas
Soporte completo 14
Notas
Notas Filtering is not supported.
Firefox Soporte completo 45
Notas
Soporte completo 45
Notas
Notas Filtering is supported from version 50.
Notas If the filter parameter is empty, Firefox raises an exception.
Opera Soporte completo 17
Notas
Soporte completo 17
Notas
Notas If the filter parameter is empty, Opera matches all URLs.
Firefox Android Soporte completo 48
Notas
Soporte completo 48
Notas
Notas Filtering is supported from version 50.
Notas If the filter parameter is empty, Firefox raises an exception.
onTabReplacedChrome Soporte completo SiEdge Soporte completo 14Firefox Soporte completo 45
Notas
Soporte completo 45
Notas
Notas Although you can add listeners for this event, it will never fire because the underlying functionality is not supported.
Opera Soporte completo 17Firefox Android Soporte completo 48
Notas
Soporte completo 48
Notas
Notas Although you can add listeners for this event, it will never fire because the underlying functionality is not supported.

Leyenda

Soporte completo  
Soporte completo
Sin soporte  
Sin soporte
Ver notas de implementación.
Ver notas de implementación.

Edge incompatibilities

Promises are not supported in Edge. Use callbacks instead.

Chrome incompatibilities

None.

Example extensions

Acknowledgements

This API is based on Chromium's chrome.webNavigation API. This documentation is derived from web_navigation.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Etiquetas y colaboradores del documento

Colaboradores en esta página: tanclony
Última actualización por: tanclony,