Development basics

Learn the basics of Chrome extension development.

Published on Tuesday, October 4, 2022

概览

This page describes the extension development workflow. We will create a "Hello, Extensions" example, load the extension locally, locate logs, and explore other recommendations.

本页描述了扩展开发工作流程。我们将创建一个“Hello，扩展”，在本地加载扩展、定位日志并探索其他建议。

Hello Extensions

This extension will display “Hello Extensions” when the user clicks on the extension toolbar icon.

Start by creating a new directory to store extension files. If you prefer, you can download the full source code from GitHub.

Next, create a new file in this directory called manifest.json and add the following code:

{
  "manifest_version": 3,
  "name": "Hello Extensions",
  "description": "Base Level Extension",
  "version": "1.0",
  "action": {
    "default_popup": "hello.html",
    "default_icon": "hello_extensions.png"
  }
}

This JSON object describes the extension's capabilities and configuration. For example, the "action" key declares the image Chrome should use as the action's icon and the HTML page to show in a popup when the action is clicked. Download the icon to your directory, and be sure to change its name to match what's in the "default_icon" key.

For the popup, create a file named hello.html, and add the following code:

<html>
  <body>
    <h1>Hello Extensions</h1>
  </body>
</html>

The extension now displays a popup when the extension action (toolbar icon) is clicked. Let's test it in Chrome by loading it locally. Ensure all files are saved.

Loading an unpacked extension

To load an unpacked extension in developer mode:

Go to the Extensions page by entering chrome://extensions in a new tab. (By design chrome:// URLs are not linkable.)
- Alternatively, click on the Extensions menu puzzle button and select Manage Extensions at the bottom of the menu.
- Or, click the Chrome menu, hover over More Tools, then select Extensions.
Enable Developer Mode by clicking the toggle switch next to Developer mode.
Click the Load unpacked button and select the extension directory.
Extensions page (chrome://extensions)

Ta-da! The extension has been successfully installed. Because no extension icons were included in the manifest, a generic icon will be created for the extension.

Pinning the extension

By default, when you load your extension locally, it will appear in the extensions menu . Pin your extension to the toolbar to quickly access your extension during development.

Click on the extension’s action (toolbar icon); you should see a popup.

hello world extension — Hello World extension

Reloading the extension

Let’s go back to the code and change the name of the extension to "Hello Extensions of the world!" in the manifest.

{
  "manifest_version": 3,
  "name": "Hello Extensions of the world!",
  ...
}

After saving the file, to see this change in the browser you also have to refresh the extension. Go to the Extensions page and click the refresh icon next to the on/off toggle:

Not all components need to be reloaded to see changes made, as shown in the following table:

Extension component	Requires extension reload
The manifest	Yes
Service worker	Yes
Content Scripts	Yes (plus the host page)
The popup	No
Options page	No
Other extension HTML pages	No

Finding console logs and errors

Console logs

During development, you can debug your code by accessing the browser console logs. In this case, we will locate the logs for the popup. Start by adding a script tag to hello.html.

<html>
  <body>
    <h1>Hello Extensions</h1>
    <script src="popup.js"></script>
  </body>
</html>

Create a popup.js file and add the following code:

console.log('This is a popup!');

To see this message logged in the Console:

Open the popup.
Right-click on the popup.
Select Inspect.

4. In the [DevTools][dev-tools], navigate to the **Console** panel.

DevTools Code Panel — Inspecting a popup

Error logs

Now let's break the extension. We can do so by removing the closing quote in popup.js:

console.log("This is a popup!) // ❌ broken code

Go to the Extensions page and open the popup. An Errors button will appear.

Click the Errors button to learn more about the error:

To learn more about debugging the service worker, options page, and content scripts, see Debugging extensions.

Structuring an extension project

There are many ways to structure an extension project; however, you must place the manifest.json file in the extension's root directory. The following is a structure example:

Using TypeScript

If you are developing using a code editor such as VSCode or Atom, you can use the npm package chrome-types to take advantage of auto-completion for the Chrome API. This npm package is updated automatically when the Chromium source code changes.

Important

Update this npm package frequently to work with the latest Chromium version.

🚀 Ready to start building?

Choose any of the following tutorials to begin your extension learning journey.

Extension	What you will learn
Reading time	To insert an element on every page automatically.
Focus Mode	To run code on the current page after clicking on the extension action.
Tabs Manager	To create a popup that manages browser tabs.

As a bonus, these tutorials were designed to improve your experience when reading the Chrome extension and Chrome Web store documentation:

Reading time adds the expected reading time to each documentation articles.
Focus mode changes the style of the page to help you concentrate on the documentation content.
Tabs manager allows you to organize your extension documentation tabs.

Updated on Tuesday, October 4, 2022 • Improve article

Development basics

# 概览

# Hello Extensions

# Loading an unpacked extension

# Pinning the extension

# Reloading the extension

# Finding console logs and errors

# Console logs

# Error logs

# Structuring an extension project

# Using TypeScript

# 🚀 Ready to start building?

概览