lion/packages/input-date/README.md
2019-07-24 15:20:19 +02:00

41 lines
972 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
```sh
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>
```