54 lines
1.6 KiB
Markdown
54 lines
1.6 KiB
Markdown
---
|
|
title: 'Input Datepicker: Overview'
|
|
parts:
|
|
- Input Datepicker
|
|
- Overview
|
|
eleventyNavigation:
|
|
key: 'Input Datepicker: Overview'
|
|
order: 10
|
|
parent: Input Datepicker
|
|
title: Overview
|
|
---
|
|
|
|
# Input Datepicker: Overview
|
|
|
|
A web component based on the date text input field. Its purpose is to provide a way for users to fill in a date with a datepicker.
|
|
For an input field with a big range, such as `birthday-input`, a datepicker is not the best choice due to the high variance between possible inputs.
|
|
We encourage using our standard [input-date](../input-date/overview.md) for this.
|
|
|
|
```js script
|
|
import { html } from '@mdjs/mdjs-preview';
|
|
import '@lion/ui/define/lion-input-datepicker.js';
|
|
```
|
|
|
|
```js preview-story
|
|
export const main = () => {
|
|
return html` <lion-input-datepicker label="Date" name="date"></lion-input-datepicker> `;
|
|
};
|
|
```
|
|
|
|
## Features
|
|
|
|
- Input field with a datepicker to help to choose a date
|
|
- Based on our [input-date](../input-date/overview.md)
|
|
- Makes use of our [calendar](../calendar/overview.md) inside the datepicker
|
|
- Makes use of [formatDate](../../fundamentals/systems/localize/dates.md) for formatting and parsing.
|
|
- Option to overwrite locale to change the formatting and parsing
|
|
- Can make use of date specific [validators](../../fundamentals/systems/form/validate.md) with corresponding error messages in different languages
|
|
- IsDate (default)
|
|
- MinDate
|
|
- MaxDate
|
|
- MinMaxDate
|
|
- IsDateDisabled
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm i --save @lion/ui
|
|
```
|
|
|
|
```js
|
|
import { LionInputDatepicker } from '@lion/ui/input-datepicker.js';
|
|
// or
|
|
import '@lion/ui/define/lion-input-datepicker.js';
|
|
```
|