InterfaceDatePickerProps

Admin Docs

---

Interface: InterfaceDatePickerProps

Defined in: src/types/shared-components/DatePicker/interface.ts:7

Component Props for DatePicker

Properties

className?

optional className: string

Defined in: src/types/shared-components/DatePicker/interface.ts:41

Additional CSS class name to be applied to the root element

---

data-cy?

optional data-cy: string

Defined in: src/types/shared-components/DatePicker/interface.ts:45

Test ID for Cypress testing purposes

---

data-testid?

optional data-testid: string

Defined in: src/types/shared-components/DatePicker/interface.ts:43

Test ID for testing purposes, applied to the underlying input

---

disabled?

optional disabled: boolean

Defined in: src/types/shared-components/DatePicker/interface.ts:31

Whether the date picker is disabled

---

error?

optional error: string

Defined in: src/types/shared-components/DatePicker/interface.ts:35

Error message to display when validation fails

---

format?

optional format: string

Defined in: src/types/shared-components/DatePicker/interface.ts:51

Format of the date displayed in the input (e.g., "MM/DD/YYYY", "YYYY-MM-DD")

---

helpText?

optional helpText: string

Defined in: src/types/shared-components/DatePicker/interface.ts:39

Additional help text displayed below the field

---

label?

optional label: string

Defined in: src/types/shared-components/DatePicker/interface.ts:11

Label displayed for the date picker

---

maxDate?

optional maxDate: Dayjs

Defined in: src/types/shared-components/DatePicker/interface.ts:29

Maximum selectable date constraint

---

minDate?

optional minDate: Dayjs

Defined in: src/types/shared-components/DatePicker/interface.ts:27

Minimum selectable date constraint

---

name?

optional name: string

Defined in: src/types/shared-components/DatePicker/interface.ts:9

Unique name identifier for the field

---

onBlur()?

optional onBlur: () => void

Defined in: src/types/shared-components/DatePicker/interface.ts:25

Callback fired when the field is blurred (for touch tracking)

Returns

void

---

onChange()

onChange: (date) => void

Defined in: src/types/shared-components/DatePicker/interface.ts:21

Callback fired when the date changes.

Parameters

date

Dayjs

The new date value.

Returns

void

---

placeholder?

optional placeholder: string

Defined in: src/types/shared-components/DatePicker/interface.ts:53

Placeholder text displayed when the date field is empty

---

required?

optional required: boolean

Defined in: src/types/shared-components/DatePicker/interface.ts:33

Whether the field is required

---

slotProps?

optional slotProps: Partial<DatePickerSlotProps<false>>

Defined in: src/types/shared-components/DatePicker/interface.ts:47

Additional props passed to MUI DatePicker slots (e.g., actionBar, layout)

---

slots?

optional slots: Record<string, React.ElementType>

Defined in: src/types/shared-components/DatePicker/interface.ts:49

Custom slot component overrides (e.g., openPickerIcon, leftArrowIcon)

---

touched?

optional touched: boolean

Defined in: src/types/shared-components/DatePicker/interface.ts:37

Whether the field has been touched (for validation UX)

---

value?

optional value: Dayjs

Defined in: src/types/shared-components/DatePicker/interface.ts:16

Current date value. Represented as a Dayjs object or null if no date is selected.