Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jayeshlab/vue-numeric-input

Number input component with controls
https://github.com/jayeshlab/vue-numeric-input

input numeric vue vue-component vue-numeric-input vuejs

Last synced: 3 days ago
JSON representation

Number input component with controls

Awesome Lists containing this project

README

        

# Vue Numeric Input

[![npm](https://img.shields.io/npm/v/vue-numeric-input.svg?style=flat-square)](https://www.npmjs.com/package/vue-numeric-input)
[![npm](https://img.shields.io/npm/dt/vue-numeric-input.svg?style=flat-square)](https://www.npmjs.com/package/vue-numeric-input)
[![Build Status](https://api.travis-ci.com/JayeshLab/vue3-resize-text.svg?branch=master)](https://app.travis-ci.com/github/JayeshLab/vue-numeric-input)
[![codecov](https://codecov.io/gh/JayeshLab/vue-numeric-input/branch/master/graph/badge.svg?token=a4re2w3cGy)](https://codecov.io/gh/JayeshLab/vue-numeric-input)
[![npm](https://img.shields.io/npm/l/vue-numeric-input.svg?style=flat-square)](http://opensource.org/licenses/MIT)

Number input component based on Vue that is a replacement of native input number with optional control.

![vue-numeric-input](https://user-images.githubusercontent.com/36194663/44717643-33e4ea00-aadb-11e8-82bf-e1fdeeea3bb5.gif)

[Live Demo & Doc](https://jayeshlab.github.io/vue-numeric-input/)

### Installation

Install via NPM

`$ npm install vue-numeric-input --save`

Install via CDN

```html

```

#### Global

Register VueNumericInput globally:

```javascript
import Vue from 'Vue';
import VueNumericInput from 'vue-numeric-input';

Vue.use(VueNumericInput)
```

#### Local

Include the VueNumericInput directly into your component using import:

```javascript
import VueNumericInput from 'vue-numeric-input'

export default {
components: {
VueNumericInput
}
}
```
### Usage

#### Basic usage

```html



export default {
data() {
return {
value: 1,
};
},
};

```

#### PROPS:

| Name | Description | Type | Default | Options |
| ----------- | --------------- | ------------ | ------------ | ------------ |
| name | Component name | String | - | - |
| value | Binding value | Number | - | - |
| placeholder | Input placeholder | String | - | - |
| min | Minimum allowed value | Number | -Infinity | - |
| max | Maximum allowed value | Number | Infinity | - |
| step | Incremental Step | Number | 1 | - |
| align | Alignment of Numeric Value | String | left | left, center, right |
| width | Component Width | String | 150px | width in px, em, rem etc e.g. ‘20px’ |
| size | Component Size | String | normal | size value can be 'small', 'normal', 'large' |
| precision | Number of decimals | Number | 0 | Integer value|
| controls | Enable/Disable Controls | Boolean | true | true/false|
| controlsType | Controls Type | String | plusminus | plusminus/updown|
| autofocus | Autofocus on Page Load | Boolean | false | true/false|
| readonly | Is Readonly | Boolean | false | true/false|
| disabled | Is Disabled | Boolean | false | true/false|
| isinput | enable/disable keyboard input of number | Boolean | false | true/false|
| mousewheel | Enable increment/decrement with mousewheel event | Boolean | false | true/false|
| className | Css Class for Input Component | String | - | css class name |

#### EVENTS:

Event Name | Description | Parameters
-----------|--------------------|--------------
input | triggers when input| (newValue)
change | triggers when the value changes| (newValue)
blur | triggers when Input blurs| (event: Event)
focus | triggers when Input focus| (event: Event)

#### METHODS:

Method | Description | Parameters
---|--- | ----
focus | focus the Input component| -
blur | blur the Input component| -

Inspired by [react-numeric-input](https://github.com/vlad-ignatov/react-numeric-input)

## License

MIT