Writing Chrome Extensions in React

Rate this content
Bookmark
Slides

Did you know that Chrome extensions, or web extensions, are written in plain HTML, CSS, and JavaScript? That means you can use React to write fully featured and sophisticated web extensions using the web development skills you already know. During this talk, we'll go over the basics of web extension development, how to set up a build process for an extension using React, and review a fully functioning extension that's in the Chrome web store right now!

This talk has been presented at React Day Berlin 2022, check out the latest edition of this React Conference.

FAQ

A Chrome extension is a small software program that customizes the browsing experience. They are represented by little icons that appear in the top right of the browser window and can be installed to add functionality to the browser.

You can create a Chrome extension using React by writing the extension with HTML, CSS, and JavaScript. You can use tools like React, Webpack, and ES6 to build your extension as long as the final output complies with the web extension specification.

You can use various tools like React, Webpack, and ES6 to build a Chrome extension. Although there are no comprehensive tools like Create React App or Next.js for extensions, there are boilerplates available that can help you get started.

To load a Chrome extension, go to Chrome's extensions page (chrome://extensions), enable Developer mode, click on 'Load unpacked,' and select the build directory of your extension. The extension will then appear in the browser.

The manifest.json file is a crucial part of a Chrome extension. It contains metadata about the extension, such as its name, version, permissions, and the files it uses. This file is essential for the browser to recognize and load the extension.

Yes, you can use existing web development tools like React, Webpack, and ES6 to build Chrome extensions. The final output, however, must be in the form of HTML, CSS, and JavaScript to be compatible with the web extension specification.

Yes, Chrome extensions can be used in other browsers as well. There is a common web extension specification that many browsers follow, allowing extensions to be compatible across different platforms.

If the dev tools for your Chrome extension don't work immediately, it may be due to permissions issues. Ensure that the necessary permissions are set correctly in the manifest.json file.

You can find more resources and talks by Riaz Varani on his website riazv.me. The site includes various presentations and additional information on Chrome and web extensions.

Yes, Riaz Varani recommends a specific boilerplate for building Chrome extensions in React. This boilerplate includes the most common elements needed for extension development. You can find the link to this boilerplate in the slides of his presentation.

Riaz Virani
Riaz Virani
7 min
05 Dec, 2022

Comments

Sign in or register to post your comment.
Video Summary and Transcription
Today's Talk is about making Chrome extensions in React. The speaker demonstrates a boilerplate project and shows how easy it is to get started. The Talk also explores the components of a Chrome extension and how changes trigger a hot reload.

1. Introduction to Chrome Extensions in React

Short description:

Hi everyone, my name is Riaz Varani and today we're going to talk about how to make Chrome extensions in React. What is a Chrome extension? How do you make one? Can you use HTML, CSS, and JS? We're going to quickly do a show and tell with a boilerplate project and see how easy it is to get live.

Hi everyone, my name is Riaz Varani and today we're going to talk about how to make Chrome extensions in React. I work for a company that I own called EQseminalytics, if you want to learn more about it, if you like any part of this talk, there's some information there in the URL below, and there's also some other talks that I've given at riazv.me.

So let's get right into it. What is a Chrome extension? Right? How does it even come about? Well, you probably already have some of them. They're the little icons that you see in the top right of your browser window if you're happening to use Chrome, but they're in a similar place if you use some of the other browsers. And in fact, they're not only just in Chrome. Some people who've only used Chrome for a long time kind of think of them inherently as Chrome, but you can actually take some of the things we're learning in this presentation to all the other browsers. And they're actually nowadays standardizing even on a common web extension specification so that all the browsers are starting to agree on obviously one way to do things. Obviously IE is not there. In fact, IE was the first to do them, so some people think that Chrome is the first to have extensions, but actually every browser vendor has its own variation extension for a long time.

