How to import ES6 modules in content script for Chrome Extension
As it's already mentioned, for background script, it's good idea to use background.page
and use <script type="module">
to kick your JavaScript.
The problem is content script
, and injecting <script>
tag with type
attribute can be a solution.
Another approach than injecting script tag is to use dynamic import
function. By this approach, you don't need to loose scope of chrome
module and still can use chrome.runtime
or other modules.
- Dynamic import()
In content_script.js
, it looks like
(async () => {
const src = chrome.runtime.getURL("your/content_main.js");
const contentMain = await import(src);
contentMain.main();
})();
You'll also need to declare the imported scripts in manifest's Web Accessible Resources:
{
"web_accessible_resources": [
"your/content_main.js"
]
}
For more details:
- How to use ES6 “import” with Chrome Extension
- Working Example of ES6 import in Chrome Extension
chrome.runtime.getURL
Hope it helps.
I managed to find a workaround.
Disclaimer
First of all, it’s important to say that content scripts don’t support modules as of January 2018. This workaround sidesteps the limitation by embedding module script
tag into the page that leads back to your extension.
Workaround
This is my manifest.json
:
"content_scripts": [ {
"js": [
"content.js"
]
}],
"web_accessible_resources": [
"main.js",
"my-script.js"
]
Note that I have two scripts in web_accessible_resources
.
This is my content.js
:
'use strict';
const script = document.createElement('script');
script.setAttribute("type", "module");
script.setAttribute("src", chrome.extension.getURL('main.js'));
const head = document.head || document.getElementsByTagName("head")[0] || document.documentElement;
head.insertBefore(script, head.lastChild);
This will insert main.js
into the webpage as a module script.
All my business logic is now in main.js
.
For this method to work, main.js
(as well as all scripts that I will import
) must be in web_accessible_resources
in the manifest.
Example Usage: my-script.js
'use strict';
const injectFunction = () => window.alert('hello world');
export {injectFunction};
And in main.js
this is an example of importing the script:
'use strict';
import {injectFunction} from './my-script.js';
injectFunction();
This works! No errors are thrown, and I am happy. :)