# react_simple_persian_calendar

> A simple react persian calendar component

Latest version **1.2.1** (published 2020-07-29) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install react_simple_persian_calendar
pnpm add react_simple_persian_calendar
yarn add react_simple_persian_calendar
bun add react_simple_persian_calendar
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2020-07-29 |
| First published | 2020-07-19 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 81.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Abed Alavi |
| Maintainers | abedalavi |
| Keywords | persian calendar, react component, react persian calendar, simple persian calendar |

## Links

- npm: https://www.npmjs.com/package/react_simple_persian_calendar
- Repository: https://github.com/abedalavi/react_simple_persian_calendar
- Homepage: https://github.com/abedalavi/react_simple_persian_calendar#readme
- Issues: https://github.com/abedalavi/react_simple_persian_calendar/issues
- npm.io page: https://npm.io/package/react_simple_persian_calendar

## Dependencies (3)

- [react](https://npm.io/package/react.md) ^16.13.1
- [webpack](https://npm.io/package/webpack.md) ^4.43.0
- [jalaali-js](https://npm.io/package/jalaali-js.md) ^1.1.0

## Recent versions

- 1.2.1 (latest) — 2020-07-29
- 1.2.0 — 2020-07-29
- 1.1.0 — 2020-07-25
- 1.0.10 — 2020-07-21
- 1.0.9 — 2020-07-21
- 1.0.8 — 2020-07-21
- 1.0.7 — 2020-07-21
- 1.0.6 — 2020-07-21
- 1.0.5 — 2020-07-20
- 1.0.4 — 2020-07-19

## README

# react_simple_persian_calendar

Here is a persian datepicker(calendar) React component that you are free to use in your project.  
This component is compatible with Bootstrap 4.5.0.

![alt text](https://github.com/abedalavi/react_simple_persian_calendar/blob/master/public/sampleImage1.png?raw=true)
            

## Installation
The component can be installed via npm:

```shell
$ npm i react_simple_persian_calendar
```


## Usage
Here is an simple example of usage:

```js
import React from "react";
import PersianCalendar from "react_simple_persian_calendar";

function App() {
  const onChangePersianDatePicker = (date) => {
    console.log(date);
  };

  return <PersianCalendar 
            onChange={onChange}   
            currentTime={new Date("1987,01,22")}
          />;
}

export default App;
```

## Retrun type
This calendar return ISO 8601 standart time format (i.e, YYY-MM-DDTHH:mm:ss:sssZ).  
You can convert it to any Locale like the example below:

```js
new Date(date).toLocaleDateString('fa-IR'); // "۱۳۹۹/۴/۲۶"
```

If you click on 'پاک کردن تاریخ' to not have a date as return string, you will get **undefined** and you have to handle it like code below:
```js
if (date === undefined) console.log('No date has been chosen!');
```

## Props
| props        | type           | default value  | comment
| :-------------: |:-------------:| :-----:| :------:
| rtl      | boolean | true | If you have changed the direction of your web application to rtl in advance, you can use this prop to discard the repeated rtl.
| currentTime      | Date | new Date() | You can specify a current time with this prop. When the component is mounted, this date will be shown on the textbox. Make sure you send a ISO standard date like example above.
| currentPersianTime  *    | Date | undefined | You can specify a current time in persian date with this prop. When the component is mounted, this date will be shown on the textbox. Make sure you send a format such "۱۳۸۶/۱۲/۱۶".
|onChange|function| - |There is no default value. You must specify a function. When you click on a day, this function is executed with a parameter that show the date.

\* If you set both the **currentTime** and **currentPersianTime** simultaneously, the **currentPersianTime** override the value and will be consider as current time. See the Demo page for an example.

## contribution
You can fork the repository and contribute to the project, If you find any problem or bug, or if you have any suggestion. I check your pull request as soon as possible.

## Demo
You can follow the link below to see a demo of component.  
http://abedalavi.ir/ReactSimplePersianCalendarTest/

---
_Source: https://npm.io/package/react_simple_persian_calendar · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
