@getable/button

3.4.4 • Public • Published

button NPM version Build Status Dependency Status

button ui piece

Table of Contents generated with DocToc

Install

npm i -S @getable/button

Usage

var Button = require('@getable/button')

new Button(
    classes: ['button-cta']
  , text: 'Click me'
  , onClick: function(){
      window.alert('You\'ve won $500! Click here to claim your prize!')
    }
)

Options

<Array> classes

An array of classes to be applied to the button. The base class button is always applied by default.

<String> text

The text label that shows on the button.

<Function> onClick

The function that gets called when the button is clicked.

Methods

None yet

Events

None yet

Tests

Tests are in tape.

  • npm test will run the tests in a browser
  • npm run tdd will run the tests in a browser on every file change.

Developing

To publish, run npm run release -- [{patch,minor,major}]

NOTE: you might need to sudo ln -s /usr/local/bin/node /usr/bin/node to ensure node is in your path for the git hooks to work

Requirements

  • npm > 2.0.0 So that passing args to a npm script will work. npm i -g npm
  • git > 1.8.3 So that git push --follow-tags will work. brew install git

License

Artistic 2.0 © Cristi Scheye

Package Sidebar

Install

npm i @getable/button

Weekly Downloads

1

Version

3.4.4

License

Artistic-2.0

Last publish

Collaborators

  • getable