# vue-number-input-formatted

> A component to build an input with a format

Latest version **1.0.1** (published 2021-12-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-number-input-formatted
pnpm add vue-number-input-formatted
yarn add vue-number-input-formatted
bun add vue-number-input-formatted
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-12-04 |
| First published | 2021-12-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=12 |
| Dependencies | 0 |
| Unpacked size | 35.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Aarón Montes |
| Maintainers | ajomuch92 |
| Keywords | vue, number, input, formatter, input-formatted, vue-number |

## Links

- npm: https://www.npmjs.com/package/vue-number-input-formatted
- Repository: https://github.com/ajomuch92/vue-number-input-formatted
- Homepage: https://github.com/ajomuch92/vue-number-input-formatted#readme
- Issues: https://github.com/ajomuch92/vue-number-input-formatted/issues
- npm.io page: https://npm.io/package/vue-number-input-formatted

## Alternatives

- [random-seedable](https://npm.io/package/random-seedable.md) — 27.9K weekly downloads
- [n2words](https://npm.io/package/n2words.md) — 22.2K weekly downloads
- [@stdlib/math-base-special-factorialln](https://npm.io/package/@stdlib/math-base-special-factorialln.md) — 5.7K weekly downloads
- [@stdlib/math-base-special-abs2](https://npm.io/package/@stdlib/math-base-special-abs2.md) — 1.7K weekly downloads
- [commons-math-interpolation](https://npm.io/package/commons-math-interpolation.md) — 1.4K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2021-12-04
- 1.0.0 — 2021-12-04

## README

# vue-number-input-formatted
A component to build a simple input with a format and without any wrappers. 

<img src="https://raw.githubusercontent.com/ajomuch92/vue-number-input-formatted/main/gif/demo.gif" width="300" height="429"/>

### Install  

NPM:  
```bash
npm install --save vue-number-input-formatted
```

### Usage instructions  

```javascript
import VueNumberInputFormatted from 'vue-number-input-formatted';

export default {
  ...
  components: {
    VueNumberInputFormatted
  }
  ...
}
```

**Props**

|  Name | Type | Description   | Required   | Default   |
| ------------ | ------------ | ------------ | ------------ | ------------ |
| value  | Number, String| Props to set the value of the input. Ready to use with v-model directive | True   | ''   |
| positions  | Number | Number of decimal positions | False   | 2   |
| prefix  | String | String to set the symbol as input prefix | False   | '$'   |
| suffix  | String | String to set the symbol as input suffix | False   | ''   |
| separator  | String| String to set the thousands separator | False   | ','   |
| id  | String| Props to set the input id | False   | null   |
| disabled  | Boolean | Props to disabled/enabled the input | False   | false   |
| readonly  | Boolean | Props to set the input as readonly | False   | false   |
| form  | String| Name of the form to which the input belongs | False   | null   |
| maxlength  | Number | Max number of characters for the input | False   | null   |
| minlength  | Number | Min number of characters for the input | False   | null   |
| name  | Number | String to set the input name | False   | null   |
| pattern  | RegExp | Regular expression to validate the input value | False   | null   |
| placeholder  | String | String to set the input placeholder | False   | null   |
| padStart  | String | Number to set a specific length for the input | False   | 0   |
| padStartString  | String| String to fill the missing characters for a specified padStart prop | False   | ''   |
| allowEmpty  | Boolean | Value to indicate when the input could have an empty string  | False   | false   |


**Events**

|  Name |
| ------------ |
|  blur |
|  change |
|  focus |
|  keydown |
|  keypress |
|  keyup |
|  click |

**Methods**

|  Name |
| ------------ |
|  focus |

### License
MIT

---
_Source: https://npm.io/package/vue-number-input-formatted · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._