lion/packages/input-amount
Joren Broekema 07f04ddd2d
Merge pull request #279 from ing-bank/fix/a11yMinus
Fix a11y - use proper minus sign unicode that most SRs understand
2019-09-20 01:21:26 -07:00
..
src fix(input-amount): pass string instead of object in parser 2019-09-02 09:32:30 +02:00
stories fix(input-amount): support negative numbers 2019-06-25 10:54:01 +02:00
test fix(input-amount): use minus sign unicode instead of hypen-minus 2019-09-20 10:13:06 +02:00
CHANGELOG.md chore: release new versions 2019-09-19 14:40:27 +00: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 chore: release new versions 2019-09-19 14:40:27 +00:00
README.md chore: fix style of markdown files 2019-07-24 15:20:19 +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>