MDN wants to learn about developers like you: https://qsurvey.mozilla.com/s3/MDN-dev-survey

Add-ons

tabs.saveAsPDF()

Saves the current page as a PDF file. This will open a dialog, supplied by the underlying operating system, asking the user where they want to save the PDF file.

This is an asynchronous function that returns a Promise.

Syntax

var saving = browser.tabs.saveAsPDF(
  pageSettings   // object
)

Parameters

pageSettings
object. Settings for the saved page, as a tabs.PageSettings object. This object must be given, but all its properties are optional. Any properties not specified here will get the default values listed in the PageSettings documentation.

Return value

A Promise that will be fulfilled with a status string when the dialog has closed. The string may be any of:

  • "Saved"
  • "Replaced"
  • "Cancelled"
  • "Not Saved"
  • "Not Replaced"

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic supportNoNo56 1NoNo
1. This function does not work on Mac OS X.

Examples

In this example a background script listens for a click on a browser action, then tries to save the currently active tab as a PDF file, then logs the result:

browser.browserAction.onClicked.addListener(() => {
  browser.tabs.saveAsPDF({})
    .then((status) => {
      console.log(status);
    });
});

Document Tags and Contributors

 Contributors to this page: wbamberg
 Last updated by: wbamberg,