lion/packages/input-amount
2019-04-26 15:00:08 +02:00
..
src feat: release inital public lion version 2019-04-26 10:37:57 +02:00
stories feat: release inital public lion version 2019-04-26 10:37:57 +02:00
test feat: release inital public lion version 2019-04-26 10:37:57 +02:00
CHANGELOG.md chore: release new versions 2019-04-26 14:48:41 +02:00
index.js feat: release inital public lion version 2019-04-26 10:37:57 +02:00
lion-input-amount.js feat: release inital public lion version 2019-04-26 10:37:57 +02:00
package.json fix: add missing files to npm packages 2019-04-26 15:00:08 +02:00
README.md feat: release inital public lion version 2019-04-26 10:37:57 +02:00

Input Amount

lion-input-amount component is based on the generic text input field. Its purpose is to provide a way for users to fill in an amount.

Features

  • based on lion-input
  • makes use of formatNumber for formatting and parsing.
  • option to show currency as a suffix
  • option to override locale to change the formatting and parsing
  • option to provide additional format options overrides
  • default label in different languages
  • can make use of number specific validators with corresponding error messages in different languages
    • isNumber (default)
    • minNumber
    • maxNumber
    • minMaxNumber

How to use

Installation

npm i --save @lion/input-amount
import '@lion/input-amount/lion-input-amount.js';

// validator import example
import { minNumberValidator } from '@lion/validate';

Example

<lion-input-amount
  name="amount"
  currency="USD"
  .errorValidators="${[['required'], minNumberValidator(100)]}"
></lion-input-amount>