lion/packages/input-datepicker/stories/index.stories.mdx

import { Story, Meta, html } from '@open-wc/demoing-storybook';
import { loadDefaultFeedbackMessages, MinMaxDate, IsDateDisabled } from '@lion/validate';
import { formatDate } from '@lion/localize';

import '../lion-input-datepicker.js';

<Meta title="Forms/Input Datepicker" parameters={{ component: 'lion-input-datepicker' }} />

# Input Datepicker

`lion-input-datepicker` component is 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 the standard [lion-input-date](?path=/docs/form-component-input-date) for this.

<Story name="Default">
  {() => {
    loadDefaultFeedbackMessages();
    return html`
      <lion-input-datepicker label="Date" name="date"></lion-input-datepicker>
    `;
  }}
</Story>

```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 [lion-input-date](?path=/docs/form-component-input-date)
- Makes use of [lion-calendar](?path=/docs/calendar-standalone) inside the datepicker
- Makes use of [formatDate](?path=/docs/localize-dates--formatting)) for formatting and parsing.
- Option to overwrite locale to change the formatting and parsing
- Can make use of date specific [validators](?path=/docs/forms-validation-overview--page) with corresponding error messages in different languages
  - IsDate (default)
  - MinDate
  - MaxDate
  - MinMaxDate
  - IsDateDisabled

## How to use

### Installation

```sh
npm i --save @lion/input-datepicker
```

```js
import '@lion/input-datepicker/lion-input-datepicker.js';
```

## Examples

### Validation

Below are examples of different validators for dates.

<Story name="Validation">
  {html`
    <style>
      lion-input-datepicker {
        margin-bottom: 30px;
      }
    </style>
    <lion-input-datepicker
      label="MinMaxDate"
      .modelValue=${new Date('2018/05/30')}
      .validators=${[
        new MinMaxDate({ min: new Date('2018/05/24'), max: new Date('2018/06/24') }),
      ]}
    >
      <div slot="help-text">
        Enter a date between ${formatDate(new Date('2018/05/24'))} and
        ${formatDate(new Date('2018/06/24'))}.
      </div>
    </lion-input-datepicker>
    <lion-input-datepicker
      label="IsDateDisabled"
      help-text="You're not allowed to choose any 15th."
      .validators=${[new IsDateDisabled(d => d.getDate() === 15)]}
    ></lion-input-datepicker>
  `}
</Story>

```js
import { loadDefaultFeedbackMessages, MinMaxDate, IsDateDisabled } from '@lion/validate';
import { formatDate } from '@lion/localize';

loadDefaultFeedbackMessages();
```

```html
<lion-input-datepicker
  label="MinMaxDate"
  .modelValue=${new Date('2018/05/30')}
  .validators=${[
    new MinMaxDate({ min: new Date('2018/05/24'), max: new Date('2018/06/24') }),
  ]}
>
  <div slot="help-text">
    Enter a date between ${formatDate(new Date('2018/05/24'))} and
    ${formatDate(new Date('2018/06/24'))}.
  </div>
</lion-input-datepicker>
```

```html
<lion-input-datepicker
  label="IsDateDisabled"
  help-text="You're not allowed to choose any 15th."
  .validators=${[new IsDateDisabled(d => d.getDate() === 15)]}
></lion-input-datepicker>
```

### Calendar heading

You can modify the heading of the calendar with the `.calendarHeading` property or `calendar-heading` attribute for simple values.

By default, it will take the label value.

<Story name="Calendar heading">
  {html`
    <lion-input-datepicker
      label="Date"
      .calendarHeading="${'Custom heading'}"
      .modelValue=${new Date()}
    ></lion-input-datepicker>
  `}
</Story>

```html
<lion-input-datepicker
  label="Date"
  .calendarHeading="${'Custom heading'}"
  .modelValue=${new Date()}
></lion-input-datepicker>
```

### Disabled

You can disable datepicker inputs.

<Story name="Disabled">
  {html`
    <lion-input-datepicker label="Disabled" disabled></lion-input-datepicker>
  `}
</Story>

```html
<lion-input-datepicker label="Disabled" disabled></lion-input-datepicker>
```

### Read only

You can set datepicker inputs to `readonly`, which will prevent the user from opening the calendar popup.

<Story name="Read only">
  {html`
    <lion-input-datepicker label="Readonly" readonly .modelValue="${new Date()}">
    </lion-input-datepicker>
  `}
</Story>

```html
<lion-input-datepicker label="Readonly" readonly .modelValue="${new Date()}">
</lion-input-datepicker>
```