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 active view.

Optional change

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

Type declaration

Optional children

children?: ReactNode

Optional className

className?: string

Optional disabledDates

disabledDates?: IDateRangeDescriptor[]

Gets/sets disabled dates.

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 header.

Optional hideHeader

hideHeader?: string | boolean

Determines whether the calendar hides its header. Even if set to false, the header is not displayed for multiple selection.

Optional hideOutsideDays

hideOutsideDays?: string | boolean

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

Optional id

id?: string

Optional locale

locale?: string

Sets the locale used for formatting and displaying the dates in the calendar.

Optional orientation

orientation?: string | CalendarOrientation

The orientation of the multiple months displayed in days view.

Optional resourceStrings

resourceStrings?: IgrCalendarResourceStrings

The resource strings.

Optional selection

selection?: string | CalendarBaseSelection

Sets the type of date selection.

Optional showWeekNumbers

showWeekNumbers?: string | boolean

Show/hide the week numbers.

Optional size

size?: string | SizableComponentSize

Optional specialDates

specialDates?: IDateRangeDescriptor[]

Gets/sets special dates.

Optional style

style?: CSSProperties

Optional value

value?: Date

Optional values

values?: Date[]

Optional visibleMonths

visibleMonths?: string | number

The number of months displayed in days view.

Optional weekStart

weekStart?: string | CalendarBaseWeekStart

Sets the start day of the week.