@progress/kendo-angular-scheduler 19.1.2-develop.4 → 19.1.2-develop.5

package/types/resource.interface.d.ts

@@ -3,35 +3,35 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * An interface for the resources of the Scheduler.
+ * Represents an interface that describes a Scheduler resource.
  */
 export interface Resource {
     /**
-     * The resource name. If not set, the value of the `field` option is used.
+     * Sets the resource name. If not set, uses the value of the `field` option.
      */
     name?: string;
     /**
-     * The field name of the event that contains the resource value.
+     * Sets the field name of the event that contains the resource value.
      */
     field: string;
     /**
-     * The resource data.
+     * Sets the resource data.
      */
     data: any[];
     /**
-     * The field name from the data that contains the resource value.
+     * Sets the field name from the data that contains the resource value.
      */
     valueField: string;
     /**
-     * The field name from the data that contains the resource text.
+     * Sets the field name from the data that contains the resource text.
      */
     textField: string;
     /**
-     * The field name from the data that contains the resource color.
+     * Sets the field name from the data that contains the resource color.
      */
     colorField?: string;
     /**
-     * Specifies if the events have multiple resource values.
+     * Specifies if events have multiple resource values.
      */
     multiple?: boolean;
 }

package/types/scheduler-event.d.ts

@@ -3,57 +3,55 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Represents an instance of a Scheduler calendar event.
+ * Represents a Scheduler calendar event instance.
  */
 export interface SchedulerEvent {
     /**
-     * The unique identifier of the event.
-     * Typically, the ID is a number.
-     * Can also be a string or an object.
+     * Sets the unique identifier of the event. The ID is usually a number, but can also be a string or object.
      */
     id?: any;
     /**
-     * A reference to the original data item, if any.
+     * Provides a reference to the original data item, if any.
      */
     dataItem?: any;
     /**
-     * The start date of the event.
+     * Sets the start date of the event.
      */
     start: Date;
     /**
-     * The timezone name for the start date.
+     * Sets the timezone name for the start date.
      */
     startTimezone?: string;
     /**
-     * The end date of the event.
+     * Sets the end date of the event.
      */
     end: Date;
     /**
-     * The timezone name for the end date.
+     * Sets the timezone name for the end date.
      */
     endTimezone?: string;
     /**
-     * A Boolean flag which indicates that the event occurs throughout the day.
+     * Specifies if the event occurs throughout the day.
      */
     isAllDay?: boolean;
     /**
-     * The title of the event.
+     * Sets the title of the event.
      */
     title: string;
     /**
-     * The detailed description of the event.
+     * Sets the detailed description of the event.
      */
     description?: string;
     /**
-     * The rule which describes the recurring pattern of the event.
+     * Sets the rule that describes the recurring pattern of the event.
      */
     recurrenceRule?: string;
     /**
-     * The `id` of the parent recurring event.
+     * Sets the `id` of the parent recurring event.
      */
     recurrenceId?: any;
     /**
-     * The recurrence exceptions, if any.
+     * Sets the recurrence exceptions, if any.
      */
     recurrenceExceptions?: Date[];
 }

package/types/scheduler-model-fields.interface.d.ts

@@ -3,62 +3,73 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Defines the model fields that will be used for creating `SchedulerEvent` instances.
+ * Defines the model fields for creating `SchedulerEvent` instances.
  */
 export interface SchedulerModelFields {
     /**
-     * The name of the `ID` model field.
-     * Defaults to `"id"`.
+     * Sets the name of the ID model field.
+     *
+     * @default "id"
      */
     id?: string;
     /**
-     * The name of the start date model field.
-     * Defaults to `"start"`.
+     * Sets the name of the start date model field.
+     *
+     * @default "start"
      */
     start?: string;
     /**
-     * The name of the start timezone model field.
-     * Defaults to `"startTimezone"`.
+     * Sets the name of the start timezone model field.
+     *
+     * @default "startTimezone"
      */
     startTimezone?: string;
     /**
-     * The name of the end date model field.
-     * Defaults to `"end"`.
+     * Sets the name of the end date model field.
+     *
+     * @default "end"
      */
     end?: string;
     /**
-     * The name of the end timezone model field.
-     * Defaults to `"endTimezone"`.
+     * Sets the name of the end timezone model field.
+     *
+     * @default "endTimezone"
      */
     endTimezone?: string;
     /**
-     * The name of the all-day flag model field.
-     * Defaults to `"isAllDay"`.
+     * Sets the name of the all-day flag model field.
+     *
+     * @default "isAllDay"
      */
     isAllDay?: string;
     /**
-     * The name of the title model field.
-     * Defaults to `"title"`.
+     * Sets the name of the title model field.
+     *
+     * @default "title"
      */
     title?: string;
     /**
-     * The name of the description model field.
-     * Defaults to `"title"`.
+     * Sets the name of the description model field.
+     *
+     * @default "title"
      */
     description?: string;
     /**
-     * The name of the recurrence model field.
-     * Defaults to `"recurrenceRule"`.
+     * Sets the name of the recurrence model field.
+     *
+     * @default "recurrenceRule"
      */
     recurrenceRule?: string;
     /**
-     * The name of the recurrence ID model field.
-     * Defaults to `"recurrenceId"`.
+     * Sets the name of the recurrence ID model field.
+     *
+     * @default "recurrenceId"
      */
     recurrenceId?: any;
     /**
-     * The name of the recurrence exceptions model field.
-     * Defaults to `"recurrenceExceptions"`.
+     * Sets the name of the recurrence exceptions model field.
+     *
+     * @default "recurrenceExceptions"
      */
     recurrenceExceptions?: string;
 }

