Class IgxCalendarComponent

Calendar provides a way to display date information.

IgxCalendarModule

igx-calendar-theme, igx-icon-theme

calendar, datepicker, schedule, date

Scheduling

The Ignite UI Calendar provides an easy way to display a calendar and allow users to select dates using single, multiple or range selection.

@example:

<igx-calendar selection="range"></igx-calendar>

Hierarchy

Hierarchy

  • IgxCalendarBaseDirective
    • IgxCalendarComponent

Implements

  • AfterViewInit
  • OnDestroy

Properties

activeViewChanged: EventEmitter<IgxCalendarView> = ...

Emits an event when the active view is changed.

<igx-calendar (activeViewChanged)="activeViewChanged($event)"></igx-calendar>
public activeViewChanged(event: CalendarView) {
let activeView = event;
}
hasHeader: boolean = true

Sets/gets whether the calendar has header. Default value is true.

<igx-calendar [hasHeader]="false"></igx-calendar>
headerOrientation: "horizontal" | "vertical" = 'horizontal'
hideOutsideDays: boolean = false

Sets/gets whether the outside dates (dates that are out of the current month) will be hidden. Default value is false.

<igx-calendar [hideOutsideDays]="true"></igx-calendar>
let hideOutsideDays = this.calendar.hideOutsideDays;
id: string = ...

Sets/gets the id of the calendar.

If not set, the id will have value "igx-calendar-0".

<igx-calendar id="my-first-calendar"></igx-calendar>

IgxCalendarComponent

orientation: "horizontal" | "vertical" = 'horizontal'
selected: EventEmitter<Date | Date[]> = ...

Emits an event when a date is selected. Provides reference the selectedDates property.

showWeekNumbers: boolean = false

Show/hide week numbers

<igx-calendar [showWeekNumbers]="true"></igx-calendar>
vertical: boolean = false

Sets/gets whether the calendar header will be in vertical position. Default value is false.

<igx-calendar [vertical]="true"></igx-calendar>
viewDateChanged: EventEmitter<IViewDateChangeEventArgs> = ...

Emits an event when the month in view is changed.

<igx-calendar (viewDateChanged)="viewDateChanged($event)"></igx-calendar>
public viewDateChanged(event: IViewDateChangeEventArgs) {
let viewDate = event.currentValue;
}

Accessors

  • get context(): {
        $implicit: | { date: Date; index: number }
        | { date: Date; index: number }[];
    }

    Gets the context for the template marked with either igxCalendarSubHeaderMonth or igxCalendarSubHeaderYear directive.

    let context =  this.calendar.context;
    

    Returns { $implicit: { date: Date; index: number } | { date: Date; index: number }[] }

  • get headerContext(): {
        $implicit: | { date: Date; index: number }
        | { date: Date; index: number }[];
    }

    Gets the context for the template marked with the igxCalendarHeader directive.

    let headerContext =  this.calendar.headerContext;
    

    Returns { $implicit: { date: Date; index: number } | { date: Date; index: number }[] }

  • get value(): Date | Date[]

    Gets the selected date(s).

    When selection is set to single, it returns a single Date object. Otherwise it is an array of Date objects.

    Returns Date | Date[]

  • set value(value: string | Date | Date[]): void

    Sets the selected date(s).

    When selection is set to single, it accepts a single Date object. Otherwise it is an array of Date objects.

    Parameters

    • value: string | Date | Date[]

    Returns void

Methods