jesseditson / react-trip-date

It's a Date/Range picker for ReactJS.

Home Page:https://killthejs.com/react-trip-date/?path=/story/range-picker-component--all-props

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

npm downloads

React-Trip-Date

A date/range picker for your React applications.

  • Multiple Month, Auto Responsive, Number Of Selectable Days
  • Range Picker, Theme base
  • Support Jalali & Gregorian
  • Use Day.js (2KB immutable date and NO moment.js is needed)

Demo

Online demo is also available!

OR

To run that demo on your own computer:

  • git clone https://github.com/samsam-ahmadi/react-trip-date.git
  • cd react-trip-date
  • yarn && yarn storybook
  • Visit http://localhost:9009/

Getting started

Compatibility

Your project needs to use React 16 or later. If you use older version of React, please refer to the table below to find suitable React-Trip-Date version.

Installation

npm install react-trip-date

yarn add react-trip-date

User guide

DatePicker

Props

Prop name Description Default value Example values
onChange this function return an array of days n/a (days:string[]) => console.log('selected days',days)
selectedDays the initial array of days [] ['2019-10-01','2019-11-06']
jalali choice jalali or gregorian calendar false false/true
numberOfMonths number of months you need to show 1 7
numberOfSelectableDays number of days you need 0/Infiniti 3
disabledDays the disabled days that you don't want clickable to choice [] ['2019-11-04',2019-12-14]
autoResponsive makes your calendar responsive but you can handle it by your self by change the numberOfMonths true false/true
disabledBeforeToday disabled days before today false true/false
disabled disabled calendar false true/false
components update header title, week title and day component undefined {days?: ElementType<{day:string;jalali: boolean;}>;header?: {format?: string;};titleOfWeek?:{titles?: string[];wrapper?: ElementType<{ jalali: boolean }>;};}

RangePicker

Props

Prop name Description Default value Example values
onChange this function return an array of days n/a (days:string[]) => console.log('selected days',days)
selectedDays the initial range date {from:'',to:''} {from:'2019-12-12',to:'2019-12-18'}
jalali choice jalali or gregorian calendar false false/true
numberOfMonths number of months you need to show 1 7
disabledDays the disabled days that you don't want clickable to choice [] ['2019-11-04',2019-12-14]
autoResponsive makes your calendar responsive but you can handle it by your self by change the numberOfMonths true false/true
disabledBeforeToday disabled days before today false true/false
disabled disabled calendar false true/false
components update header title, week title and day component undefined {days?: ElementType<{day:string;jalali: boolean;}>;header?: {format?: string;};titleOfWeek?:{titles?: string[];wrapper?: ElementType<{ jalali: boolean }>;};}

special thanks to:

Contributors

feel free to contribute.

License

The GNU GPLv3 License.

About

It's a Date/Range picker for ReactJS.

https://killthejs.com/react-trip-date/?path=/story/range-picker-component--all-props

License:GNU General Public License v3.0


Languages

Language:TypeScript 97.6%Language:JavaScript 2.4%