/stop-watch

Simple Stopwatch or Timer Component

Primary LanguageHTML

Stories in Ready

<stop-watch>

A stopwatch custom element using Polymer

Demo

Check it live!

Install

Install the component using Bower:

$ bower install polymer-stop-watch --save

Or download as ZIP.

Usage

  1. Import Web Components' polyfill:

    <script src="bower_components/webcomponentsjs/webcomponents.min.js"></script>
  2. Import Custom Element:

    <link rel="import" href="bower_components/stonelasley/dist/stop-watch.html">
  3. Start using it!

    <stop-watch></stop-watch>

Options

Attribute Options Default Description
mode string 'stopwatch' Sets the mode 'stopwatch' or 'timer'
autoStart bool false Starts counting as soon as the element has loaded.
offset number 0 Starts counting at this number. In Milliseconds.

Methods

Method Parameters Returns Description
unicorn() None. Nothing. Magic stuff appears.

Events

Event Description
onWatchStart Triggers when stopwatch is started
onWatchStop Triggers when stopwatch is stopped;
onTimerStart Triggers when timer is started
onTimerStop Triggers when timer is stopped
onReset Triggers when timer or stopwatch are reset;

Development

In order to run it locally you'll need to fetch some dependencies and a basic server setup.

  • Install Bower & Grunt:

    $ [sudo] npm install -g bower grunt-cli
  • Install local dependencies:

    $ bower install && npm install
  • To test your project, start the development server and open http://localhost:8000.

    $ grunt server
  • To build the distribution files before releasing a new version.

    $ grunt build
  • To provide a live demo, send everything to gh-pages branch.

    $ grunt deploy

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

History

For detailed changelog, check Releases.

License

MIT License