package/types/scheduler-slot.interface.d.ts

@@ -5,23 +5,23 @@
 import { ElementRef } from '@angular/core';
 import { SchedulerEvent } from './scheduler-event';
 /**
- * Represents a Scheduler slot.
+ * Describes a Scheduler slot.
  */
 export interface SchedulerSlot {
     /**
-     * The slot events. Applicable for the **Year** view.
+     * Provides the slot events. Applies to the **Year** view.
      */
     events?: SchedulerEvent;
     /**
-     * The slot event. Applicable for the **Agenda** view.
+     * Provides the slot event. Applies to the **Agenda** view.
      */
     event?: SchedulerEvent;
     /**
-     * The slot resources.
+     * Provides the slot resources.
      */
     resources?: any[];
     /**
-     * The slot element.
+     * Provides the slot element.
      */
     element?: ElementRef;
     /**
@@ -29,11 +29,11 @@ export interface SchedulerSlot {
      */
     isAllDay?: boolean;
     /**
-     * The start date of the slot.
+     * Sets the start date of the slot.
      */
     start?: Date;
     /**
-     * The end date of the slot.
+     * Sets the end date of the slot.
      */
     end?: Date;
 }

package/types/scheduler-view.d.ts

@@ -4,7 +4,7 @@
 *-------------------------------------------------------------------------------------------*/
 import { TemplateRef } from '@angular/core';
 /**
- * An abstract class which contains meta information about a Scheduler view.
+ * Contains meta information about a Scheduler view.
  */
 export declare abstract class SchedulerView {
     /**
@@ -12,13 +12,11 @@ export declare abstract class SchedulerView {
      */
     abstract template: TemplateRef<any>;
     /**
-     * The view title that will be displayed by the Scheduler.
-     * For example, **Day View**.
+     * Sets the view title displayed by the Scheduler, for example, **Day View**.
      */
     abstract title: string;
     /**
-     * The invariant name for this view. For example, `day`.
-     * If not set, the name will be the same as the title.
+     * Sets the invariant name for this view, for example, `day`. If not set, uses the title.
      */
     abstract name: string;
 }

package/types/slot-class-args.interface.d.ts

@@ -3,15 +3,15 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The arguments for the `slotClass` function.
+ * Provides arguments for the `slotClass` function.
  */
 export interface SlotClassArgs {
     /**
-     * The start date of the slot.
+     * Sets the start date of the slot.
      */
     start?: Date;
     /**
-     * The end date of the slot.
+     * Sets the end date of the slot.
      */
     end?: Date;
     /**
@@ -19,15 +19,15 @@ export interface SlotClassArgs {
      */
     isAllDay?: boolean;
     /**
-     * The slot resources.
+     * Provides the slot resources.
      */
     resources?: any[];
     /**
-     * The slot event. Applicable for the **Agenda** view.
+     * Provides the slot event. Applies to the **Agenda** view.
      */
     event?: any;
     /**
-     * The slot events. Applicable for the **Year** view.
+     * Provides the slot events. Applies to the **Year** view.
      */
     events?: any[];
 }

package/types/view-item.interface.d.ts

