wdp

webext-detect-page

Detects where the current browser extension code is being run. Chrome and Firefox.

Showing:

Popularity

Downloads/wk

1.2K

GitHub Stars

19

Maintenance

Last Commit

1mo ago

Contributors

3

Package

Dependencies

0

License

MIT

Type Definitions

Tree-Shakeable

Yes?

Categories

Readme

webext-detect-page

Detects where the current browser extension code is being run. Chrome and Firefox.

Install

You can download the standalone bundle and include it in your manifest.json.

Or use npm:

npm install webext-detect-page
// This module is only offered as a ES Module
import {
    isBackgroundPage,
    isContentScript,
    isOptionsPage
} from 'webext-detect-page';

Usage

import {isBackgroundPage} from 'webext-detect-page';

if (isBackgroundPage()) {
    // Run background code, e.g.
    browser.runtime.onMessage.addListener(console.log);
} else if (isContentScript) {
    // Run content script code, e.g.
    browser.runtime.sendMessage('wow!');
}

API

The functions are only ever evaluated once. This protects from future "invalidated context" errors.Read the note about testing if you're running this code in a tester.

isWebPage()

Returns a boolean that indicates whether the code is being run on http(s):// pages (it could be in a content script or regular web context).

isExtensionContext()

Returns a boolean that indicates whether the code is being run in extension contexts that have access to the chrome API.

isBackgroundPage()

Returns a boolean that indicates whether the code is being run in a background page.

isContentScript()

Returns a boolean that indicates whether the code is being run in a content script.

isOptionsPage()

Returns a boolean that indicates whether the code is being run in an options page. This only works if the current page’s URL matches the one specified in the extension's manifest.json.

isDevToolsPage()

Returns a boolean that indicates whether the code is being run in a dev tools page. This only works if the current page’s URL matches the one specified in the extension's manifest.json devtools_page field.

isChrome()

isFirefox()

isSafari()

Return a boolean if it matches the current browser. They are loose detections based on the user agent that are useful when developing Web Extensions.

Testing

The calls are automatically cached so, if you're using this in a test environment, import and call this function first to ensure that the environment is "detected" every time:

import {disableWebextDetectPageCache} from 'webext-detect-page';
disableWebextDetectPageCache();

License

MIT © Federico Brigante

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100