kudos

1.0.0 • Public • Published

kudos npmjs.com The MIT License

kudos done right - unopinionated, made simple, so simple it hurts!

code climate standard code style travis build status coverage status dependency status

Install

npm i kudos --save
npm test

Features

  • minimal, yet simple to use - demo in jsbin
  • no jQuery, zero dependencies (only event emitter) - just 3.5kb minified
  • works on every browser, should even works on IE8
  • plays well with Browserify and BrowserifyCDN
  • available on CDNs - JSDelivr.com, BrowserifyCDN, RawGit and CDNjs.com

In the browser

Just include the script tag with path to dist/kudos.standalone.min.js

<script scr="https://cdn.rawgit.com/tunnckoCore/kudos/master/dist/kudos.standalone.min.js"></script>

Usage

For more use-cases see the tests

var Kudos = require('kudos')
 
var kudos = new Kudos({
  element: document.querySelector('#kudos')
  delay: 1000
})
 
kudos
  .on('kudo:in', function () {
    // you can start styling your kudo
    // change classes and etc
    console.log('in')
    // `.active` class is set by default
  })
  .on('kudo:out', function () {
    console.log('out')
  })
  .once('kudo:complete', function () {
    // `.complete` class is set by default
    console.log('complete')
  })

Related

  • apidocs-cli: Command-line app for generating API docs from code comments. Can be used as API of helper-apidocs package.
  • dush: Minimalist 1.5kb event delegation for the browser (IE8+) and nodejs.
  • gitclone-cli: Git clone github repository with pattern like user/repo#branch
  • minigrid: Minimal 2kb zero dependency cascading grid layout
  • minimist-plugins: Simple wrapper to make minimist pluggable. ~20 sloc.

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
But before doing anything, please read the CONTRIBUTING.md guidelines.

Charlike Make Reagent new message to charlike freenode #charlike

tunnckocore.tk keybase tunnckocore tunnckoCore npm tunnckoCore twitter tunnckoCore github

Package Sidebar

Install

npm i kudos

Weekly Downloads

1

Version

1.0.0

License

MIT

Last publish

Collaborators

  • vanchoy
  • tunnckocore