Documentation / @jalali-js/ui-react / RangePickerProps

Interface: RangePickerProps

Defined in: ui-react/src/RangePicker.tsx:33

Properties

className?

optional className?: string

Defined in: ui-react/src/RangePicker.tsx:55

---

defaultRange?

optional defaultRange?: DateRange

Defined in: ui-react/src/RangePicker.tsx:39

The initial range. Default: none (the picker opens with nothing selected).

---

displayFormat?

optional displayFormat?: FormatOptions

Defined in: ui-react/src/RangePicker.tsx:47

---

locale?

optional locale?: LocaleCode

Defined in: ui-react/src/RangePicker.tsx:37

Which language the picker's text reads in. Default: 'en'.

---

onChange?

optional onChange?: (value, range) => void

Defined in: ui-react/src/RangePicker.tsx:45

Called once both ends of the range are picked, with value (both ends shaped by valueFormat) and range (the raw CalendarDate pair). See @jalali-js/react's DatePicker for why these are two separate shapes.

Parameters

value

RangeStorageValue

range

DateRange

Returns

void

---

placeholder?

optional placeholder?: string

Defined in: ui-react/src/RangePicker.tsx:54

---

rules?

optional rules?: SelectionRules

Defined in: ui-react/src/RangePicker.tsx:53

Limits on what a person can select (see isDateSelectable() in jalali-js). Blocked days render disabled and reject selection. A candidate range that crosses a blocked day does not complete: the click starts a new range at the clicked day instead.

---

system?

optional system?: CalendarSystem

Defined in: ui-react/src/RangePicker.tsx:35

Which calendar system the picker displays and selects in. Default: 'jalali'.

---

valueFormat?

optional valueFormat?: ValueFormat

Defined in: ui-react/src/RangePicker.tsx:46