LumeWeb
/
webextension-polyfill
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Add section related to basic setup with ES6 module loader (#216)

This commit is contained in:
Luca Greco 2019-12-23 13:09:26 +01:00 committed by GitHub
parent f85b5d8e5b
commit 5c8a743cb2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -15,6 +15,7 @@ Table of contents
* [Supported Browsers](#supported-browsers) * [Supported Browsers](#supported-browsers)
* [Installation](#installation) * [Installation](#installation)
* [Basic Setup](#basic-setup) * [Basic Setup](#basic-setup)
* [Basic Setup with ES6 module loader](#basic-setup-with-es6-module-loader)
* [Basic Setup with module bundlers](#basic-setup-with-module-bundlers) * [Basic Setup with module bundlers](#basic-setup-with-module-bundlers)
* [Usage with webpack without bundling](#usage-with-webpack-without-bundling) * [Usage with webpack without bundling](#usage-with-webpack-without-bundling)
* [Using the Promise-based APIs](#using-the-promise-based-apis) * [Using the Promise-based APIs](#using-the-promise-based-apis)
@ -117,6 +118,31 @@ browser.tabs.executeScript({file: "content.js"}).then(result => {
}); });
``` ```
### Basic Setup with ES6 module loader
The polyfill can also be loaded using the native ES6 module loader available in
the recent browsers versions.
Be aware that the polyfill module does not export the `browser` API object,
but defines the `browser` object in the global namespace (i.e. `window`).
```html
<!DOCTYPE html>
<html>
<head>
<script type="module" src="browser-polyfill.js"></script>
<script type="module" src="background.js"></script>
</head>
<!-- ... -->
</html>
```
```javascript
// In background.js (loaded after browser-polyfill.js) the `browser`
// API object is already defined and provides the promise-based APIs.
browser.runtime.onMessage.addListener(...);
```
### Basic Setup with module bundlers ### Basic Setup with module bundlers
This library is built as a **UMD module** (Universal Module Definition), and so it can also be used with module bundlers (and explicitly tested on both **webpack** and **browserify**) or AMD module loaders. This library is built as a **UMD module** (Universal Module Definition), and so it can also be used with module bundlers (and explicitly tested on both **webpack** and **browserify**) or AMD module loaders.