Frequently asked questions
What are Google Chrome extensions?
Google Chrome Extensions are applications that run inside the Chrome browser and provide additional functionality, integration with third party websites or services, and customized browsing experiences.
How can I set up Chrome for extension development?
As long as you are using a version of Chrome that supports extensions, you already have everything you need to start writing an extension of your own. You can start by turning on Developer mode.
Click the Chrome menu icon and select Extensions from the Tools menu. Ensure that the "Developer mode" checkbox in the top right-hand corner is checked. Now you can reload extensions, load an unpacked directory of files as if it were a packaged extension, and more. For a complete tutorial, see Getting Started.
What technologies are used to write extensions for Chrome?
Are extensions fetched from the web every time the browser is loaded?
Extensions are downloaded by the Chrome browser upon install, and are subsequently run off of local disk to speed up performance. However, if a new version of the extension is uploaded to the Chrome Web Store, it will be automatically downloaded in the background for any users who have the extension installed. Extensions may also make requests for remote data at any time, but not remotely-hosted code.
How do I determine which version of Chrome is deployed to which channel?
To determine which version of Chrome is currently available on each of the different platforms, visit chrome releases, which lists the current Chrome releases for each channel and platform.
Can extensions make cross-origin network requests?
Yes. Extensions can make cross-origin network requests. See this page for more information.
Can extensions use 3rd party web services?
Yes. Extensions are capable of making cross-origin network requests, so they can call remote APIs directly. APIs that provide data in JSON format are particularly easy to use.
Can extensions encode/decode JSON data?
Can extensions store data locally?
Yes. Extensions provide a storage API designed specifically for extensions. An extension service worker can als0 use CacheStorage, and IndexedDB. Additionally, contexts outside the extension service worker can use the Web Storage API.
Can extensions use OAuth?
Can extensions create UI outside of the rendered web page?
Yes, your extension may add buttons to the Chrome browser's user interface using the action API.
An extension may also create popup notifications, which exist outside of the browser window. See the Rich notifications documentation for details.
Can extensions listen to clicks on Chrome tabs and navigation buttons?
No. Extensions are limited to listening to the events described in the API documentation.
Can two extensions communicate with each other?
Yes, extensions may pass messages to other extensions. See Cross-extension messaging for more information.
Can extensions use Google Analytics?
Can extensions modify chrome:// URLs?
No. The extensions APIs have been designed to minimize backwards compatibility issues that can arise when new versions of the browser are pushed. Allowing content scripts on
The reason that replacing the content hosted at these URLs entirely is allowed is because it forces an extension developer to implement all of the functionality they want without depending on the browser's internal implementation to stay the same.
Can extensions open action popups without a user interaction?
No. Popups can only be opened if the user clicks the corresponding action. An extension cannot open its popup programmatically.
Can extensions keep popups open after the user clicks away from them?
No. Popups automatically close when the user focuses on some portion of the browser outside of the popup. There is no way to keep the popup open after the user has clicked away.
Can extensions be notified when they are installed/uninstalled?
You can listen to the
runtime.onInstalled event to be notified when your extension is installed or updated, or when Chrome itself is updated. While there is no event listener for uninstalling an extension, a URL can be set by calling
runtime.setUninstallUrl() to open a URL when the extension is uninstalled. This allows for some final functionality, like cleaning up server-side data, doing analytics, and implementing surveys without access to any extension APIs.
How do I build a UI for my extension?
How much data can I store in localStorage?
Extensions can store up to 10MB of data in
How do I create an options menu for my extension?
You can let users set options for your extension by creating an options page, which is a simple HTML page that will be loaded when a user clicks the "options" button for your extension. This page can read and write settings to localStorage, or even send options to a web server so that they can be persisted across browsers.
What debugging tools are available to extension developers?
Chrome's built-in developer tools can be used to debug extensions as well as web pages. See Debugging extensions for more information.
Why do wildcard matches not work for top level domains?
You cannot use wildcard match patterns like
https://google.*/* to match top level domains (like
https://google.fr) due to the complexity of actually restricting such a match to only the desired domains.
For the example of
https://google.*/*, the Google domains would be matched, but so would
https://google.someotherdomain.com. Additionally, many sites do not own all of the top level domains for their domain. For an example, assume you want to use
https://example.*/* to match
https://example.net is a hostile site. If your extension has a bug, the hostile site could potentially attack your extension in order to get access to your extension's increased privileges.
You should explicitly enumerate the top level domains that you wish to run your extension on.
How can an extension determine whether it is running for the first time?
Features and bugs
I think I've found a bug! How do I make sure it gets fixed?
While developing an extension, you may find behavior that does not match the extensions documentation and may be the result of a bug in Chrome. The best thing to do is to make sure an appropriate issue report is filed, and the Chromium team has enough information to reproduce the behavior.
The steps you should follow to ensure this are:
- Come up with a minimal test extension that demonstrates the issue you wish to report. This extension should have as little code as possible to demonstrate the bug—generally this should be 100 lines of code or less. Many times, developers find that they cannot reproduce their issues this way, which is a good indicator that the bug is in their own code.
- Search the issue tracker at https://crbug.com to see whether someone has reported a similar issue. Most issues related to extensions are filed under component=Platform>Extensions, so to look for an extension bug related to the chrome.scripting.executeScript function (for example), search for "
component=Platform>Extensions Type=Bug chrome.scripting.executeScript", which will give you this list of results.
- If you find a bug that describes your issue, click the star icon to be notified when the bug receives an update. Do not respond to the bug to say "me too" or ask "when will this be fixed?"; such updates can cause hundreds of emails to be sent. Add a comment only if you have information (such as a better test case or a suggested fix) that is likely to be helpful.
- If you found no appropriate bug to star, file a new issue report at https://crbug.com/new. Be as explicit as possible when filling out this form: choose a descriptive title, explain the steps to reproduce the bug, and describe the expected and actual behavior. Attach your test example to the report and add screenshots if appropriate. The easier your report makes it for others to reproduce your issue, the greater chance that your bug will be fixed promptly.
- Wait for the bug to be updated. Most new bugs are triaged within a week, although it can sometimes take longer for an update. Do not reply to the bug to ask when the issue will be fixed. If your bug has not been modified after two weeks, please post a message to the discussion group with a link back to your bug.
- If you originally reported your bug on the discussion group and were directed to this FAQ entry, reply to your original thread with a link to the bug you starred or reported. This will make it easier for others experiencing the same issue to find the correct bug.
I have a feature request! How can I report it?
If you identify a feature (especially if it's related to an experimental API) that could be added to improve the extension development experience, make sure an appropriate request is filed in the issue tracker.
The steps you should follow to ensure this are:
- Search the issue tracker at https://crbug.com to see whether someone has requested a similar feature. Most requests related to extensions are filed under component=Platform>Extensions, so to look for an extension feature request related to keyboard shortcuts (for example), search for "
component=Platform>Extensions Type=Feature shortcuts", which will give you this list of results.
- If you find a ticket that matches your request, click the star icon to be notified when the bug receives an update. Do not respond to the bug to say "me too" or ask "when will this be implemented?"; such updates can cause hundreds of emails to be sent.
- If you found no appropriate ticket to star, file a new request at https://crbug.com/new. Be as detailed as possible when filling out this form: choose a descriptive title and explain exactly what feature you would like and how you plan to use it.
- Wait for the ticket to be updated. Most new requests are triaged within a week, although it can sometimes take longer for an update. Do not reply to the ticket to ask when the feature will be added. If your ticket has not been modified after two weeks, please post a message to the discussion group with a link back to your request.
- If you originally reported your request on the discussion group and were directed to this FAQ entry, reply to your original thread with a link to the ticket you starred or opened. This will make it easier for others with the same request to find the correct ticket.