Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrCalendarProps

Hierarchy

Hierarchy

Properties

Properties

Optional activeDate

activeDate?: Date

Sets the date which is shown in view and is highlighted. By default it is the current date.

Optional activeView

activeView?: string | CalendarActiveView

The current active view of the component.

Optional change

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

Type declaration

Optional children

children?: ReactNode

Optional className

className?: string

Optional disabledDates

disabledDates?: IDateRangeDescriptor[]

Gets/Sets the disabled dates for the component.

Optional formatOptions

formatOptions?: IgrCalendarFormatOptions

The options used to format the months and the weekdays in the calendar views.

Optional headerOrientation

headerOrientation?: string | CalendarHeaderOrientation

The orientation of the calendar header.

Optional hideHeader

hideHeader?: string | boolean

Whether to render the calendar header part. When the calendar selection is set to multiple the header is always hidden.

Optional hideOutsideDays

hideOutsideDays?: string | boolean

Whether to show the dates that do not belong to the current active month.

Optional id

id?: string

Optional locale

locale?: string

Gets/Sets the locale used for formatting and displaying the dates in the component.

Optional orientation

orientation?: string | ContentOrientation

The orientation of the calendar months when more than one month is being shown.

Optional resourceStrings

resourceStrings?: IgrCalendarResourceStrings

The resource strings for localization.

Optional selection

selection?: string | CalendarSelection

Sets the type of selection in the component.

Optional showWeekNumbers

showWeekNumbers?: string | boolean

Whether to show the week numbers.

Optional specialDates

specialDates?: IDateRangeDescriptor[]

Gets/Sets the special dates for the component.

Optional style

style?: CSSProperties

Optional value

value?: Date

Optional values

values?: Date[]

Optional visibleMonths

visibleMonths?: string | number

The number of months displayed in the days view.

Optional weekStart

weekStart?: string | WeekDays

Gets/Sets the first day of the week.