@alireza-ab/vue3-persian-datepicker/README.md

A datepicker component for select date (vue 3)

# Vue3 Persian Datepicker

A datepicker component for select persian date.
It's very customizable and easily for use.

[![npm version](https://img.shields.io/npm/v/@alireza-ab/vue3-persian-datepicker)](https://www.npmjs.com/package/@alireza-ab/vue3-persian-datepicker)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

If you want to use this component with vue2, visit [vue-persian-datepicker](https://github.com/alireza-ab/vue-persian-datepicker)

## Features

- **nuxt** support
- **single and range selection**
- select **date** and **time**
- select with **keyboard**
- customizable **style**
- localization

## Documentation

For full documentation and examples, visit [https://alireza-ab.ir/datepicker](https://alireza-ab.ir/datepicker)

![select date with vue persian datepicker](https://alireza-ab.ir/images/GIFs/selectWithArrow.gif)

### Install

```shell
pnpm add @alireza-ab/vue3-persian-datepicker
```

or

```shell
npm i @alireza-ab/vue3-persian-datepicker
```

### Usage

```js
import DatePicker from '@alireza-ab/vue3-persian-datepicker';

Vue.createApp({
  components: { DatePicker },
}).mount('#app');
```

```html
<DatePicker />
```

## License

Vue Persian Datepicker is available under the [MIT](https://opensource.org/licenses/MIT) license.