Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrDatePickerProps

Hierarchy

Hierarchy

Properties

Properties

Optional activeDate

activeDate?: Date

Gets/Sets the date which is shown in the calendar picker and is highlighted. By default it is the current date.

Optional change

change?: ((s, e) => void)

Type declaration

Optional children

children?: ReactNode

Optional className

className?: string

Optional closed

closed?: ((s, e) => void)

Type declaration

Optional closing

closing?: ((s, e) => void)

Type declaration

Optional defaultValue

defaultValue?: any

The initial value of the component.

Optional disabled

disabled?: string | boolean

The disabled state of the component

Optional disabledDates

disabledDates?: IDateRangeDescriptor[]

Gets/sets disabled dates.

Optional displayFormat

displayFormat?: string

Format to display the value in when not editing. Defaults to the input format if not set.

Optional emitEvent

emitEvent?: any

Optional headerOrientation

headerOrientation?: string | CalendarHeaderOrientation

The orientation of the calendar header.

Optional hideHeader

hideHeader?: string | boolean

Determines whether the calendar hides its header.

Optional hideOutsideDays

hideOutsideDays?: string | boolean

Controls the visibility of the dates that do not belong to the current month.

Optional id

id?: string

Optional input

input?: ((s, e) => void)

Type declaration

Optional inputFormat

inputFormat?: string

The date format to apply on the input. Defaults to the current locale Intl.DateTimeFormat

Optional invalid

invalid?: string | boolean

Control the validity of the control.

Optional keepOpenOnOutsideClick

keepOpenOnOutsideClick?: string | boolean

Whether the component dropdown should be kept open on clicking outside of it.

Optional keepOpenOnSelect

keepOpenOnSelect?: string | boolean

Whether the component dropdown should be kept open on selection.

Optional label

label?: string

The label of the datepicker.

Optional locale

locale?: string

The locale settings used to display the value.

Optional max

max?: Date

The maximum value required for the date picker to remain valid.

Optional min

min?: Date

The minimum value required for the date picker to remain valid.

Optional mode

mode?: string | PickerMode

Determines whether the calendar is opened in a dropdown or a modal dialog

Optional name

name?: string

The name attribute of the control.

Optional nonEditable

nonEditable?: string | boolean

Whether to allow typing in the input.

Optional open

open?: string | boolean

Sets the open state of the component.

Optional opened

opened?: ((s, e) => void)

Type declaration

Optional opening

opening?: ((s, e) => void)

Type declaration

Optional orientation

orientation?: string | ContentOrientation

The orientation of the multiple months displayed in the calendar's days view.

Optional outlined

outlined?: string | boolean

Whether the control will have outlined appearance.

Optional placeholder

placeholder?: string

The placeholder attribute of the control.

Optional prompt

prompt?: string

The prompt symbol to use for unfilled parts of the mask.

Optional readOnly

readOnly?: string | boolean

Makes the control a readonly field.

Optional required

required?: string | boolean

Makes the control a required field in a form context.

Optional resourceStrings

resourceStrings?: IgrCalendarResourceStrings

The resource strings of the calendar.

Optional showWeekNumbers

showWeekNumbers?: string | boolean

Whether to show the number of the week in the calendar.

Optional specialDates

specialDates?: IDateRangeDescriptor[]

Gets/sets special dates.

Optional style

style?: CSSProperties

Optional value

value?: Date

The value of the picker

Optional visibleMonths

visibleMonths?: string | number

The number of months displayed in the calendar.

Optional weekStart

weekStart?: string | WeekDays

Sets the start day of the week for the calendar.