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

package/types/actions.d.ts

@@ -4,13 +4,14 @@
 *-------------------------------------------------------------------------------------------*/
 import { SchedulerView } from './scheduler-view';
 /**
- * An action which indicates that the current view will switch to the next period
- * ([more information and examples]({% slug toolbar_scheduler %})).
+ * Represents an action that switches the current view to the next period
+ * ([more information and examples](slug:toolbar_scheduler)).
  *
- * ```ts-no-run
+ * @example
+ * ```typescript
  * const action = {
- *  type: 'next'
- * }
+ *   type: 'next'
+ * };
  * ```
  */
 export interface Next {
@@ -18,13 +19,14 @@ export interface Next {
     type: 'next';
 }
 /**
- * An action which indicates that the current view will switch to the previous period
- * ([more information]({% slug api_scheduler_navigationaction %})).
+ * Represents an action that switches the current view to the previous period
+ * ([more information](slug:api_scheduler_navigationaction)).
  *
- * ```ts-no-run
+ * @example
+ * ```typescript
  * const action = {
- *  type: 'prev'
- * }
+ *   type: 'prev'
+ * };
  * ```
  */
 export interface Prev {
@@ -32,13 +34,14 @@ export interface Prev {
     type: 'prev';
 }
 /**
- * An action which indicates that the current view will switch to today's date
- * ([more information]({% slug api_scheduler_navigationaction %})).
+ * Represents an action that switches the current view to today's date
+ * [more information](slug:api_scheduler_navigationaction).
  *
- * ```ts-no-run
+ * @example
+ * ```typescript
  * const action = {
- *  type: 'today'
- * }
+ *   type: 'today'
+ * };
  * ```
  */
 export interface Today {
@@ -46,107 +49,110 @@ export interface Today {
     type: 'today';
 }
 /**
- * An action which indicates that the current view will switch to the specified date
- * ([more information]({% slug api_scheduler_navigationaction %})).
+ * Represents an action that switches the current view to a specific date
+ * ([more information](slug:api_scheduler_navigationaction)).
  *
- * ```ts-no-run
+ * @example
+ * ```typescript
  * const action = {
- *  type: 'select-date',
- *  date: new Date('2018-10-22')
- * }
+ *   type: 'select-date',
+ *   date: new Date('2018-10-22')
+ * };
  * ```
  */
 export interface SelectDate {
     /** @hidden */
     type: 'select-date';
     /**
-     * The date that will be selected by the Scheduler.
+     * Defines the date selected by the Scheduler.
      */
     date: Date;
 }
 /**
- * An action which indicates that the selected view will be changed to the specified instance
- * ([more information and examples]({% slug toolbar_scheduler %})).
+ * Represents an action that changes the selected view to a specific instance
+ * ([more information and examples](slug:toolbar_scheduler)).
  *
- * ```ts-no-run
+ * @example
+ * ```typescript
  * const action = {
- *  type: 'view-change',
- *  view: schedulerView
- * }
+ *   type: 'view-change',
+ *   view: schedulerView
+ * };
  * ```
  */
 export interface ViewChange {
     /** @hidden */
     type: 'view-change';
     /**
-     * The next view entry that will be displayed.
+     * Defines the next view entry to display.
      */
     view: SchedulerView;
 }
 /**
- * An action which indicates that details for the specified date will be shown.
+ * Represents an action that displays the details for a specific date.
  *
- * ```ts-no-run
+ * @example
+ * ```typescript
  * const action = {
- *  type: 'show-date',
- *  view: schedulerView,
- *  date: Date
- * }
+ *   type: 'show-date',
+ *   view: schedulerView,
+ *   date: new Date()
+ * };
  * ```
  */
 export interface ShowDate {
     /** @hidden */
     type: 'show-date';
     /**
-     * The view in which the date will be displayed.
+     * Defines the view in which the date displays.
      */
     view: SchedulerView;
     /**
-     * The new selected date.
+     * Defines the new selected date.
      */
     date: Date;
 }
 /**
- * An action which specifies that the view will scroll to the specified time.
+ * Represents an action that scrolls the view to a specific time.
  */
 export interface ScrollTime {
     /** @hidden */
     type: 'scroll-time';
     /**
-     * The time to which the view will scroll.
+     * Defines the time to which the view scrolls.
      */
     time: string | Date;
 }
 /**
- * An action which indicates that the previous event will be focused.
+ * Represents an action that focuses the previous event.
  */
 export interface FocusPrev {
     /** @hidden */
     type: 'focus-prev';
 }
 /**
- * An action which indicates that the next event will be focused.
+ * Represents an action that focuses the next event.
  */
 export interface FocusNext {
     /** @hidden */
     type: 'focus-next';
 }
 /**
- * An action which toggles the Show Business Hours option.
+ * Represents an action that toggles the **Show Business Hours** option.
  */
 export interface ToggleBusinessHours {
     /** @hidden */
     type: 'toggle-business-hours';
 }
 /**
- * An action which focuses the first toolbar tool.
+ * Represents an action that focuses the first toolbar tool.
  */
 export interface FocusToolbar {
     /** @hidden */
     type: 'focus-toolbar';
 }
 /**
- * A discriminated union of supported navigation actions
- * ([more information and examples]({% slug toolbar_scheduler %})).
+ * Represents a discriminated union of supported navigation actions
+ * ([more information and examples](slug:toolbar_scheduler)).
  */
 export type NavigationAction = Next | Prev | SelectDate | Today | ViewChange | ShowDate | ScrollTime | FocusPrev | FocusNext | ToggleBusinessHours | FocusToolbar;

package/types/create-form-group-args.interface.d.ts

@@ -5,7 +5,7 @@
 import { EditEventBase } from '../events/edit-event-base';
 import { EditMode } from './edit-mode.enum';
 /**
- * The argument that is passed to the `createFormGroup` function.
+ * Defines the argument for the `createFormGroup` function.
  */
 export interface CreateFormGroupArgs extends EditEventBase {
     /**

package/types/crud-operation.enum.d.ts

@@ -3,15 +3,15 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The selected CRUD operation when the user edits or removes recurring events.
+ * Represents the selected CRUD operation when the user edits or removes recurring events.
  */
 export declare enum CrudOperation {
     /**
-     * The user edits the selected recurring event.
+     * Indicates that the selected recurring event is edited.
      */
     Edit = 0,
     /**
-     * The user removes the selected recurring event.
+     * Indicates that the selected recurring event is removed.
      */
     Remove = 1
 }

package/types/current-time-settings.interface.d.ts

@@ -3,23 +3,25 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The settings for the current time marker.
+ * Represents the current time marker settings.
  */
 export interface CurrentTimeSettings {
     /**
-     * The update interval (in milliseconds) of the current time marker.
-     * Defaults to `60000` (a minute).
+     * Sets the update interval in milliseconds for the current time marker.
+     *
+     * @default 60000
      */
     updateInterval?: number;
     /**
-     * Specifies if the local timezone will be used.
-     * If set to `false`, the Scheduler will use its own timezone.
-     * Defaults to `true`.
+     * Specifies if the local timezone is used. If `false`, the Scheduler uses its own timezone.
+     *
+     * @default true
      */
     localTimezone?: boolean;
     /**
-     * Specifies if the current time marker will be displayed.
-     * Defaults to `true`.
+     * Specifies if the current time marker is displayed.
+     *
+     * @default true
      */
     enabled?: boolean;
 }

package/types/date-range.interface.d.ts

@@ -3,30 +3,26 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Represents the date range of a Scheduler view.
+ * Describes the date range of a Scheduler view.
  *
- * The interval includes the start date and all dates
- * up to but not including the end date.
- * Depending on the size of the component, in its navigation bar
- * the Scheduler will display either the `text` or `shortText` field.
+ * The interval includes the `start` date and all dates up to but not including the `end` date.
+ * The Scheduler displays either the `text` or `shortText` field in its navigation bar, depending on the component size.
  */
 export interface DateRange {
     /**
-     * The start date of the range (inclusive).
+     * Represents the start date of the range (inclusive).
      */
     start: Date;
     /**
-     * The end date of the range (exclusive)
+     * Represents the end date of the range (exclusive).
      */
     end: Date;
     /**
-     * The textual representation of the date range. For example,
-     * `Monday, June 10, 2018 - Monday, June 17, 2018`.
+     * Defines the textual representation of the date range, for example, `Monday, June 10, 2025 - Monday, June 17, 2025`.
      */
     text: string;
     /**
-     * The short textual representation of the date range. For example,
-     * `6/10/2018 - 6/17/2019`.
+     * Defines the short textual representation of the date range, for example, `6/10/2025 - 6/17/2026`.
      */
     shortText: string;
 }

package/types/datepicker-options.interface.d.ts

@@ -5,74 +5,73 @@
 import { CalendarView, DateInputFormatPlaceholder, PopupSettings } from '@progress/kendo-angular-dateinputs';
 import { Day } from '@progress/kendo-date-math';
 /**
- * The available configuration options for the DatePicker component, used internally in the recurrence editor.
+ * Represents the available configuration options for the DatePicker component used in the recurrence editor.
  */
 export interface DatePickerOptions {
     /**
-     * Defines the active view that the Calendar initially renders.
-     * ([See example]({% slug viewoptions_calendar %}#toc-active-view)).
-     * By default, the active view is `month`.
+     * Defines the active view that the Calendar initially renders
+     * ([see example](slug:viewoptions_calendar#toc-active-view).
+     * Always set the `activeView` within the range defined by `topView` and `bottomView`.
      *
-     * Always configure the `activeView` within the range defined by `topView` and `bottomView`.
+     * @default 'month'
      */
     activeView?: CalendarView;
     /**
-     * Defines the bottommost Calendar view to which the user can navigate.
-     * ([See example](slug:datepicker_calendar_options#toc-view-selection-depth)).
+     * Defines the bottommost Calendar view to which the user can navigate
+     * ([see example](slug:datepicker_calendar_options#toc-view-selection-depth)).
      */
     bottomView?: CalendarView;
     /**
      * Determines whether the built-in validator for disabled
-     * date ranges is enforced when validating a form.
-     * ([see example]( slug:disabled_dates_datepicker#toc-using-a-function)).
+     * date ranges is enforced when validating a form
+     * ([see example](slug:disabled_dates_datepicker#toc-using-a-function)).
      */
     disabledDatesValidation?: boolean;
     /**
-     * Specifies the focused date of the Calendar component.
+     * Sets the focused date of the Calendar component
      * ([see example](slug:datepicker_calendar_options#toc-focused-dates)).
      */
     focusedDate?: Date;
     /**
-     * Specifies the date format that is used to display the input value.
-     * ([see example]({% slug formats_datepicker %})).
+     * Sets the date format used to display the input value
+     * ([see example](slug:formats_datepicker)).
      */
     format?: string;
     /**
-     * Defines the descriptions of the format sections in the input field.
-     * ([More information and examples]({% slug placeholders_datepicker %})).
+     * Defines the descriptions of the format sections in the input field
+     * ([more information and examples](slug:placeholders_datepicker)).
      */
     formatPlaceHolder?: DateInputFormatPlaceholder;
     /**
-     * Specifies the biggest valid date.
-     * ([See example]({% slug dateranges_datepicker %})).
+     * Sets the largest valid date
+     * ([see example](slug:dateranges_datepicker)).
      */
     max?: Date;
     /**
-     * Specifies the smallest valid date.
-     * ([See example]({% slug dateranges_datepicker %})).
+     * Sets the smallest valid date
+     * ([see example](slug:dateranges_datepicker)).
      */
     min?: Date;
     /**
-     * Sets or gets the `navigation` property of the Calendar
-     * and determines whether the navigation side-bar is displayed.
-     * ([See example]({% slug sidebar_datepicker %})).
+     * Sets or gets the `navigation` property of the Calendar and determines if the navigation side-bar is displayed
+     * ([see example](slug:sidebar_datepicker)).
      */
     navigation?: boolean;
     /**
-     * Specifies the hint the DatePicker displays when its value is `null`.
-     * ([More information and examples]({% slug placeholders_datepicker %})).
+     * Specifies the hint the DatePicker displays when its value is `null`
+     * ([more information and examples](slug:placeholders_datepicker)).
      */
     placeholder?: string;
     /**
-     * Sets the read-only state of the DatePicker input field.
-     * ([See example]({% slug readonly_datepicker %}#toc-read-only-input)).
+     * Sets the read-only state of the DatePicker input field
+     * ([see example](slug:readonly_datepicker#read-only-input)).
      *
-     * If [`readonly`]({% slug api_dateinputs_datepickercomponent %}#toc-readonly) property is set to `true`, the input will appear in a read-only state, without regard to the `readOnlyInput` value.
+     * If [`readonly`](slug:api_dateinputs_datepickercomponent#readonly) is `true`, the input appears in a read-only state, regardless of the `readOnlyInput` value.
      */
     readOnlyInput?: boolean;
     /**
-     * Sets the read-only state of the DatePicker.
-     * ([See example]({% slug readonly_datepicker %}#toc-read-only-datepicker)).
+     * Sets the read-only state of the DatePicker
+     * ([see example](slug:readonly_datepicker#toc-read-only-datepicker)).
      */
     readonly?: boolean;
     /**
@@ -80,26 +79,22 @@ export interface DatePickerOptions {
      */
     title?: string;
     /**
-     * Defines the topmost Calendar view to which the user can navigate.
-     * ([See example](slug:viewdepth_calendar)).
+     * Defines the topmost Calendar view to which the user can navigate
+     * ([see example](slug:viewdepth_calendar)).
      */
     topView?: CalendarView;
     /**
-     * Determines whether to display a week number column in the `month` view of the Calendar.
-     * ([See example](slug:datepicker_calendar_options#toc-week-number-column)).
+     * Determines if the week number column is displayed in the `month` view of the Calendar
+     * ([see example](slug:datepicker_calendar_options#toc-week-number-column)).
      */
     weekNumber?: boolean;
     /**
-     * Sets the dates of the DatePicker that will be disabled.
-     * ([See example]({% slug disabled_dates_datepicker %})).
+     * Sets the dates of the DatePicker that are disabled
+     * ([see example](slug:disabled_dates_datepicker)).
      */
     disabledDates?: ((date: Date) => boolean) | Date[] | Day[];
     /**
      * Configures the popup options of the DatePicker.
-     *
-     * The available options are:
-     * - `animate: Boolean`—Controls the popup animation. By default, the open and close animations are enabled.
-     * - `popupClass: String`—Specifies a list of CSS classes that are used to style the popup.
      */
     popupSettings?: PopupSettings;
 }

package/types/edit-event-args.interface.d.ts

@@ -5,16 +5,15 @@
 import { FormGroup } from '@angular/forms';
 import { EditMode } from '../types';
 /**
- * An object which contains the options for the [`SchedulerComponent.editEvent`]({% slug api_scheduler_schedulercomponent %}#toc-editevent).
+ * Defines the options for the [`editEvent`](slug:api_scheduler_schedulercomponent#editevent) method of the Scheduler.
  */
 export interface EditEventArgs {
     /**
-     * The [`FormGroup`](https://angular.io/docs/ts/latest/api/forms/index/FormGroup-class.html)
-     * that describes the edit form.
+     * Provides the [`FormGroup`](https://angular.io/docs/ts/latest/api/forms/index/FormGroup-class.html) that describes the edit form.
      */
     group?: FormGroup;
     /**
-     * The selected edit mode of the event.
+     * Specifies the selected edit mode of the event.
      */
     mode?: EditMode;
 }

package/types/edit-mode.enum.d.ts

@@ -3,8 +3,8 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The selected edit mode during the update or removal of events.
- * For non-recurring events, set to `Event`.
+ * Represents the selected edit mode when you update or remove events.
+ * For non-recurring events, use `Event`.
  */
 export declare enum EditMode {
     /**

package/types/editable-settings.interface.d.ts

@@ -3,27 +3,27 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The editable settings of the Scheduler.
+ * Represents the editable settings of the Scheduler.
  */
 export interface EditableSettings {
     /**
-     * Specifies if the events can be removed by using a **Remove** icon.
+     * Specifies if the user can remove events using a **Remove** icon.
      */
     remove: boolean;
     /**
-     * Specifies if the events can be dragged.
+     * Specifies if the user can drag events.
      */
     drag: boolean;
     /**
-     * Specifies if the events can be resized.
+     * Specifies if the user can resize events.
      */
     resize: boolean;
     /**
-     * Specifies if new events can be added on [`slotDblClick`](slug:api_scheduler_schedulercomponent#toc-slotdblclick) when using the editing directives.
+     * Specifies if the user can add new events on [`slotDblClick`](slug:api_scheduler_schedulercomponent#toc-slotdblclick) when using the editing directives.
      */
     add: boolean;
     /**
-     * Specifies if the events can be edited on [`eventDblClick`](slug:api_scheduler_schedulercomponent#toc-eventdblclick) when using the editing directives.
+     * Specifies if the user can edit events on [`eventDblClick`](slug:api_scheduler_schedulercomponent#toc-eventdblclick) when using the editing directives.
      */
     edit: boolean;
 }

package/types/event-style-args.interface.d.ts

@@ -3,19 +3,19 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The arguments for the `eventStyles` and `eventClass` functions.
+ * Represents the arguments for the `eventStyles` and `eventClass` functions.
  */
 export interface EventStyleArgs {
     /**
-     * Specifies if the event is an all-day event. Applicable for the day and week views.
+     * Specifies if the event is an all-day event. Applies to **Day** and **Week** views.
      */
     isAllDay?: boolean;
     /**
-     * The event resources.
+     * Provides the event resources.
      */
     resources?: any[];
     /**
-     * The event.
+     * Provides the event.
      */
     event?: any;
 }

package/types/group.interface.d.ts

@@ -3,11 +3,11 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * An interface for the Scheduler groups.
+ * Represents an interface that describes the Scheduler groups.
  */
 export interface Group {
     /**
-     * An array of the resource names that will be grouped.
+     * Defines the array of resource names to group.
      */
     resources: string[];
     /**

package/types/numeric-options.interface.d.ts

@@ -4,40 +4,43 @@
 *-------------------------------------------------------------------------------------------*/
 import { NumberFormatOptions } from '@progress/kendo-angular-intl';
 /**
- * The available configuration options for the NumericTextBox components, used internally in the recurrence editor.
+ * Represents the available configuration options for the NumericTextBox components used in the recurrence editor.
  */
 export interface NumericTextBoxOptions {
     /**
-     * Specifies whether the value will be auto-corrected based on the minimum and maximum values
-     * ([see example]({% slug precision_numerictextbox %})).
+     * Specifies if the value is auto-corrected based on the minimum and maximum values
+     * [see example](slug:precision_numerictextbox).
      */
     autoCorrect?: boolean;
     /**
-     * Specifies the greatest value that is valid
-     * ([see example]({% slug precision_numerictextbox %}#toc-value-ranges)).
+     * Sets the greatest valid value
+     * [see example](slug:precision_numerictextbox#toc-value-ranges).
      */
     max?: number;
     /**
-     * Specifies the smallest value that is valid
-     * ([see example]({% slug precision_numerictextbox %}#toc-value-ranges)).
+     * Sets the smallest valid value
+     * [see example](slug:precision_numerictextbox#toc-value-ranges).
      */
     min?: number;
     /**
-     * Determines whether the NumericTextBox is in its read-only state ([see example]({% slug readonly_numerictextbox %})).
+     * Specifies if the NumericTextBox is in a read-only state
+     * [see example](slug:readonly_numerictextbox).
      */
     readonly?: boolean;
     /**
-     * Determines whether the whole value will be selected when the NumericTextBox is clicked. Defaults to `true`.
+     * Specifies if the whole value is selected when the NumericTextBox is clicked.
+     *
+     * @default true
      */
     selectOnFocus?: boolean;
     /**
-     * Specifies whether the **Up** and **Down** spin buttons will be rendered
-     * ([see example]({% slug spinbuttons_numerictextbox %})).
+     * Specifies if the **Up** and **Down** spin buttons are rendered
+     * [see example](slug:spinbuttons_numerictextbox).
      */
     spinners?: boolean;
     /**
-     * Specifies the value that is used to increment or decrement the component value
-     * ([see example]({% slug predefinedsteps_numerictextbox %})).
+     * Sets the value used to increment or decrement the component value
+     * [see example](slug:predefinedsteps_numerictextbox).
      */
     step?: number;
     /**
@@ -45,9 +48,10 @@ export interface NumericTextBoxOptions {
      */
     title?: string;
     /**
-     * Specifies the number format which is used when the NumericTextBox is not focused
-     * ([see example]({% slug formats_numerictextbox %})).
-     * If `format` is set to `null` or `undefined`, the default format will be used.
+     * Sets the number format used when the NumericTextBox is not focused
+     * [see example](slug:formats_numerictextbox).
+     *
+     * If `format` is `null` or `undefined`, the default format is used.
      */
     format: string | NumberFormatOptions | null | undefined;
 }

package/types/ongoing-events-settings.interface.d.ts

@@ -3,21 +3,23 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * The settings for the ongoing events highlight.
+ * Represents the settings for highlighting ongoing events.
  */
 export interface OngoingEventsSettings {
     /**
-     * The update interval (in milliseconds) of the ongoing events highlight.
-     * Defaults to `60000` (a minute).
+     * Sets the update interval in milliseconds for the ongoing events highlight.
+     *
+     * @default 60000
      */
     updateInterval?: number;
     /**
-     * Specifies if the ongoing events will be highlighted.
-     * Defaults to `true`.
+     * Specifies if ongoing events are highlighted.
+     *
+     * @default true
      */
     enabled?: boolean;
     /**
-     * Specifies a custom CSS class applied to ongoing events.
+     * Sets a custom CSS class for ongoing events.
      */
     cssClass?: string;
 }