Package Exports

webext-content-script-ping

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (webext-content-script-ping) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

webext-content-script-ping

One-file interface to detect whether your content script have loaded.

Install

npm install --save webext-content-script-ping

import {pingContentScript} from 'webext-content-script-ping';

Usage

From background.js, ping a tab id:

/* globals pingContentScript */
pingContentScript(tabId).then(() => {
    // the content script was loaded!
}, () => {
    // the content script was NOT loaded!
});

Plain files

In your manifest.json, include the file as background and as content script:

{
    "background": {
        "scripts": [
            "webext-content-script-ping.js"
        ]
    },
    "content_scripts": [
        {
            "js": [
                "webext-content-script-ping.js",
                "content.js"
            ]
        }
    ]
}

In your background script only, run pingContentScript(tabId) as needed

With a bundler

// background.js
import pingContentScript from 'webext-content-script-ping';
pingContentScript(tabId);

// content.js
import 'webext-content-script-ping'; // this only responds to the ping

API

pingContentScript(tab)

Returns a Promise that succeeds if the content was loaded, fails if it wasn't.

It has an internal timeout of 300ms.

tab

Type: Tab or number

A Tab object or just its id as defined here: https://developer.chrome.com/extensions/tabs#type-Tab

webext-options-sync: Helps you manage and autosave your extension's options.
webext-inject-on-install: Automatically add content scripts to existing tabs when your extension is installed.
Awesome WebExtensions: A curated list of awesome resources for Web Extensions development.