Well, how do you make one? That's really the most important thing that you probably care about. It turns out you already know how. You would think, considering it's native to the browser, that it'd be something based in C or some other complicated language, but actually all of the vendors nowadays just use plain HTML, CSS and JS to let you write your extensions, so you probably already know how to write one, but there is a specific format and a specific way to package them in terms of the functionality of how web extensions work to get it to work the way that you really intended to.

The next thing I immediately think about when I hear that, can you use HTML, CSS and JS, is what can I use all the tooling that I'm used to on the web? Yes, you can. While the end result has to be HTML, CSS, and JS, you can use React, Webpack, ES6 and all of that to help you build your extension, as long as the end result is something that looks like what the web extension specification expects. There aren't great tools like Create React App or Next that sort of do all this in a package way. You kind of have to find a boilerplate or rig it yourself, but there are quite a few decent boilerplates that I would recommend that you can use. This is actually a boilerplate I recommend that I've used for a couple of extensions that just does a great job of bringing in the most common things that you'll need, so I put a QR code up there as well as the URL, and if you miss it right now and you don't want to grab it, I will have another QR code at the very end that has a link to the slides where you can grab this other QR code or grab this URL.

So we're going to quickly do a show and tell. I know it's a bit dangerous to do things live in a talk, but that's, I like to look dangerous that I can say. We're just going to look at a fork of that boilerplate, pop it up, put it into the browser and you can see how easy this is to get live. So I've already cloned that particular project, forked it and cloned it down. This is essentially pretty much what you get from that boilerplate on its own. And we're just going to do NPM run. Actually they're using yarn here. So we'll do yarn dev. That's just running this script that essentially will take all of this stuff that you see, and it's going to pump it into this disk directory in a format that is expected by a browser. So if I jump over to Chrome, I've just created a new profile in Chrome and gone to Chrome colon slash slash extensions, which is how you manage your extensions. And then you have to turn on developer mode if you've never been in here before, which enables a couple of new options. Then you click on load unpacked.

2. Exploring Chrome Extension Components

Short description:

I'm already pre-navigated to the repo that I cloned and the disk directory, which is the output of the build process. It grabs the contents of the Chrome extension, including the pop-up file. By pinning the extension, you can see the React component inside. Changing the text triggers a hot reload.

And I'm already pre-navigated to the repo that I cloned and then the disk directory, which is the output of that build process. If I select that, it's grabbing the information from what she called a manifest.json, which you can go dig into later, but it's grabbing actually what is the contents of this Chrome extension? Now there's a file in there that says pop up, which is what shows up when you click on the extension. So if I come here just to be able to see it, I'll pin it. This is our extension that we're playing with. When I click on it, you can see that it has a pop up and it has some content in there. And that is just a React component right here. So if I change this part that says learn React to learn React now, you'll see when I come over it does essentially a hot reload and that says learn React now. So essentially you've gone from what looks like I've got standard React into a pop up in my browser window.

Check out more articles and videos

We constantly think of articles and videos that might spark Git people interest / skill us up or help building a stellar career

