Documentation / @jalali-js/react / CalendarProps

Interface: CalendarProps

Defined in: react/src/Calendar.tsx:18

Properties

blockHolidays?

optional blockHolidays?: boolean

Defined in: react/src/Calendar.tsx:47

Also block holiday days through Phase 16 selection rules. Jalali system only. Uses @jalali-js/holidays.

---

className?

optional className?: string

Defined in: react/src/Calendar.tsx:53

---

holidayRegion?

optional holidayRegion?: HolidayRegion

Defined in: react/src/Calendar.tsx:52

Whose official holiday list to use. Default: 'IR' (Iran). Afghanistan and Tajikistan are planned region codes; they are not shipped yet.

---

initialDisplayedMonth?

optional initialDisplayedMonth?: object

Defined in: react/src/Calendar.tsx:27

The year/month the grid opens on. Default: value's month, or today's.

month

month: number

year

year: number

---

locale?

optional locale?: LocaleCode

Defined in: react/src/Calendar.tsx:22

Which language the month title and weekday headers read in. Default: 'en'.

---

onSelect?

optional onSelect?: (date) => void

Defined in: react/src/Calendar.tsx:25

Parameters

date

CalendarDate

Returns

void

---

quickNav?

optional quickNav?: boolean

Defined in: react/src/Calendar.tsx:32

Let a person click the month or year in the header to jump straight to a month grid or a year grid, instead of paging one month at a time. Default: true.

---

rules?

optional rules?: SelectionRules

Defined in: react/src/Calendar.tsx:37

Limits on what a person can select (see isDateSelectable() in jalali-js). Blocked days render disabled, with a data-disabled attribute, and reject selection.

---

showHolidays?

optional showHolidays?: boolean

Defined in: react/src/Calendar.tsx:42

Mark official holidays with a data-holiday attribute. Jalali system only. Uses @jalali-js/holidays. Default list is Iran (holidayRegion: 'IR').

---

system?

optional system?: CalendarSystem

Defined in: react/src/Calendar.tsx:20

Which calendar system to display. Default: 'jalali'.

---

value?

optional value?: CalendarDate | null

Defined in: react/src/Calendar.tsx:24

The selected date, or null for none.