@@ -5,7 +5,7 @@
 import { ZonedDate } from "@progress/kendo-date-math";
 import { SchedulerEvent } from "../types";
 /**
- * Represents the view item model of the Scheduler event.
+ * Represents the view item model for a Scheduler event.
  */
 export interface ViewItem {
     /**

package/views/agenda/agenda-view.component.d.ts

@@ -10,7 +10,14 @@ import { ViewStateService } from '../view-state.service';
 import { AgendaTimeTemplateDirective, AgendaDateTemplateDirective } from '../templates';
 import * as i0 from "@angular/core";
 /**
- * The component for rendering the **Agenda** view.
+ * Represents the component that renders the **Agenda** view in the Scheduler.
+ *
+ * @example
+ * ```html
+ * <kendo-scheduler>
+ *     <kendo-scheduler-agenda-view></kendo-scheduler-agenda-view>
+ * </kendo-scheduler>
+ * ```
  */
 export declare class AgendaViewComponent extends ConfigurationViewBase {
     /**
@@ -18,19 +25,16 @@ export declare class AgendaViewComponent extends ConfigurationViewBase {
      */
     get title(): string;
     /**
-     * The long-date format for displaying the
-     * selected date in the Scheduler toolbar.
-     * Defaults to `{0:D} - {1:D}`,
-     * where `0` is the start and `1` is the end date
-     * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+     * Sets the long-date format for the selected date in the Scheduler toolbar.
+     * Defaults to `'{0:D} - {1:D}'`, where `0` is the start and `1` is the end date.
+     * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
+     * @default '{0:D} - {1:D}'
      */
     selectedDateFormat: string;
     /**
-     * The short-date format for displaying the
-     * selected date in the Scheduler toolbar.
-     * Defaults to `{0:d} - {1:d}`,
-     * where `0` is the start and `1` is the end date
-     * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+     * Sets the short-date format for the selected date in the Scheduler toolbar.
+     * Defaults to `'{0:d} - {1:d}'`, where `0` is the start and `1` is the end date.
+     * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
      * @default '{0:d} - {1:d}'
      */
     selectedShortDateFormat: string;

package/views/common/slot-selectable.directive.d.ts

@@ -7,18 +7,30 @@ import { SchedulerComponent } from '../../scheduler.component';
 import { SlotRange } from '../../types/slot-selection';
 import * as i0 from "@angular/core";
 /**
- * A directive which manages the in-memory selection state of the Scheduler slots
- * ([see example]({% slug slotselection_scheduler %}#toc-built-in-directive)).
+ * Represents a directive that manages the built-in slot selection in the Scheduler.
+ *
+ * Add the `kendoSchedulerSlotSelectable` directive to a `<kendo-scheduler>` instance to allow users to select time slots by clicking or dragging.
+ *
+ * The directive keeps track of the selected slot range and emits changes when the selection is updated by user interaction.
+ *
+ * @example
+ * ```html
+ * <kendo-scheduler kendoSchedulerSlotSelectable [(slotSelection)]="selectedSlot">
+ * </kendo-scheduler>
+ * ```
+ *
+ * @remarks
+ * Applied to: {@link SchedulerComponent}
  */
 export declare class SlotSelectableDirective implements OnInit, OnChanges, OnDestroy {
     private scheduler;
     private cdr;
     /**
-     * The currently selected slot range.
+     * Represents the currently selected slot range.
      */
     slotSelection: SlotRange;
     /**
-     * Fires when the currently selected slot range has changed through user interaction.
+     * Fires when the user changes the currently selected slot range.
      */
     slotSelectionChange: EventEmitter<SlotRange>;
     /**

package/views/month/month-view.component.d.ts

@@ -13,7 +13,14 @@ import { MonthDaySlotTemplateDirective } from '../templates';
 import { Day } from '@progress/kendo-date-math';
 import * as i0 from "@angular/core";
 /**
- * The component for rendering the **Month** view.
+ * Represents the component that renders the **Month** view in the Scheduler.
+ *
+ * @example
+ * ```html
+ * <kendo-scheduler>
+ *     <kendo-scheduler-month-view></kendo-scheduler-month-view>
+ * </kendo-scheduler>
+ * ```
  */
 export declare class MonthViewComponent extends ConfigurationViewBase implements OnDestroy, OnChanges {
     private intl;
@@ -22,41 +29,35 @@ export declare class MonthViewComponent extends ConfigurationViewBase implements
      */
     get title(): string;
     /**
-     * The number of events to be rendered per day. Setting this property to 'auto'
-     * will display all events in the respective slot
+     * Sets the number of events to render per day. If set to `'auto'`, all events display in the slot. If set to `0`, it normalizes to `1`
      * ([see example](slug:month_views_scheduler#setting-the-number-of-events-per-day)).
-     * > When set to `'auto'` it will automatically set the `adaptiveSlotHeight` property to `true`.
-     * > If set to `0` it will be normalized internally to `1`.
+     * > When set to `'auto'`, it automatically sets the `adaptiveSlotHeight` property to `true`.
      * @default 2
      */
     set eventsPerDay(events: number | 'auto');
     get eventsPerDay(): number | 'auto';
     private _eventsPerDay;
     /**
-     * The height of the rendered events. Setting this property to 'auto' will
-     * set the height of each event automatically based on its content
+     * Sets the height of the rendered events. If set to `'auto'`, the height is based on the event content
      * ([see example](slug:month_views_scheduler#configuring-the-height-of-the-scheduler-events)).
-     * > When set to `'auto'` it will automatically set the `adaptiveSlotHeight` property to `true`.
+     * > When set to `'auto'`, it automatically sets the `adaptiveSlotHeight` property to `true`.
      */
     eventHeight: number | 'auto';
     /**
-     * Increases the slot group (row) height when containing events up to the number of displayed events
-     * and reduces its height if there are less events for that specific slot group (row)
+     * Enables adaptive slot height in the Scheduler. Increases the slot group (row) height when containing events up to the number of displayed events and reduces its height if there are fewer events for that slot group (row)
      * ([see example](slug:month_views_scheduler#enabling-the-adaptive-slot-height-of-the-scheduler)).
      * @default false
      */
     adaptiveSlotHeight: boolean;
     /**
-     * The long-date format for displaying the
-     * selected date in the Scheduler toolbar.
-     * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+     * Sets the long-date format for the selected date in the Scheduler toolbar.
+     * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
      * @default '{0:Y}'
      */
     selectedDateFormat: string;
     /**
-     * The short-date format for displaying the
-     * selected date in the Scheduler toolbar.
-     * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+     * Sets the short-date format for the selected date in the Scheduler toolbar.
+     * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
      * @default '{0:y}'
      */
     selectedShortDateFormat: string;

package/views/month/multi-week-view.component.d.ts

@@ -13,7 +13,14 @@ import { ViewStateService } from '../view-state.service';
 import { MultiWeekDaySlotTemplateDirective } from '../templates';
 import * as i0 from "@angular/core";
 /**
- * The component for rendering the **Multi-Week** view.
+ * Represents the component that renders the **Multi-Week** view in the Scheduler.
+ *
+ * @example
+ * ```html
+ * <kendo-scheduler>
+ *     <kendo-scheduler-multi-week-view></kendo-scheduler-multi-week-view>
+ * </kendo-scheduler>
+ * ```
  */
 export declare class MultiWeekViewComponent extends ConfigurationViewBase implements OnDestroy, OnChanges {
     private intl;
@@ -22,52 +29,47 @@ export declare class MultiWeekViewComponent extends ConfigurationViewBase implem
      */
     get title(): string;
     /**
-     * The height of the rendered events. Setting this property to `'auto'` will
-     * set the height of each event automatically based on its content
+     * Sets the height of the rendered events. If set to `'auto'`, the height is based on the event content
      * ([see example](slug:multiweek_views_scheduler#configuring-the-height-of-the-scheduler-events)).
-     * > When set to `'auto'` it will automatically set the `adaptiveSlotHeight` property to `true`.
+     * > When set to `'auto'`, it automatically sets the `adaptiveSlotHeight` property to `true`.
      */
     eventHeight: number | 'auto';
     /**
-     * The number of events to be rendered per day. Setting this property to 'auto'
-     * will display all events in the respective slot
+     * Sets the number of events to render per day. If set to `'auto'`, all events display in the slot. If set to `0`, it normalizes to `1`
      * ([see example](slug:multiweek_views_scheduler#setting-the-number-of-events-per-day)).
-     * > When set to `'auto'` it will automatically set the `adaptiveSlotHeight` property to `true`.
-     * > If set to `0` it will be normalized internally to `1`.
+     * > When set to `'auto'`, it automatically sets the `adaptiveSlotHeight` property to `true`.
      * @default 2
      */
     set eventsPerDay(events: number | 'auto');
     get eventsPerDay(): number | 'auto';
     private _eventsPerDay;
     /**
-     * Increases the slot group (row) height when containing events up to the number of displayed events
-     * and reduces its height if there are less events for that specific slot group (row)
+     * Enables adaptive slot height. Increases the slot group (row) height when containing events up to the number of displayed events and reduces its height if there are fewer events for that slot group (row)
      * ([see example](slug:multiweek_views_scheduler#enabling-the-adaptive-slot-height-of-the-scheduler)).
      * @default false
      */
     adaptiveSlotHeight: boolean;
     /**
-     * The number of weeks to be rendered.
+     * Sets the number of weeks to render in the view.
      * @default 6
      */
     numberOfWeeks: number;
     /**
-     * The long-date format for displaying the
-     * selected date in the Scheduler toolbar.
-     * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+     * Sets the long-date format for the selected date in the Scheduler toolbar.
+     * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
      * @default '{0:D} - {1:D}'
      */
     selectedDateFormat: string;
     /**
-     * The short-date format for displaying the
-     * selected date in the Scheduler toolbar.
-     * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+     * Sets the short-date format for the selected date in the Scheduler toolbar.
+     * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
      * @default '{0:d} - {1:d}'
      */
     selectedShortDateFormat: string;
     multiWeekDaySlotTemplate: MultiWeekDaySlotTemplateDirective;
     /**
-     * The invariant name for this view (`multiWeek`).
+     * The invariant name for this view.
+     * @default 'multiWeek'
      */
     readonly name: string;
     get viewEventHeight(): number | 'auto';

package/views/multi-day/day-view.component.d.ts

@@ -10,7 +10,14 @@ import { ViewStateService } from '../view-state.service';
 import { AllDaySlotTemplateDirective, AllDayEventTemplateDirective } from '../templates';
 import * as i0 from "@angular/core";
 /**
- * The component for rendering the **Day** view.
+ * Represents the component that renders the **Day** view in the Scheduler.
+ *
+ * @example
+ * ```html
+ * <kendo-scheduler>
+ *      <kendo-scheduler-day-view></kendo-scheduler-day-view>
+ * </kendo-scheduler>
+ * ```
  */
 export declare class DayViewComponent extends MultiDayViewBase {
     /**
@@ -18,17 +25,15 @@ export declare class DayViewComponent extends MultiDayViewBase {
      */
     get title(): string;
     /**
-     * The long-date format for displaying the
-     * selected date in the Scheduler toolbar.
-     * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+     * Sets the long-date format for the selected date in the Scheduler toolbar.
+     * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
      * @default '{0:D}'
      */
     set selectedDateFormat(value: string);
     get selectedDateFormat(): string;
     /**
-     * The short-date format for displaying the
-     * selected date in the Scheduler toolbar.
-     * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
+     * Sets the short-date format for the selected date in the Scheduler toolbar.
+     * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
      * @default '{0:d}'
      */
     set selectedShortDateFormat(value: string);

package/views/multi-day/multi-day-view.component.d.ts

@@ -9,29 +9,34 @@ import { ViewStateService } from '../view-state.service';
 import { DayViewComponent } from './day-view.component';
 import * as i0 from "@angular/core";
 /**
- * The component for rendering the **Multi-Day** view.
+ * Represents the component that renders the **Multi-Day** view in the Scheduler.
+ *
+ * @example
+ * ```html
+ * <kendo-scheduler>
+ *      <kendo-scheduler-multi-day-view></kendo-scheduler-multi-day-view>
+ * </kendo-scheduler>
+ * ```
  */
 export declare class MultiDayViewComponent extends DayViewComponent {
     /**
-     * The long-date format for displaying the
-     * selected date in the Scheduler toolbar.
-     * Defaults to `{0:D} - {1:D}` for multiple days and `{0:D}` for a single day
-     * ([more information](slug:parsingandformatting_intl#toc-date-formatting)).
+     * Sets the long-date format for the selected date in the Scheduler toolbar.
+     * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
+     * The default value is `'{0:D} - {1:D}'` for multiple days and `'{0:D}'` for a single day.
      * @default '{0:D} - {1:D}'
      */
     set selectedDateFormat(value: string);
     get selectedDateFormat(): string;
     /**
-     * The short date format for displaying the
-     * selected date in the Scheduler toolbar.
-     * Defaults to `{0:d} - {1:d}` for multiple days and `{0:d}` for a single day
-     * ([more information](slug:parsingandformatting_intl#toc-date-formatting)).
+     * Sets the short-date format for the selected date in the Scheduler toolbar.
+     * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
+     * The default value is `'{0:d} - {1:d}'` for multiple days and `'{0:d}'` for a single day.
      * @default '{0:d} - {1:d}'
      */
     set selectedShortDateFormat(value: string);
     get selectedShortDateFormat(): string;
     /**
-     * Specifies the number of days that the view will render.
+     * Sets the number of days to render in the view.
      * @default 1
      */
     numberOfDays: number;
@@ -41,7 +46,7 @@ export declare class MultiDayViewComponent extends DayViewComponent {
     get title(): string;
     /**
      * The invariant name for this view.
-     * @default 'multi-day'
+     * @default 'multiDay'
      */
     readonly name: string;
     private get defaultDateFormat();