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
let saving = browser.tabs.saveAsPDF(
pageSettings // object
)
Parameters
pageSettings
-
object
. Settings for the saved page, as atabs.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 thePageSettings
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"
- "canceled"
- "not_saved"
- "not_replaced"
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);
});
});
Browser compatibility
BCD tables only load in the browser