Giter Club home page Giter Club logo

button's Introduction

button

A UI on/off button component for use with component. Bind to an input field and turn it into a sleek button.

Tested in Chrome, Firefox, Safari, Opera, IE9+

Styles inspired by Hugh Giraudel

Check out the related dial component

View Example

Installation

component install jsantell/button

API

new Button(inputEl, [on])

Create a new button instance, linked to inputEl. On status is determined by the checked state of the input, or you may pass in a boolean on to set the initial state. On instantiation, the button is rendered, original checkbox hidden, and events bound.

var Button = require('button');
var input = document.getElementById('inputEl');
var button = new Button(input, true);

Button#set(val)

Sets button to either on or off based off of val's truthiness.

Button#render()

Reconstructs the button's el property containing the button element. Already called during instantiation.

Button#bind()

Binds events necessary for the button on the button element, as well as the input element.

Button#unbind()

Unbinds the events related to the button.

Button#hideInput()

Hides the corresponding input field. Already called on instantiation.

Button#showInput()

Displays the corresponding input field. Called on destroy, or call it manually to display the element.

Button#destroy()

Destroys the button element, reveals original input element and unbinds button events

Events

Button inherits from Emitter, so all emitter methods apply. By default, only a change event is fired when the button's value changes, which can be hooked into via:

var button = new Button(input);
button.on('change', function (val) {
  console.log('Is button on? ' + val);
});

button's People

Contributors

jsantell avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.