Skip to content

NavigationHistory ​

NavigationHistory represents a web page's back and forward navigation: whether it can go back or forward, and going back or forward one page.

It is obtained from webContents.navigationHistory; each web page has only one.

Inheritance: NavigationHistory (doesn't inherit from EventTarget; has no events)

Constructor ​

It can't be created with new: that throws TypeError: Illegal constructor: NavigationHistory is created by the runtime, not by new. Get it from webContents.navigationHistory.

Instance methods ​

MethodDescription
canGoBack()Whether it can go back
canGoForward()Whether it can go forward
goBack()Goes back one page
goForward()Goes forward one page

Whether it can go back or forward may change after each did-navigate; read it again in that event.

After the web page is destroyed, all four methods throw TypeError: Object has been destroyed.

Examples ​

js
const contents = new WebView().webContents;
const history = contents.navigationHistory;
contents.addEventListener('did-navigate', () => {
  console.log('canGoBack', history.canGoBack(), 'canGoForward', history.canGoForward());
});
await contents.loadURL('https://example.com/');
await contents.loadURL('https://example.com/about');
history.goBack();

Result: Prints canGoBack false canGoForward false, canGoBack true canGoForward false, and canGoBack false canGoForward true in order.

Comparison with Electron ​

ElectronHereDifference
contents.navigationHistory.canGoBack() / canGoForward()Same
contents.navigationHistory.goBack() / goForward()Same

Corresponding iOS API ​

ObjC (WKWebView)JS
webView.canGoBack / canGoForwardcanGoBack() / canGoForward()
[webView goBack] / [webView goForward]goBack() / goForward()

See also ​