A Guide to React Rendering Behavior
React Advanced 2022React Advanced 2022
25 min
A Guide to React Rendering Behavior
Top Content
This transcription provides a brief guide to React rendering behavior. It explains the process of rendering, comparing new and old elements, and the importance of pure rendering without side effects. It also covers topics such as batching and double rendering, optimizing rendering and using context and Redux in React. Overall, it offers valuable insights for developers looking to understand and optimize React rendering.
Building Better Websites with Remix
React Summit Remote Edition 2021React Summit Remote Edition 2021
33 min
Building Better Websites with Remix
Top Content
Remix is a web framework built on React Router that focuses on web fundamentals, accessibility, performance, and flexibility. It delivers real HTML and SEO benefits, and allows for automatic updating of meta tags and styles. It provides features like login functionality, session management, and error handling. Remix is a server-rendered framework that can enhance sites with JavaScript but doesn't require it for basic functionality. It aims to create quality HTML-driven documents and is flexible for use with different web technologies and stacks.
React Compiler - Understanding Idiomatic React (React Forget)
React Advanced 2023React Advanced 2023
33 min
React Compiler - Understanding Idiomatic React (React Forget)
Top Content
Watch video: React Compiler - Understanding Idiomatic React (React Forget)
Joe Savona
Mofei Zhang
2 authors
The Talk discusses React Forget, a compiler built at Meta that aims to optimize client-side React development. It explores the use of memoization to improve performance and the vision of Forget to automatically determine dependencies at build time. Forget is named with an F-word pun and has the potential to optimize server builds and enable dead code elimination. The team plans to make Forget open-source and is focused on ensuring its quality before release.
Using useEffect Effectively
React Advanced 2022React Advanced 2022
30 min
Using useEffect Effectively
Top Content
Today's Talk explores the use of the useEffect hook in React development, covering topics such as fetching data, handling race conditions and cleanup, and optimizing performance. It also discusses the correct use of useEffect in React 18, the distinction between Activity Effects and Action Effects, and the potential misuse of useEffect. The Talk highlights the benefits of using useQuery or SWR for data fetching, the problems with using useEffect for initializing global singletons, and the use of state machines for handling effects. The speaker also recommends exploring the beta React docs and using tools like the stately.ai editor for visualizing state machines.
Routing in React 18 and Beyond
React Summit 2022React Summit 2022
20 min
Routing in React 18 and Beyond
Top Content
Routing in React 18 brings a native app-like user experience and allows applications to transition between different environments. React Router and Next.js have different approaches to routing, with React Router using component-based routing and Next.js using file system-based routing. React server components provide the primitives to address the disadvantages of multipage applications while maintaining the same user experience. Improving navigation and routing in React involves including loading UI, pre-rendering parts of the screen, and using server components for more performant experiences. Next.js and Remix are moving towards a converging solution by combining component-based routing with file system routing.
(Easier) Interactive Data Visualization in React
React Advanced 2021React Advanced 2021
27 min
(Easier) Interactive Data Visualization in React
Top Content
This Talk is about interactive data visualization in React using the Plot library. Plot is a high-level library that simplifies the process of visualizing data by providing key concepts and defaults for layout decisions. It can be integrated with React using hooks like useRef and useEffect. Plot allows for customization and supports features like sorting and adding additional marks. The Talk also discusses accessibility concerns, SSR support, and compares Plot to other libraries like D3 and Vega-Lite.

Workshops on related topic

React Performance Debugging Masterclass
React Summit 2023React Summit 2023
170 min
React Performance Debugging Masterclass
Top Content
Featured WorkshopFree
Ivan Akulov
Ivan Akulov
Ivan’s first attempts at performance debugging were chaotic. He would see a slow interaction, try a random optimization, see that it didn't help, and keep trying other optimizations until he found the right one (or gave up).
Back then, Ivan didn’t know how to use performance devtools well. He would do a recording in Chrome DevTools or React Profiler, poke around it, try clicking random things, and then close it in frustration a few minutes later. Now, Ivan knows exactly where and what to look for. And in this workshop, Ivan will teach you that too.
Here’s how this is going to work. We’ll take a slow app → debug it (using tools like Chrome DevTools, React Profiler, and why-did-you-render) → pinpoint the bottleneck → and then repeat, several times more. We won’t talk about the solutions (in 90% of the cases, it’s just the ol’ regular useMemo() or memo()). But we’ll talk about everything that comes before – and learn how to analyze any React performance problem, step by step.
(Note: This workshop is best suited for engineers who are already familiar with how useMemo() and memo() work – but want to get better at using the performance tools around React. Also, we’ll be covering interaction performance, not load speed, so you won’t hear a word about Lighthouse 🤐)
Concurrent Rendering Adventures in React 18
React Advanced 2021React Advanced 2021
132 min
Concurrent Rendering Adventures in React 18
Top Content
Featured WorkshopFree
Maurice de Beijer
Maurice de Beijer
With the release of React 18 we finally get the long awaited concurrent rendering. But how is that going to affect your application? What are the benefits of concurrent rendering in React? What do you need to do to switch to concurrent rendering when you upgrade to React 18? And what if you don’t want or can’t use concurrent rendering yet?

