/toggl-button

Toggl Button extension for Chrome and Firefox

Primary LanguageJavaScriptBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Toggl Button Build Status Chrome Extension Firefox Add-on

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.

Compatible services

Installing from the Web Store/Addons page

Chrome https://chrome.google.com/webstore/detail/toggl-button/oejgccbfbmkkpaidnkphaiaecficdnfn

Firefox https://addons.mozilla.org/en-US/firefox/addon/toggl-button-time-tracker/

Installing from Source

  • Clone the repository git clone git@github.com:toggl/toggl-button.git
  • Install Node.js and NPM https://nodejs.org/en/
  • Run npm install
  • Run npm start

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 inspect the distribution version, run npm run build. A zipped distribution can then be found in dist/.

Changelog

List of all the changes and added features can be found at http://toggl.github.io/toggl-button.

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.

See this article for reference where the start timer link is located in all the tools: Where can I find the Button?

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

Want to contribute? Great! Read up on our guidelines for contributing

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

When adding new integrations please use git squash and merge all your commits into one commit. This keeps the git log more compact and clear.

Don't know how to start? Just check out the user requested services that have not yet been implemented, pick one and start hacking.