3.0.3 • Published 10 months ago

iranian-date-picker v3.0.3

Weekly downloads
-
License
ISC
Repository
github
Last release
10 months ago

iranian-date-picker

iranian-date-picker is a lightweight React component for creating a Jalali/Georgian datepicker. There is also a range datepicker and timepicker in iranian-date-picker. The module can also be customized to match the appearance of your designs.

Install

with npm

$ npm i iranian-date-picker

with yarn

$ yarn add iranian-date-picker

Props

Date Picker and Calendar

propstypedefault
defaultValuetimestamp | Date | Dayjsundefined
weekendnumber[]undefined
roundstring one of thin | x1 | x2 | x3 | x4thin
accentColorstring#0D59F2
localestring one of fa | enfa
directionstring one of rtl | ltrrtl
onChangefunctionundefined
rangebooleanfalse
fromtimestamp | Date | Dayjsundefined
totimestamp | Date | Dayjsundefined
showbooleanfalse
inputClassstringnull
inputAttributesobject of InputHTMLAttributesnull
classNamestringnull
customShowDateFormatstring ex: YYYY MMMM DD or DD/MM etc.undefined
positionright | left | centerright

Calendar Provider

propstypedefault
roundstring one of thin | x1 | x2 | x3 | x4thin
accentColorstring#0D59F2
localestring one of fa | enfa
directionstring one of rtl | ltrrtl
childrenReactNodenull

Time Picker

propstypedefault
defaultValuetimestamp | Date | DayjsDate
roundstring one of thin | x1 | x2 | x3 | x4thin
accentColorstring#0D59F2
localestring one of fa | enfa
clockTimenumber one of 12 | 2424
inputClassstringnull
inputAttributesobject of InputHTMLAttributesnull

Usages

Date picker

import { DatePicker } from 'iranian-date-picker'

function App() {
  return <DatePicker onChange={(e) => console.log(e.value)} />
}

Range date picker

import { DatePicker } from 'iranian-date-picker'

function App() {
  return <DatePicker onChange={(e) => console.log(e.from, e.to)} range />
}

Calendar

import { Calendar, CalendarProvider } from 'iranian-date-picker'

function App() {
  const [calendarValue, setCalendarValue] = useState(new Date())

  return (
    <CalendarProvider>
      <Calendar
        defaultValue={calendarValue}
        onChange={(e) => setCalendarValue(new Date(e.value))}
      />
    </CalendarProvider>
  )
}

Time picker

import { TimePicker } from 'iranian-date-picker'

function App() {
  return (
    <TimePicker
      onChange={(e) => console.log(e.hour, e.minute, e.timeConvention)}
    />
  )
}

License

MIT License

3.0.3

10 months ago

3.0.2

10 months ago

3.0.1

10 months ago

3.0.0

10 months ago

2.1.1

10 months ago