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

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support No support 47 (47)[1] No support No support No support
Feature Android Android Webview Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support No support No support No support No support No support No support No support

[1] Supported in chrome code only.

See also

Document Tags and Contributors

 Contributors to this page: chrisdavidmills, wbamberg, teoli, ajaybhat, kscarfone, Jeremie
 Last updated by: chrisdavidmills,