History

Joshua Lochner dac6f4b073 Improve example browser extension template (#325 ) Removes unnecessary complexity		2023-09-23 03:34:10 +02:00
..
build	Add example browser extension project	2023-04-25 20:34:09 +02:00
public	Improve browser extension sample/template (#196 )	2023-08-01 14:23:21 +02:00
src	Improve example browser extension template (#325 )	2023-09-23 03:34:10 +02:00
.gitignore	Add example browser extension project	2023-04-25 20:34:09 +02:00
README.md	Improve browser extension sample/template (#196 )	2023-08-01 14:23:21 +02:00
package.json	Improve browser extension sample/template (#196 )	2023-08-01 14:23:21 +02:00
webpack.config.js	Improve browser extension sample/template (#196 )	2023-08-01 14:23:21 +02:00

README.md

Transformers.js - Sample browser extension

An example project to show how to run 🤗 Transformers in a browser extension. Although we only provide instructions for running in Chrome, it should be similar for other browsers.

Getting Started

Clone the repo and enter the project directory:

git clone https://github.com/xenova/transformers.js.git
cd transformers.js/examples/extension/

Install the necessary dependencies:
```
npm install 
```
Build the project:
```
npm run build 
```
Add the extension to your browser. To do this, go to chrome://extensions/, enable developer mode (top right), and click "Load unpacked". Select the build directory from the dialog which appears and click "Select Folder".
That's it! You should now be able to open the extenion's popup and use the model in your browser!

Editing the template

We recommend running npm run dev while editing the template as it will rebuild the project when changes are made.

All source code can be found in the ./src/ directory:

background.js (service worker) - handles all the requests from the UI, does processing in the background, then returns the result. You will need to reload the extension (by visiting chrome://extensions/ and clicking the refresh button) after editing this file for changes to be visible in the extension.
content.js (content script) - contains the code which is injected into every page the user visits. You can use the sendMessage api to make requests to the background script. Similarly, you will need to reload the extension after editing this file for changes to be visible in the extension.
popup.html, popup.css, popup.js (toolbar action) - contains the code for the popup which is visible to the user when they click the extension's icon from the extensions bar. For development, we recommend opening the popup.html file in its own tab by visiting chrome-extension://<ext_id>/popup.html (remember to replace <ext_id> with the extension's ID). You will need to refresh the page while you develop to see the changes you make.