createContentScriptIFrame API

[molvqingtai]

Feature Request

Currently, all WebExtension frameworks do not implement contentScript HMR. Perhaps this is the only solution that can achieve true HMR:

Inject an iframe into the page and load content.html.

You can refer to the following links for more information:

• antfu/vitesse-webext
• louisremi/vite-react-extension

Consider adding a createContentScriptIFrame API to implement contentScript HMR.

Is your feature request related to a bug?

N

What are the alternatives?

N

Additional context

N

[aklinker1]

@molvqingtai Great feature idea, thanks for the suggestion.

Would an API similar to createContentScriptUi be what you're looking for? It would include options for positioning and alignment.

[molvqingtai]

@molvqingtai Great feature idea, thanks for the suggestion.

Would an API similar to createContentScriptUi be what you're looking for? It would include options for positioning and alignment.

I know createContentScriptUi, shadow can only be reload, and iframe can HMR.

[aklinker1]

Yes, it will use an iframe and include HMR. I'm gonna make the API similar to creayeContentScriptUi, with similar options.

[aklinker1]

Released in v0.8.7!

I'll add more in-depth examples in the future, but for now, you can see it's usage here: https://wxt.dev/entrypoints/content-scripts.html#iframe

[molvqingtai]

Awesome work！

[onlyfortesting]

Released in v0.8.7!

I'll add more in-depth examples in the future, but for now, you can see it's usage here: https://wxt.dev/entrypoints/content-scripts.html#iframe

@aklinker1, I got ReferenceError: createContentScriptIframe is not defined. Looking at the dist files createContentScriptIframe doesn't seem to be exported. Can you verify this? Thank you.

[aklinker1]

@onlyfortesting Yes, it's exported

https://wxt.dev/api/wxt/client/functions/createContentScriptIframe.html

It's exported from the wxt/client module, but is also available via auto-imports. Try running

pnpm install wxt@0.8.7 # or 0.9.0
pnpm wxt clean
pnpm wxt prepare
pnpm wxt dev

[onlyfortesting]

@aklinker1 For some reason, I thought I was running the latest version. It turns out it was 0.8.6. Sorry for the nuisance.

[aklinker1]

No worries! Glad you got it sorted 👍