There are some behavior changes you need to be aware of! In this workshop we will cover all of those subjects and more.

Join me with your laptop in this interactive workshop. You will see how easy it is to switch to concurrent rendering in your React application. You will learn all about concurrent rendering, SuspenseList, the startTransition API and more.
React Hooks Tips Only the Pros Know
React Summit Remote Edition 2021React Summit Remote Edition 2021
177 min
React Hooks Tips Only the Pros Know
Top Content
Featured Workshop
Maurice de Beijer
Maurice de Beijer
The addition of the hooks API to React was quite a major change. Before hooks most components had to be class based. Now, with hooks, these are often much simpler functional components. Hooks can be really simple to use. Almost deceptively simple. Because there are still plenty of ways you can mess up with hooks. And it often turns out there are many ways where you can improve your components a better understanding of how each React hook can be used.You will learn all about the pros and cons of the various hooks. You will learn when to use useState() versus useReducer(). We will look at using useContext() efficiently. You will see when to use useLayoutEffect() and when useEffect() is better.
React, TypeScript, and TDD
React Advanced 2021React Advanced 2021
174 min
React, TypeScript, and TDD
Top Content
Featured WorkshopFree
Paul Everitt
Paul Everitt
ReactJS is wildly popular and thus wildly supported. TypeScript is increasingly popular, and thus increasingly supported.

The two together? Not as much. Given that they both change quickly, it's hard to find accurate learning materials.

React+TypeScript, with JetBrains IDEs? That three-part combination is the topic of this series. We'll show a little about a lot. Meaning, the key steps to getting productive, in the IDE, for React projects using TypeScript. Along the way we'll show test-driven development and emphasize tips-and-tricks in the IDE.
Web3 Workshop - Building Your First Dapp
React Advanced 2021React Advanced 2021
145 min
Web3 Workshop - Building Your First Dapp
Top Content
Featured WorkshopFree
Nader Dabit
Nader Dabit
In this workshop, you'll learn how to build your first full stack dapp on the Ethereum blockchain, reading and writing data to the network, and connecting a front end application to the contract you've deployed. By the end of the workshop, you'll understand how to set up a full stack development environment, run a local node, and interact with any smart contract using React, HardHat, and Ethers.js.
Designing Effective Tests With React Testing Library
React Summit 2023React Summit 2023
151 min
Designing Effective Tests With React Testing Library
Top Content
Featured Workshop
Josh Justice
Josh Justice
React Testing Library is a great framework for React component tests because there are a lot of questions it answers for you, so you don’t need to worry about those questions. But that doesn’t mean testing is easy. There are still a lot of questions you have to figure out for yourself: How many component tests should you write vs end-to-end tests or lower-level unit tests? How can you test a certain line of code that is tricky to test? And what in the world are you supposed to do about that persistent act() warning?
In this three-hour workshop we’ll introduce React Testing Library along with a mental model for how to think about designing your component tests. This mental model will help you see how to test each bit of logic, whether or not to mock dependencies, and will help improve the design of your components. You’ll walk away with the tools, techniques, and principles you need to implement low-cost, high-value component tests.
Table of contents- The different kinds of React application tests, and where component tests fit in- A mental model for thinking about the inputs and outputs of the components you test- Options for selecting DOM elements to verify and interact with them- The value of mocks and why they shouldn’t be avoided- The challenges with asynchrony in RTL tests and how to handle them
Prerequisites- Familiarity with building applications with React- Basic experience writing automated tests with Jest or another unit testing framework- You do not need any experience with React Testing Library- Machine setup: Node LTS, Yarn