Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IDatePickerProps
    • IDateFormFieldProps

Index

Properties

Optional allowTextInput

allowTextInput: boolean

Whether the DatePicker allows input a date string directly or not

defaultvalue

false

Optional ariaLabel

ariaLabel: string

Aria Label for TextField of the DatePicker for screen reader users.

Optional borderless

borderless: boolean

Determines if DatePicker has a border.

defaultvalue

false

Optional calendarProps

calendarProps: ICalendarProps

Pass calendar props to calendar component

Optional children

children: ReactNode

Optional className

className: string

Optional Classname for datepicker root element .

Optional componentRef

componentRef: function

Optional callback to access the IDatePicker interface. Use this instead of ref for accessing the public methods and properties of the component.

Type declaration

    • (component: IDatePicker | null): void
    • Parameters

      • component: IDatePicker | null

      Returns void

Optional dateTimeFormatter

dateTimeFormatter: ICalendarFormatDateCallbacks

Apply additional formating to dates, for example localized date formatting.

Optional disableAutoFocus

disableAutoFocus: boolean

Whether the DatePicker should open automatically when the control is focused

defaultvalue

false

Optional disabled

disabled: boolean

Disabled state of the DatePicker.

default

false

Optional firstDayOfWeek

firstDayOfWeek: DayOfWeek

The first day of the week for your locale.

defaultvalue

DayOfWeek.Sunday

Optional firstWeekOfYear

firstWeekOfYear: FirstWeekOfYear

Defines when the first week of the year should start, FirstWeekOfYear.FirstDay, FirstWeekOfYear.FirstFullWeek or FirstWeekOfYear.FirstFourDayWeek are the possible values

defaultvalue

FirstWeekOfYear.FirstFullWeek

Optional formatDate

formatDate: function

Optional method to format the chosen date to a string to display in the DatePicker

defaultvalue

date.toString()

Type declaration

    • (date?: Date): string
    • Parameters

      • Optional date: Date

      Returns string

Optional highlightCurrentMonth

highlightCurrentMonth: boolean

Whether the month picker should highlight the current month

defaultvalue

false

Optional highlightSelectedMonth

highlightSelectedMonth: boolean

Whether the month picker should highlight the selected month

defaultvalue

false

Optional initialPickerDate

initialPickerDate: Date

The initially highlighted date in the calendar picker

Optional isMonthPickerVisible

isMonthPickerVisible: boolean

Whether the month picker is shown beside the day picker or hidden.

defaultvalue

true

Optional isRequired

isRequired: boolean

Whether the DatePicker is a required field or not

defaultvalue

false

Optional key

key: Key

Optional label

label: string

Label for the DatePicker

locale

locale: string

Optional maxDate

maxDate: Date

The maximum allowable date.

Optional minDate

minDate: Date

The minimum allowable date.

Optional onAfterMenuDismiss

onAfterMenuDismiss: function

Callback that runs after DatePicker's menu (Calendar) is closed

Type declaration

    • (): void
    • Returns void

Optional onSelectDate

onSelectDate: function

Callback issued when a date is selected

Type declaration

    • (date: Date | null | undefined): void
    • Parameters

      • date: Date | null | undefined

      Returns void

Optional parseDateFromString

parseDateFromString: function

Optional method to parse the text input value to date, it is only useful when allowTextInput is set to true

defaultvalue

new Date(Date.parse(dateStr))

Type declaration

    • (dateStr: string): Date | null
    • Parameters

      • dateStr: string

      Returns Date | null

Optional pickerAriaLabel

pickerAriaLabel: string

Aria label for date picker popup for screen reader users.

defaultvalue

Calendar

Optional placeholder

placeholder: string

Placeholder text for the DatePicker

Optional ref

ref: LegacyRef<DatePicker>

Optional showGoToToday

showGoToToday: boolean

Whether the "Go to today" link should be shown or not

Optional showMonthPickerAsOverlay

showMonthPickerAsOverlay: boolean

Show month picker on top of date picker when visible.

defaultvalue

false

Optional showWeekNumbers

showWeekNumbers: boolean

Whether the calendar should show the week number (weeks 1 to 53) before each week row

defaultvalue

false

Optional strings

strings: IDatePickerStrings

Localized strings to use in the DatePicker

Optional today

today: Date

Value of today. If null, current time in client machine will be used.

Optional value

value: Date

Default value of the DatePicker, if any

Generated using TypeDoc