Skip to content

Latest commit

 

History

History
88 lines (73 loc) · 3.16 KB

README.md

File metadata and controls

88 lines (73 loc) · 3.16 KB

Number Input for AngularJS

DEMO

A number-only input element directive for AngularJS.

Status

September 27th, 2017: Support for this project has been discontinued. Use at your own risk.

Requirements

Installation

  1. Include dist/number-input.min.js
  2. Use the <number-input></number-input> tag

Example

<number-input ng-model="model" 
			  max="24" 
			  min="0" 
			  step="1" 
			  start="10" 
			  hint="0 to 24 hours" 
			  hideHint="false" 
			  disableDecimal="true" 
			  decimalPlaces="0" 
			  prefix="*" 
			  postfix="%"></number-input>

or

opts = {
  max: 24,
  min: 0,
  step: 1,
  start: 10,
  hint: "0 to 24 hours",
  hideHint: false,
  disableDecimal: true,
  decimalPlaces: 0,
  prefix: "*",
  postfix: "%"
};
<number-input ng-model="model" options="opts"></number-input>

Options

Field Data type Default Required Attribute/Option Description
ngModel Number None Yes Attribute AngularJS model
start Number 0 No Both Initial input value
min Number -∞ No Both Minimum input value
max Number No Both Maximum input value
step Number 1 No Both How much to increase/decrease by when the +/- buttons are pressed
hint String Depends on min/max values No Both Small text that appears below the input element
hideHint Boolean false No Both Hides the hint
disableDecimal Boolean false No Both Disables decimals from being typed
decimalPlaces Number # of decimals in step No Both Number of decimal places shown
prefix String None No Both An input prefix (i.e. $)
postfix String None No Both An input postfix (i.e. %)
options Object Empty No Both Options can be used instead of element attributes (attributes have priority)

Testing Locally

To test locally without using the minified version, have npm installed and use the following commands:

npm install http-server -g
http-server Workplace/angular.number-input/

Contributing

Feel free to send a pull request if you can improve something, or create an issue if you have any questions or problems.

License

Licensed under GNU GPL v2.

Enjoy!