lion/packages/input-date/README.md
Thomas Allmer ec8da8f12c feat: release inital public lion version
Co-authored-by: Mikhail Bashkirov <mikhail.bashkirov@ing.com>
Co-authored-by: Thijs Louisse <thijs.louisse@ing.com>
Co-authored-by: Joren Broekema <joren.broekema@ing.com>
Co-authored-by: Gerjan van Geest <gerjan.van.geest@ing.com>
Co-authored-by: Erik Kroes <erik.kroes@ing.com>
Co-authored-by: Lars den Bakker <lars.den.bakker@ing.com>
2019-04-26 10:37:57 +02:00

40 lines
969 B
Markdown

# Input Date
[//]: # (AUTO INSERT HEADER PREPUBLISH)
`lion-input-date` component is based on the generic text input field. Its purpose is to provide a way for users to fill in a date.
## Features
- based on [lion-input](../input)
- makes use of [formatDate](../localize/docs/date.md) for formatting and parsing.
- option to overwrite locale to change the formatting and parsing
- default label in different languages
- can make use of date specific [validators](../validate/docs/DefaultValidators.md) with corresponding error messages in different languages
- isDate (default)
- minDate
- maxDate
- minMaxDate
## How to use
### Installation
```
npm i --save @lion/input-date
```
```js
import '@lion/input-date/lion-input-date.js';
// validator import example
import { minDateValidator } from '@lion/validate';
```
### Example
```html
<lion-input-date
name="date"
.errorValidators="${[['required'], minDateValidator(100)]}"
></lion-input-date>
```