Skip to content

Latest commit

 

History

History
131 lines (85 loc) · 2.6 KB

number.md

File metadata and controls

131 lines (85 loc) · 2.6 KB

Number

A jQuery plugin for cross browser number inputs.

Using Number

Main

number.js
number.css

Dependencies

jQuery
core.js

Basic

Number will convert an input into a customizable step interface:

$("input[type=number]").number();
<input type="number" pattern="[0-9]*">

Limits

Number will automatically detect the minimum, maximum and increment values based on the min, max and step attributes:

<input type="number" min="2" max="20" step="2" pattern="[0-9]*">

Options

Set instance options by passing a valid object at initialization, or to the public defaults method. Custom options for a specific instance can also be set by attaching a data-number-options attribute to the target elment. This attribute should contain the properly formatted JSON object representing the custom options.

Name Type Default Description
customClass string '' Class applied to instance
labels.up string 'Up' Up arrow label
labels.down string 'Down' Down arrow label
theme string "fs-light" Theme class name

## Methods

Methods are publicly available to all active instances, unless otherwise stated.

defaults

Extends plugin default settings; effects instances created hereafter.

$.number("defaults", { ... });

Parameters

Name Type Default Description
options object {} New plugin defaults

destroy

Removes plugin instance.

$(".target").number("destroy");

disable

Disables target instance

$(".target").number("disable");

enable

Enables target instance

$(".target").number("enable");

update

Updates instance.

$(".target").number("update");

## CSS
Class Type Description
.fs-number-element element Target elmement
.fs-number element Base widget class
.fs-number.fs-number-disabled modifier Indicates disabled state
.fs-number-arrow element Arrow elmement
.fs-number-arrow:after element Arrow icon
.fs-number-arrow.fs-number-up modifier Indicates up state
.fs-number-arrow.fs-number-down modifier Indicates up state