KyleGough / bookmark-labeller-extension

Label bookmarks with your favourite emojis

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Bookmark Labeller

Install Badge

Bookmark Labeller is a lightweight and minimalistic Firefox browser extension that allows you to label bookmarks with your favourite emojis. The extension comes with default emojis which can be customised and interchanged. Use the action button to select emojis or right-click bookmarks to add emojis with the context menu.

Table of Contents

Extension Popup

Install

Install Badge

Usage

Toggle emoji label for the current active URL

Note: This option is only available if the current active tab is bookmarked, otherwise the option to toggle emojis is disabled.

  1. Open the popup by clicking the extension icon.
  2. Click on an emoji to add it as a label to the currently active bookmark.

Customising your favourite emojis

  1. Open the popup by clicking the extension icon.
  2. Switching to 'Edit' mode by clicking the 'Edit' button in the popup.
  3. Click on an emoji to enter the text input.
  4. Paste/type your desired emoji.
  5. Click on the 'Save' button to save your changes, this will persist your favourites across sessions, and windows.

Toggle emoji label for any bookmark

  1. Right click any bookmark in the bookmarks bar to bring up the context menu.
  2. Find the option titled 'Bookmark Labeller'.
  3. Select from the different emojis to toggle the emoji for the selected bookmark.

Permissions

  • bookmarks - query and edit the title of bookmarks.
  • contextMenus - toggle labels for bookmarks via the right click context menu.
  • storage - persist user set emojis.
  • tabs - query active tab to link corresponding bookmark.

Development

Clone the repository, install all the dev dependencies and then use the start command to prompt Parcel to start the development server. The development server watches for file changes and updates the dist directory.

npm install
npm start
# start --> parcel watch manifest.json --host localhost --config @parcel/config-webextension

In another terminal use web-ext to load the extension temporarily in the browser. Any file changes will be picked up and will reload the extension automatically.

web-ext run

Build

To build the project and make it ready for production, we use Parcel, a build tool requiring minimal configuration. First run the build command to output the bundled and minified code, and then use the web-ext tool to build and package the dist directory into a distributable .zip file.

npm run build
# build --> parcel build manifest.json --config @parcel/config-webextension
web-ext build -s dist

Screenshots

popup-custom

Example: Custom emojis


popup-selected

Example: Bookmark with labels selected


bookmark-folder

Example: Label your recipes bookmark folder to indicate favourites and completed dishes


context-menu

Context Menu: Label bookmarks right the right click context menu

About

Label bookmarks with your favourite emojis

License:MIT License


Languages

Language:JavaScript 67.4%Language:CSS 19.0%Language:HTML 13.7%