HTMLIFrameElement.getCanGoBack()

Non-standard
This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

The getCanGoBack() method of the HTMLIFrameElement interface is used to indicate whether it's possible to go back in the navigation history of the browser <iframe>.

Syntax

There is a DOMRequest version and a Promise version:

var instanceOfDOMRequest = instanceOfHTMLIframeElement.getCanGoBack();
instanceOfHTMLIframeElement.getCanGoBack().then(function(result) { ... });

Returns

Returns either

  • A DOMRequest object to handle the request's success or error. If the request is successful, the request's result will be a boolean indicating if the history can be navigated backward (true) or not (false).
  • A Promise that resolves with a boolean that equals true if the history can be navigated backward or false if not.

Parameters

None.

Example

DOMRequest:

function canMoveBwd() {
  var request = browser.getCanGoBack();

  request.onsuccess = function() {
    if (request.result) {
      back.disabled = false;
      console.log("It's possible to navigate
                   the history backward.");
    } else {
      back.disabled = true;
      console.log("It's not possible to navigate
                   the history backward.");
    }
  }
}

Promise:

function canMoveBwd() {
  browser.getCanGoBack().then(function(result) {
    if (result) {
      back.disabled = false;
      console.log("It's possible to navigate
                   the history backward.");
    } else {
      back.disabled = true;
      console.log("It's not possible to navigate
                   the history backward.");
    }
  });
}

Specification

Not part of any specification.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidiOS SafariSamsung Internet
Basic support
Non-standard
Chrome No support NoEdge No support NoFirefox Full support 47
Notes
Full support 47
Notes
Notes Supported in chrome code only.
IE No support NoOpera No support NoSafari No support NoWebView Android No support NoChrome Android No support NoEdge Mobile No support NoFirefox Android No support NoOpera Android No support NoSafari iOS No support NoSamsung Internet Android ?

Legend

Full support  
Full support
No support  
No support
Compatibility unknown  
Compatibility unknown
Non-standard. Expect poor cross-browser support.
Non-standard. Expect poor cross-browser support.
See implementation notes.
See implementation notes.

See also

Document Tags and Contributors

Last updated by: sideshowbarker,