Skip to content

Unofficial Toggl Button extension for Chrome and Firefox

License

Notifications You must be signed in to change notification settings

salomvary/button-for-toggl

 
 

Repository files navigation

Button for Toggl

Track time effortlessly.

Start and stop the timer from the web tools you use daily. Get the time-tracking out of the way and focus on real work.

⚠️ This is an unofficial fork of the Toggl Track Extension formerly known as Toggl Button

Unfortunately, Toggl Track extension got unceremoniously closed-sourced. The move was explained in this blog post:

The main browser extension code will be closed, which will allow us to work on the extensions’ features more easily as it will allow us to share code with other projects.

Fortunately the original extension has BSD-3-Clause license which allows this fork to exist.

Compatible services

Everything the official Toggl extension supports is supported by Button for Toggl as we use the same - still open source - code for integrations.

Installing from the Web Store/Addons page

This extension is currently not published anywhere in a ready-to-be-installed form. See how to install from source below.

Installing from Source

Then depending on your browser, continue with the following steps.

On Chrome:

  1. Navigate to chrome://extensions/ and enable "Developer Mode".
  2. Choose "Load unpacked extension..."
  3. Select the dist/chrome/ directory

Note that you will sometimes need to manually reload the unpacked extension, depending which files you're working on.

On Firefox:

  1. Navigate to about:debugging
  2. Choose Load Temporary Add-on
  3. Select the dist/firefox/manifest.json file

Note that in Firefox the add-on needs to be manually loaded again when the browser restarts.

If you want to install the extension permanently from source on Firefox, follow these steps:

  1. Install web-ext.
  2. Create an account at https://addons.mozilla.org.
  3. Get API key from https://addons.mozilla.org/en-US/developers/addon/api/key/.
  4. Run web-ext sign --api-key [JWT issuer] --api-secret [JWT secret] --source-dir dist/firefox --artifacts-dir dist in a terminal.
  5. Go to about:addons in Firefox.
  6. Click Install add-on from File under the ⚙ menu
  7. Choose the .xpi file under the dist folder of this project.

If you want to inspect the distribution version, run npm run build. A zipped distribution can then be found in dist/.

Using the Button

  1. Log in to your Toggl account from the extension popup.
  2. Navigate to your service and start your Toggl timer there.

Or start entry from the extension icon menu.

  1. To edit the running time entry:
  • Edit entry details from the post start popup that is shown right after you click the "Start timer" button.
  • Edit entry details from the extension icon menu by clicking the running time entry name.
  1. To stop the current running timer:
  • Press the button again.
  • Stop the entry from the extension icon menu.
  • Start another time entry inside your account.

Custom domains

If you use a setup, where one of the supported services is on a custom domain you can define the custom domains in settings "Permissions" tab.

Contributing

Just fork the project, make your changes and create a pull request.

Making a new release

npm version patch
git push --tags
web-ext sign --api-key [JWT issuer] --api-secret [JWT secret] --source-dir dist/firefox --artifacts-dir dist

About

Unofficial Toggl Button extension for Chrome and Firefox

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 61.2%
  • CSS 19.2%
  • TypeScript 13.8%
  • HTML 5.8%