Element

igc-calendar

Slots

default — The default slot for the calendar.

title — Renders the title of the calendar header.

header-date — Renders content instead of the current date/range in the calendar header.

CSS Parts

header — The header element of the calendar.

header-title — The header title element of the calendar.

header-date — The header date element of the calendar.

content — The content element which contains the views and navigation elements of the calendar.

content-vertical — The content element which contains the views and navigation elements of the calendar in vertical orientation.

navigation — The navigation container element of the calendar.

months-navigation — The months navigation button element of the calendar.

years-navigation — The years navigation button element of the calendar.

years-range — The years range element of the calendar.

navigation-buttons — The navigation buttons container of the calendar.

navigation-button — Previous/next navigation button of the calendar.

days-view-container — The days view container element of the calendar.

days-view — Days view element of the calendar.

months-view — The months view element of the calendar.

years-view — The years view element of the calendar.

days-row — Days row element of the calendar.

label — Week header label element of the calendar.

week-number — Week number element of the calendar.

week-number-inner — Week number inner element of the calendar.

date — Date element of the calendar.

date-inner — Date inner element of the calendar.

first — The first selected date element of the calendar in range selection.

last — The last selected date element of the calendar in range selection.

inactive — Inactive date element of the calendar.

hidden — Hidden date element of the calendar.

weekend — Weekend date element of the calendar.

range — Range selected element of the calendar.

special — Special date element of the calendar.

disabled — Disabled date element of the calendar.

single — Single selected date element of the calendar.

preview — Range selection preview date element of the calendar.

month — Month element of the calendar.

month-inner — Month inner element of the calendar.

year — Year element of the calendar.

year-inner — Year inner element of the calendar.

selected — Indicates selected state. Applies to date, month and year elements of the calendar.

current — Indicates current state. Applies to date, month and year elements of the calendar.

IgcCalendarComponent

new IgcCalendarComponent(): IgcCalendarComponent

Defined in src/components/calendar/calendar.ts:249

Returns IgcCalendarComponent

activeView: CalendarActiveView = 'days'

formatOptions: Pick<Intl.DateTimeFormatOptions, "month" | "weekday">

headerOrientation: CalendarHeaderOrientation = 'horizontal'

hideHeader: boolean = false

hideOutsideDays: boolean = false

orientation: ContentOrientation = 'horizontal'

selection: CalendarSelection = 'single'

showWeekNumbers: boolean = false

visibleMonths: number = 1

weekStart: WeekDays = 'sunday'

styles: CSSResult = styles

tagName: "igc-calendar" = 'igc-calendar'

Inherited from: EventEmitterMixin< IgcCalendarComponentEventMap, Constructor<IgcCalendarBaseComponent> >(IgcCalendarBaseComponent)

get activeDate(): Date

set activeDate(value: string | Date | null | undefined): void

Inherited from: EventEmitterMixin< IgcCalendarComponentEventMap, Constructor<IgcCalendarBaseComponent> >(IgcCalendarBaseComponent)

get disabledDates(): DateRangeDescriptor[] | undefined

set disabledDates(value: DateRangeDescriptor[]): void

Inherited from: EventEmitterMixin< IgcCalendarComponentEventMap, Constructor<IgcCalendarBaseComponent> >(IgcCalendarBaseComponent)

get locale(): string

set locale(value: string): void

Inherited from: EventEmitterMixin< IgcCalendarComponentEventMap, Constructor<IgcCalendarBaseComponent> >(IgcCalendarBaseComponent)

get resourceStrings(): IgcCalendarResourceStrings & ICalendarResourceStrings

set resourceStrings(value: IgcCalendarResourceStrings | ICalendarResourceStrings): void

Inherited from: EventEmitterMixin< IgcCalendarComponentEventMap, Constructor<IgcCalendarBaseComponent> >(IgcCalendarBaseComponent)

get specialDates(): DateRangeDescriptor[] | undefined

set specialDates(value: DateRangeDescriptor[]): void

Inherited from: EventEmitterMixin< IgcCalendarComponentEventMap, Constructor<IgcCalendarBaseComponent> >(IgcCalendarBaseComponent)

get value(): Date | null

set value(value: string | Date | null | undefined): void

Inherited from: EventEmitterMixin< IgcCalendarComponentEventMap, Constructor<IgcCalendarBaseComponent> >(IgcCalendarBaseComponent)

get values(): Date[]

set values(values: string | string | Date[] | null | undefined): void

Inherited from: EventEmitterMixin< IgcCalendarComponentEventMap, Constructor<IgcCalendarBaseComponent> >(IgcCalendarBaseComponent)

addEventListener(type: K, listener: object, options: boolean | AddEventListenerOptions): void

Defined in src/components/common/mixins/event-emitter.ts:7

Parameters

• type: K
• listener: object
• options: boolean | AddEventListenerOptions

Returns void

Inherited from: EventEmitterMixin< IgcCalendarComponentEventMap, Constructor<IgcCalendarBaseComponent> >(IgcCalendarBaseComponent)

emitEvent(type: K, eventInitDict: CustomEventInit<D>): boolean

Defined in src/components/common/mixins/event-emitter.ts:30

Parameters

• type: K
• eventInitDict: CustomEventInit<D>

Returns boolean

Inherited from: EventEmitterMixin< IgcCalendarComponentEventMap, Constructor<IgcCalendarBaseComponent> >(IgcCalendarBaseComponent)

removeEventListener(type: K, listener: object, options: boolean | EventListenerOptions): void

Defined in src/components/common/mixins/event-emitter.ts:17

Parameters

• type: K
• listener: object
• options: boolean | EventListenerOptions

Returns void

register(): void

Defined in src/components/calendar/calendar.ts:115

Returns void

igcChange: CustomEvent<Date | Date[]>

Defined in src/components/calendar/types.ts:29