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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (161) hide show
  1. package/data-binding.directive.d.ts +12 -3
  2. package/directives.d.ts +42 -2
  3. package/editing/edit-dialog-template.directive.d.ts +15 -2
  4. package/editing/recurrence/recurrence-editor.component.d.ts +29 -10
  5. package/editing/timezone-editor.component.d.ts +13 -3
  6. package/editing-directives/base-edit.service.d.ts +8 -11
  7. package/editing-directives/edit-service.interface.d.ts +22 -24
  8. package/editing-directives/reactive-editing.directive.d.ts +15 -2
  9. package/esm2022/data-binding.directive.mjs +12 -3
  10. package/esm2022/directives.mjs +42 -2
  11. package/esm2022/editing/edit-dialog-template.directive.mjs +15 -2
  12. package/esm2022/editing/recurrence/recurrence-editor.component.mjs +29 -10
  13. package/esm2022/editing/timezone-editor.component.mjs +13 -3
  14. package/esm2022/editing-directives/base-edit.service.mjs +8 -11
  15. package/esm2022/editing-directives/reactive-editing.directive.mjs +15 -2
  16. package/esm2022/events/add-event.mjs +3 -3
  17. package/esm2022/events/cancel-event.mjs +2 -2
  18. package/esm2022/events/create-event.mjs +6 -6
  19. package/esm2022/events/date-change-event.mjs +4 -4
  20. package/esm2022/events/drag-end-event.mjs +8 -8
  21. package/esm2022/events/drag-event.mjs +8 -8
  22. package/esm2022/events/drag-start-event.mjs +4 -4
  23. package/esm2022/events/edit-event.mjs +4 -4
  24. package/esm2022/events/event-click-event.mjs +5 -5
  25. package/esm2022/events/event-keydown-event.mjs +4 -4
  26. package/esm2022/events/navigate-event.mjs +3 -3
  27. package/esm2022/events/remove-event.mjs +4 -4
  28. package/esm2022/events/resize-end-event.mjs +6 -6
  29. package/esm2022/events/resize-event.mjs +8 -8
  30. package/esm2022/events/resize-start-event.mjs +4 -4
  31. package/esm2022/events/save-event.mjs +3 -3
  32. package/esm2022/events/slot-click-event.mjs +7 -7
  33. package/esm2022/events/slot-drag-end-event.mjs +1 -1
  34. package/esm2022/events/slot-drag-event.mjs +7 -7
  35. package/esm2022/events/slot-drag-start-event.mjs +8 -7
  36. package/esm2022/localization/custom-messages.component.mjs +14 -1
  37. package/esm2022/localization/messages.mjs +98 -98
  38. package/esm2022/package-metadata.mjs +2 -2
  39. package/esm2022/pdf/pdf-command.directive.mjs +11 -11
  40. package/esm2022/pdf/pdf-export-event.mjs +1 -1
  41. package/esm2022/pdf/pdf.component.mjs +19 -8
  42. package/esm2022/pdf/pdf.module.mjs +7 -8
  43. package/esm2022/scheduler.component.mjs +62 -62
  44. package/esm2022/scheduler.module.mjs +6 -7
  45. package/esm2022/toolbar/navigation.component.mjs +16 -7
  46. package/esm2022/toolbar/toolbar-template.directive.mjs +18 -10
  47. package/esm2022/toolbar/toolbar.service.mjs +3 -4
  48. package/esm2022/toolbar/view-selector.component.mjs +14 -8
  49. package/esm2022/types/crud-operation.enum.mjs +3 -3
  50. package/esm2022/types/edit-mode.enum.mjs +2 -2
  51. package/esm2022/types/scheduler-view.mjs +1 -1
  52. package/esm2022/views/agenda/agenda-view.component.mjs +15 -11
  53. package/esm2022/views/common/slot-selectable.directive.mjs +16 -4
  54. package/esm2022/views/month/month-view.component.mjs +17 -16
  55. package/esm2022/views/month/multi-week-view.component.mjs +20 -18
  56. package/esm2022/views/multi-day/day-view.component.mjs +12 -7
  57. package/esm2022/views/multi-day/multi-day-view.component.mjs +16 -11
  58. package/esm2022/views/multi-day/week-view.component.mjs +14 -11
  59. package/esm2022/views/multi-day/work-week-view.component.mjs +8 -1
  60. package/esm2022/views/scheduler-view.directive.mjs +13 -3
  61. package/esm2022/views/templates/agenda-date-template.directive.mjs +13 -3
  62. package/esm2022/views/templates/agenda-time-template.directive.mjs +13 -3
  63. package/esm2022/views/templates/all-day-event-template.directive.mjs +13 -3
  64. package/esm2022/views/templates/all-day-slot-template.directive.mjs +13 -3
  65. package/esm2022/views/templates/date-header-template.directive.mjs +14 -4
  66. package/esm2022/views/templates/event-template.directive.mjs +13 -3
  67. package/esm2022/views/templates/group-header-template.directive.mjs +14 -4
  68. package/esm2022/views/templates/major-time-header-template.directive.mjs +13 -3
  69. package/esm2022/views/templates/minor-time-header-template.directive.mjs +13 -3
  70. package/esm2022/views/templates/month-day-slot-template.directive.mjs +13 -3
  71. package/esm2022/views/templates/multi-week-day-slot-template.directive.mjs +12 -3
  72. package/esm2022/views/templates/time-slot-template.directive.mjs +14 -4
  73. package/esm2022/views/timeline/timeline-month-view.component.mjs +16 -11
  74. package/esm2022/views/timeline/timeline-view.component.mjs +16 -11
  75. package/esm2022/views/timeline/timeline-week-view.component.mjs +18 -14
  76. package/esm2022/views/view-context.service.mjs +6 -6
  77. package/esm2022/views/view-state.service.mjs +9 -9
  78. package/esm2022/views/year/year-view.component.mjs +12 -7
  79. package/events/add-event.d.ts +3 -3
  80. package/events/cancel-event.d.ts +2 -2
  81. package/events/create-event.d.ts +6 -6
  82. package/events/date-change-event.d.ts +4 -4
  83. package/events/drag-end-event.d.ts +8 -8
  84. package/events/drag-event.d.ts +8 -8
  85. package/events/drag-start-event.d.ts +4 -4
  86. package/events/edit-event.d.ts +4 -4
  87. package/events/event-click-event.d.ts +5 -5
  88. package/events/event-keydown-event.d.ts +4 -4
  89. package/events/navigate-event.d.ts +3 -3
  90. package/events/remove-event.d.ts +4 -4
  91. package/events/resize-end-event.d.ts +6 -6
  92. package/events/resize-event.d.ts +8 -8
  93. package/events/resize-start-event.d.ts +4 -4
  94. package/events/save-event.d.ts +3 -3
  95. package/events/slot-click-event.d.ts +7 -7
  96. package/events/slot-drag-end-event.d.ts +1 -1
  97. package/events/slot-drag-event.d.ts +7 -7
  98. package/events/slot-drag-start-event.d.ts +8 -7
  99. package/fesm2022/progress-kendo-angular-scheduler.mjs +876 -543
  100. package/localization/custom-messages.component.d.ts +14 -1
  101. package/localization/messages.d.ts +98 -98
  102. package/navigation/focus-position.interface.d.ts +2 -3
  103. package/package.json +15 -15
  104. package/pdf/pdf-command.directive.d.ts +11 -11
  105. package/pdf/pdf-export-event.d.ts +1 -1
  106. package/pdf/pdf.component.d.ts +19 -8
  107. package/pdf/pdf.module.d.ts +7 -8
  108. package/scheduler.component.d.ts +62 -62
  109. package/scheduler.module.d.ts +6 -7
  110. package/schematics/ngAdd/index.js +3 -3
  111. package/toolbar/navigation.component.d.ts +16 -7
  112. package/toolbar/toolbar-template.directive.d.ts +18 -10
  113. package/toolbar/toolbar.service.d.ts +3 -4
  114. package/toolbar/view-selector.component.d.ts +14 -8
  115. package/types/actions.d.ts +51 -45
  116. package/types/create-form-group-args.interface.d.ts +1 -1
  117. package/types/crud-operation.enum.d.ts +3 -3
  118. package/types/current-time-settings.interface.d.ts +10 -8
  119. package/types/date-range.interface.d.ts +7 -11
  120. package/types/datepicker-options.interface.d.ts +33 -38
  121. package/types/edit-event-args.interface.d.ts +3 -4
  122. package/types/edit-mode.enum.d.ts +2 -2
  123. package/types/editable-settings.interface.d.ts +6 -6
  124. package/types/event-style-args.interface.d.ts +4 -4
  125. package/types/group.interface.d.ts +2 -2
  126. package/types/numeric-options.interface.d.ts +20 -16
  127. package/types/ongoing-events-settings.interface.d.ts +8 -6
  128. package/types/resource.interface.d.ts +8 -8
  129. package/types/scheduler-event.d.ts +13 -15
  130. package/types/scheduler-model-fields.interface.d.ts +34 -23
  131. package/types/scheduler-slot.interface.d.ts +7 -7
  132. package/types/scheduler-view.d.ts +3 -5
  133. package/types/slot-class-args.interface.d.ts +6 -6
  134. package/types/view-item.interface.d.ts +1 -1
  135. package/views/agenda/agenda-view.component.d.ts +15 -11
  136. package/views/common/slot-selectable.directive.d.ts +16 -4
  137. package/views/month/month-view.component.d.ts +17 -16
  138. package/views/month/multi-week-view.component.d.ts +20 -18
  139. package/views/multi-day/day-view.component.d.ts +12 -7
  140. package/views/multi-day/multi-day-view.component.d.ts +16 -11
  141. package/views/multi-day/week-view.component.d.ts +14 -11
  142. package/views/multi-day/work-week-view.component.d.ts +8 -1
  143. package/views/scheduler-view.directive.d.ts +13 -3
  144. package/views/templates/agenda-date-template.directive.d.ts +13 -3
  145. package/views/templates/agenda-time-template.directive.d.ts +13 -3
  146. package/views/templates/all-day-event-template.directive.d.ts +13 -3
  147. package/views/templates/all-day-slot-template.directive.d.ts +13 -3
  148. package/views/templates/date-header-template.directive.d.ts +14 -4
  149. package/views/templates/event-template.directive.d.ts +13 -3
  150. package/views/templates/group-header-template.directive.d.ts +14 -4
  151. package/views/templates/major-time-header-template.directive.d.ts +13 -3
  152. package/views/templates/minor-time-header-template.directive.d.ts +13 -3
  153. package/views/templates/month-day-slot-template.directive.d.ts +13 -3
  154. package/views/templates/multi-week-day-slot-template.directive.d.ts +12 -3
  155. package/views/templates/time-slot-template.directive.d.ts +14 -4
  156. package/views/timeline/timeline-month-view.component.d.ts +16 -11
  157. package/views/timeline/timeline-view.component.d.ts +16 -11
  158. package/views/timeline/timeline-week-view.component.d.ts +18 -14
  159. package/views/view-context.service.d.ts +6 -6
  160. package/views/view-state.service.d.ts +9 -9
  161. package/views/year/year-view.component.d.ts +12 -7
@@ -10,21 +10,20 @@ import * as i1 from "./pdf.component";
10
10
  import * as i2 from "./pdf-command.directive";
11
11
  // IMPORTANT: NgModule export kept for backwards compatibility
12
12
  /**
13
- * Represents the [NgModule](https://angular.io/api/core/NgModule)
14
- * definition for the Scheduler PDF component.
13
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the Scheduler PDF component.
15
14
  *
16
- * ```ts
15
+ * @example
16
+ * ```typescript
17
17
  * import { NgModule } from '@angular/core';
18
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
18
+ * import { BrowserModule } from '@angular/platform-browser';
19
19
  * import { SchedulerModule, PDFModule } from '@progress/kendo-angular-scheduler';
20
20
  * import { AppComponent } from './app.component';
21
21
  *
22
22
  * @NgModule({
23
- * declarations: [AppComponent],
24
- * imports: [BrowserModule, SchedulerModule, PDFModule],
25
- * bootstrap: [AppComponent]
23
+ * declarations: [AppComponent],
24
+ * imports: [BrowserModule, SchedulerModule, PDFModule],
25
+ * bootstrap: [AppComponent]
26
26
  * })
27
- *
28
27
  * export class AppModule {}
29
28
  * ```
30
29
  */
@@ -62,7 +62,22 @@ import * as i9 from "./navigation";
62
62
  const todayDate = () => getDate(new Date());
63
63
  const DAYS_IN_WEEK = 7;
64
64
  /**
65
- * Represents the [Kendo UI Scheduler component for Angular]({% slug overview_scheduler %}).
65
+ * Represents the [Kendo UI Scheduler component for Angular](slug:overview_scheduler).
66
+ *
67
+ * @example
68
+ * ```html
69
+ * <kendo-scheduler [kendoSchedulerBinding]="events" [selectedDate]="selectedDate">
70
+ * <kendo-scheduler-day-view></kendo-scheduler-day-view>
71
+ * </kendo-scheduler>
72
+ * ```
73
+ *
74
+ * @remarks
75
+ * Supported children components are: {@link AgendaViewComponent},
76
+ * {@link WeekViewComponent}, {@link WorkWeekViewComponent}, {@link YearViewComponent},
77
+ * {@link SchedulerCustomMessagesComponent}, {@link TimelineMonthViewComponent},
78
+ * {@link TimelineViewComponent}, {@link TimelineWeekViewComponent}, {@link DayViewComponent},
79
+ * {@link MonthViewComponent}, {@link MultiDayViewComponent}, {@link MultiWeekViewComponent},
80
+ * {@link PDFComponent}, {@link TimeZoneEditorComponent}, {@link RecurrenceEditorComponent}
66
81
  */
67
82
  export class SchedulerComponent {
68
83
  wrapper;
@@ -85,10 +100,8 @@ export class SchedulerComponent {
85
100
  return this.direction;
86
101
  }
87
102
  /**
88
- * The index of the currently selected view.
89
- *
90
- * By default, the selected view index is `0` and
91
- * indicates that the first declared view is visible.
103
+ * Sets the index of the currently selected view. The default value is `0`, which shows the first declared view.
104
+ * @default 0
92
105
  */
93
106
  set selectedViewIndex(index) {
94
107
  this.viewIndex = index;
@@ -98,76 +111,71 @@ export class SchedulerComponent {
98
111
  return this.viewIndex;
99
112
  }
100
113
  /**
101
- * Specifies if the Scheduler is editable.
114
+ * Specifies whether the Scheduler is editable. Accepts a `boolean` or `EditableSettings` object.
115
+ * @default false
102
116
  */
103
117
  editable = false;
104
118
  /**
105
- * Specifies if the Scheduler's day or time slots are selectable ([see example]({% slug slotselection_scheduler %}#toc-custom-callback)).
106
- *
107
- * When this input is set to `true`, the Scheduler component will emit [`slotDragStart`]({% slug api_scheduler_schedulercomponent %}#toc-slotdragstart), [`slotDrag`]({% slug api_scheduler_schedulercomponent %}#toc-slotdrag), and [`slotDragEnd`]({% slug api_scheduler_schedulercomponent %}#toc-slotdragend) events upon user interaction.
119
+ * Specifies whether the Scheduler's day or time slots are selectable ([see example](slug:slotselection_scheduler#custom-callback)).
120
+ * When set to `true`, the Scheduler emits [`slotDragStart`]({% slug api_scheduler_schedulercomponent %}#toc-slotdragstart), [`slotDrag`]({% slug api_scheduler_schedulercomponent %}#toc-slotdrag), and [`slotDragEnd`]({% slug api_scheduler_schedulercomponent %}#toc-slotdragend) events on user interaction.
121
+ * @default false
108
122
  */
109
123
  selectable = false;
110
124
  /**
111
- * The minimum date that can be selected by using the navigation of the Scheduler.
125
+ * Sets the minimum date that you can select using the Scheduler navigation.
112
126
  */
113
127
  min;
114
128
  /**
115
- * The maximum date that can be selected by using the navigation of the Scheduler.
129
+ * Sets the maximum date that you can select using the Scheduler navigation.
116
130
  */
117
131
  max;
118
132
  /**
119
- * The height of the events in the **Month** and **Timeline** views, and the height of the **All day** events in the **Day** and **Week** views.
133
+ * Sets the height of events in the **Month** and **Timeline** views, and the height of **All day** events in the **Day** and **Week** views.
120
134
  * @default 25
121
135
  */
122
136
  eventHeight = 25;
123
137
  /**
124
- * Specifies the columns width. Applicable for the **Timeline** views.
138
+ * Sets the column width for **Timeline** views.
125
139
  * @default 100
126
140
  */
127
141
  columnWidth = 100;
128
142
  /**
129
- * If set to `true`, the view will be initially shown in the business-hours mode.
130
- * By default, the view is displayed in the full-day mode. Applicable for the **Day**, **Week**, and **Timeline** views.
143
+ * Sets whether the view shows business hours on initialization. By default, the view shows full-day hours. Applies to **Day**, **Week**, and **Timeline** views.
131
144
  * @default false
132
145
  */
133
146
  showWorkHours;
134
147
  /**
135
- * The start time of the view. The Scheduler displays events which start after the start time.
136
- * Accepts string values in the `HH:mm` format. Applicable for the **Day**, **Week**, and **Timeline** views.
148
+ * Sets the start time of the view. Accepts a string in `HH:mm` format. Applies to **Day**, **Week**, and **Timeline** views.
137
149
  * @default '00:00'
138
150
  */
139
151
  startTime = '00:00';
140
152
  /**
141
- * The end time of the view. The Scheduler displays events which end before the end time.
142
- * Accepts string values in the `HH:mm` format. Applicable for the **Day**, **Week**, and **Timeline** views.
153
+ * Sets the end time of the view. Accepts a string in `HH:mm` format. Applies to **Day**, **Week**, and **Timeline** views.
143
154
  * @default '00:00'
144
155
  */
145
156
  endTime = '00:00';
146
157
  /**
147
- * The start time of the view when `showWorkHours` is set to `true`.
148
- * Accepts string values in the `HH:mm` format. Applicable for the **Day**, **Week**, and **Timeline** views.
158
+ * Sets the start time of the view when `showWorkHours` is `true`. Accepts a string in `HH:mm` format. Applies to **Day**, **Week**, and **Timeline** views.
149
159
  * @default '08:00'
150
160
  */
151
161
  workDayStart = '08:00';
152
162
  /**
153
- * The end time of the view when `showWorkHours` is set to `true`.
154
- * Accepts string values in the `HH:mm` format. Applicable for the **Day**, **Week**, and **Timeline** views.
163
+ * Sets the end time of the view when `showWorkHours` is `true`. Accepts a string in `HH:mm` format. Applies to **Day**, **Week**, and **Timeline** views.
155
164
  * @default '17:00'
156
165
  */
157
166
  workDayEnd = '17:00';
158
167
  /**
159
- * The start of the work week. Applicable for the **Day**, **Week**, and **Timeline** views.
168
+ * Sets the start of the work week. Applies to **Day**, **Week**, and **Timeline** views.
160
169
  * @default 1
161
170
  */
162
171
  workWeekStart;
163
172
  /**
164
- * The end of the work week. Applicable for the **Day**, **Week**, and **Timeline** views.
173
+ * Sets the end of the work week. Applies to **Day**, **Week**, and **Timeline** views.
165
174
  * @default 5
166
175
  */
167
176
  workWeekEnd;
168
177
  /**
169
- * The first day of the week. Applicable to **Week**, **Month** and **TimelineWeek** views.
170
- * Defaults to the locale settings.
178
+ * Sets the first day of the week. Applies to **Week**, **Month**, and **TimelineWeek** views. Defaults to the locale settings.
171
179
  */
172
180
  set weekStart(value) {
173
181
  this._weekStart = value;
@@ -179,35 +187,32 @@ export class SchedulerComponent {
179
187
  return this.intlService.firstDay();
180
188
  }
181
189
  /**
182
- * The duration (in minutes) of the time slots. Applicable for the day, week and timeline views.
190
+ * Sets the duration (in minutes) of the time slots. Applies to **Day**, **Week**, and **Timeline** views.
183
191
  * @default 60
184
192
  */
185
193
  slotDuration = 60;
186
194
  /**
187
- * The number of divisions of the time slots. Applicable for the **Day**, **Week**, and **Timeline** views.
195
+ * Sets the number of divisions for the time slots. Applies to **Day**, **Week**, and **Timeline** views.
188
196
  * @default 2
189
197
  */
190
198
  slotDivisions = 2;
191
199
  /**
192
- * A numeric value between 0 and 1 that specifies what percentage of the slot will be filled by the events.
193
- * Applicable for the **Day** and **Week** views.
200
+ * Sets the percentage of the slot filled by events. Accepts a value between 0 and 1. Applies to **Day** and **Week** views.
194
201
  * @default 0.9
195
202
  */
196
203
  slotFill = 0.9;
197
204
  /**
198
- * Toggles the visibility of the all-day slot.
199
- * Applicable for the **Day**, **Multi-Day**, **Week**, and **Work-Week** views.
205
+ * Toggles the visibility of the all-day slot. Applies to **Day**, **Multi-Day**, **Week**, and **Work-Week** views.
200
206
  * @default true
201
207
  */
202
208
  allDaySlot = true;
203
209
  /**
204
- * The time to which the view will initially be scrolled.
205
- * Accepts string values in the `HH:mm` format or a JavaScript `Date`. Applicable for the **Day**, **Week**, and **Timeline** views.
210
+ * Sets the time to which the view initially scrolls. Accepts a string in `HH:mm` format or a JavaScript `Date` object. Applies to **Day**, **Week**, and **Timeline** views.
206
211
  * @default '08:00'
207
212
  */
208
213
  scrollTime = this.workDayStart;
209
214
  /**
210
- * Specifies the groups of the Scheduler.
215
+ * Defines the Scheduler groups.
211
216
  */
212
217
  group;
213
218
  /**
@@ -215,13 +220,12 @@ export class SchedulerComponent {
215
220
  */
216
221
  resources;
217
222
  /**
218
- * Specifies if the Scheduler will display a loading indicator.
223
+ * Specifies whether the Scheduler displays a loading indicator.
219
224
  * @default false
220
225
  */
221
226
  loading;
222
227
  /**
223
- * Specifies the id of the timezone that will be displayed in the Scheduler.
224
- * For example, `Europe/Sofia`.
228
+ * Sets the timezone ID displayed in the Scheduler. For example, `Europe/Sofia`.
225
229
  * @default 'Etc/UTC'
226
230
  */
227
231
  set timezone(value) {
@@ -236,7 +240,7 @@ export class SchedulerComponent {
236
240
  */
237
241
  selectedView;
238
242
  /**
239
- * An array of event instances which will be shown by the Scheduler.
243
+ * Sets the array of event instances shown by the Scheduler.
240
244
  */
241
245
  set events(value) {
242
246
  this._events = value;
@@ -246,8 +250,7 @@ export class SchedulerComponent {
246
250
  return this._events;
247
251
  }
248
252
  /**
249
- * The currently selected date of the Scheduler.
250
- * Determines the period which is displayed.
253
+ * Sets the currently selected date of the Scheduler. Determines the displayed period.
251
254
  */
252
255
  set selectedDate(value) {
253
256
  if (!value) {
@@ -260,8 +263,7 @@ export class SchedulerComponent {
260
263
  return this._selectedDate;
261
264
  }
262
265
  /**
263
- * The names of the model fields from which the Scheduler will read its data
264
- * ([see example]({% slug databinding_scheduler %}#toc-binding-to-models)).
266
+ * Sets the names of the model fields from which the Scheduler reads its data ([see example](slug:databinding_scheduler#binding-to-models).
265
267
  */
266
268
  set modelFields(value) {
267
269
  this._modelFields = { ...defaultModelFields, ...value };
@@ -270,42 +272,42 @@ export class SchedulerComponent {
270
272
  return this._modelFields;
271
273
  }
272
274
  /**
273
- * Specifies the Scheduler current time marker settings.
275
+ * Sets the Scheduler current time marker settings.
274
276
  * @default true
275
277
  */
276
278
  currentTimeMarker = true;
277
279
  /**
278
- * Specifies the settings for the ongoing events highlight of the Scheduler.
280
+ * Defines the settings for highlighting ongoing events in the Scheduler.
279
281
  * @default true
280
282
  */
281
283
  highlightOngoingEvents = true;
282
284
  /**
283
- * Specifies whether to display the toolbar of the Scheduler.
285
+ * Specifies whether to display the Scheduler toolbar.
284
286
  * @default true
285
287
  */
286
288
  showToolbar = true;
287
289
  /**
288
- * Specifies whether to display the footer of the Scheduler.
290
+ * Specifies whether to display the Scheduler footer.
289
291
  * @default true
290
292
  */
291
293
  showFooter = true;
292
294
  /**
293
295
  * Defines a function that is executed for every slot in the view.
294
- * The function returns a value which is supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
296
+ * The function returns a value supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
295
297
  */
296
298
  slotClass;
297
299
  /**
298
300
  * Defines a function that is executed for every event in the view.
299
- * The function returns a value which is supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
301
+ * The function returns a value supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
300
302
  */
301
303
  eventClass;
302
304
  /**
303
305
  * Defines a function that is executed for every event in the view.
304
- * The function returns a value which is supported by [`ngStyle`](link:site.data.urls.angular['ngstyleapi']).
306
+ * The function returns a value supported by [`ngStyle`](link:site.data.urls.angular['ngstyleapi']).
305
307
  */
306
308
  eventStyles;
307
309
  /**
308
- * A callback that executes for each slot of the Scheduler view.
310
+ * A callback that is executed for each slot of the Scheduler view.
309
311
  * If it returns `true`, the `k-selected` CSS class will be added to the cell, making it visibly selected.
310
312
  * @default () => false
311
313
  */
@@ -315,16 +317,15 @@ export class SchedulerComponent {
315
317
  */
316
318
  selectedViewIndexChange = new EventEmitter();
317
319
  /**
318
- * Fires when the Scheduler is about to execute a navigation action
319
- * (a view, date, or focus change).
320
+ * Emits when the Scheduler is about to perform a navigation action, such as changing the view, date, or focus.
320
321
  */
321
322
  navigate = new EventEmitter();
322
323
  /**
323
- * Fires when the date range that is displayed in the Scheduler changes.
324
+ * Emits when the displayed date range in the Scheduler changes.
324
325
  */
325
326
  dateChange = new EventEmitter();
326
327
  /**
327
- * Fires when a Scheduler view slot is clicked.
328
+ * Emits when a Scheduler view slot is clicked.
328
329
  */
329
330
  slotClick = new EventEmitter();
330
331
  /**
@@ -332,8 +333,7 @@ export class SchedulerComponent {
332
333
  */
333
334
  slotDblClick = new EventEmitter();
334
335
  /**
335
- * Fires when the user creates a new event using the `'c'` key.
336
- * ([see example]({% slug keyboard_navigation_scheduler %})).
336
+ * Emits when the user creates a new event using the `'c'` key ([see example](slug:keyboard_navigation_scheduler)).
337
337
  */
338
338
  create = new EventEmitter();
339
339
  /**
@@ -345,7 +345,7 @@ export class SchedulerComponent {
345
345
  */
346
346
  eventDblClick = new EventEmitter();
347
347
  /**
348
- * Fires when a key is pressed on a focused Scheduler event.
348
+ * Emits when you press a key on a focused Scheduler event.
349
349
  */
350
350
  eventKeydown = new EventEmitter();
351
351
  /**
@@ -365,7 +365,7 @@ export class SchedulerComponent {
365
365
  */
366
366
  resizeStart = new EventEmitter();
367
367
  /**
368
- * Fires when the user is resizing a Scheduler event.
368
+ * Emits while the user is resizing a Scheduler event.
369
369
  */
370
370
  resize = new EventEmitter();
371
371
  /**
@@ -377,7 +377,7 @@ export class SchedulerComponent {
377
377
  */
378
378
  dragStart = new EventEmitter();
379
379
  /**
380
- * Fires when the user is dragging a Scheduler event.
380
+ * Fires while the user is dragging a Scheduler event.
381
381
  */
382
382
  drag = new EventEmitter();
383
383
  /**
@@ -389,7 +389,7 @@ export class SchedulerComponent {
389
389
  */
390
390
  slotDragStart = new EventEmitter();
391
391
  /**
392
- * Fires when the user is drag-selecting a Scheduler slot range.
392
+ * Fires while the user is drag-selecting a Scheduler slot range.
393
393
  */
394
394
  slotDrag = new EventEmitter();
395
395
  /**
@@ -54,21 +54,20 @@ import * as i37 from "./views/templates/multi-week-day-slot-template.directive";
54
54
  import * as i38 from "./views/templates/time-slot-template.directive";
55
55
  // IMPORTANT: NgModule export kept for backwards compatibility
56
56
  /**
57
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
58
- * definition for the Scheduler component.
57
+ * Represents the [`NgModule`](link:site.data.urls.angular['ngmoduleapi']) definition for the Scheduler component.
59
58
  *
59
+ * @example
60
60
  * ```ts
61
61
  * import { NgModule } from '@angular/core';
62
- * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
62
+ * import { BrowserModule } from '@angular/platform-browser';
63
63
  * import { SchedulerModule } from '@progress/kendo-angular-scheduler';
64
64
  * import { AppComponent } from './app.component';
65
65
  *
66
66
  * @NgModule({
67
- * declarations: [AppComponent],
68
- * imports: [BrowserModule, SchedulerModule],
69
- * bootstrap: [AppComponent]
67
+ * declarations: [AppComponent],
68
+ * imports: [BrowserModule, SchedulerModule],
69
+ * bootstrap: [AppComponent]
70
70
  * })
71
- *
72
71
  * export class AppModule {}
73
72
  * ```
74
73
  */
@@ -20,12 +20,21 @@ import * as i3 from "@progress/kendo-angular-l10n";
20
20
  import * as i4 from "../views/view-context.service";
21
21
  const iconsMap = { caretAltLeftIcon, caretAltRightIcon, calendarIcon };
22
22
  /**
23
- * A toolbar component which contains the controls for date navigation
24
- * ([see example]({% slug toolbar_scheduler %}#toc-including-the-built-in-components)).
23
+ * A toolbar component that contains controls for date navigation
24
+ * ([see example](slug:toolbar_scheduler#toc-including-the-built-in-components)).
25
25
  *
26
- * To render the **Previous**, **Today**, **Next**, and **Date picker**
27
- * buttons, include the component in the
28
- * [toolbar template]({% slug api_scheduler_toolbartemplatedirective %}).
26
+ * To render the **Previous**, **Today**, **Next**, and **Date picker** buttons, include this component in the [toolbar template](slug:api_scheduler_toolbartemplatedirective).
27
+ *
28
+ * @example
29
+ * ```html
30
+ * <kendo-scheduler>
31
+ * <ng-template kendoSchedulerToolbarTemplate>
32
+ * <span class="custom-toolbar">
33
+ * <div kendoSchedulerToolbarNavigation></div>
34
+ * </span>
35
+ * </ng-template>
36
+ * </kendo-scheduler>
37
+ * ```
29
38
  */
30
39
  export class ToolbarNavigationComponent {
31
40
  popupService;
@@ -54,13 +63,13 @@ export class ToolbarNavigationComponent {
54
63
  return this.localization.get('today');
55
64
  }
56
65
  /**
57
- * Sets the [`activeView`]({% slug api_dateinputs_calendarcomponent %}#toc-activeview) of the Calendar in the navigation component.
66
+ * Sets the [`activeView`](slug:api_dateinputs_calendarcomponent#toc-activeview) of the Calendar in the navigation component.
58
67
  *
59
68
  * @default month
60
69
  */
61
70
  activeView = 'month';
62
71
  /**
63
- * Sets the [`bottomView`]({% slug api_dateinputs_calendarcomponent %}#toc-bottomview) of the Calendar in the navigation component.
72
+ * Sets the [`bottomView`](slug:api_dateinputs_calendarcomponent#toc-bottomview) of the Calendar in the navigation component.
64
73
  *
65
74
  * @default month
66
75
  */
@@ -5,23 +5,31 @@
5
5
  import { Directive, Optional, TemplateRef } from '@angular/core';
6
6
  import * as i0 from "@angular/core";
7
7
  /**
8
- * Represents the toolbar template of the Scheduler. To define a toolbar
9
- * template, nest an `<ng-template kendoSchedulerToolbarTemplate>` tag
10
- * inside `<kendo-scheduler>`. For more information and examples, refer to the article on
11
- * [customizing the toolbar]({% slug toolbar_scheduler %}) of the Scheduler.
8
+ * Represents the toolbar template of the Scheduler. To define a toolbar template, nest an `<ng-template kendoSchedulerToolbarTemplate>` tag inside the `<kendo-scheduler>`. For more information and examples, see [customizing the toolbar](slug:toolbar_scheduler) article.
12
9
  *
13
- * The template context receives the following template variables:
10
+ * The template context provides the following variables:
14
11
  * * `selectedDate`&mdash;The currently selected date.
15
- * * `dateRange`&mdash;The currently selected [`DateRange`]({% slug api_scheduler_daterange %}).
16
- * * `views`&mdash;A [`SchedulerView`]({% slug api_scheduler_schedulerview %}) array with the available views.
17
- * * `selectedView`&mdash;The currently selected [`SchedulerView`]({% slug api_scheduler_schedulerview %}).
12
+ * * `dateRange`&mdash;The currently selected [`DateRange`](slug:api_scheduler_daterange).
13
+ * * `views`&mdash;An array of [`SchedulerView`](slug:api_scheduler_schedulerview) instances with the available views.
14
+ * * `selectedView`&mdash;The currently selected [`SchedulerView`](slug:api_scheduler_schedulerview).
18
15
  *
19
16
  * You can declare either of the following built-in navigation components in the toolbar template:
20
17
  * * `kendoSchedulerToolbarNavigation`&mdash;Renders navigation buttons, a calendar, and a date-range label.
21
18
  * * `kendoSchedulerToolbarViewSelector`&mdash;Renders the buttons for selecting the view.
22
19
  *
23
- * To emit navigation events, the components inside the toolbar can inject
24
- * the [`ToolbarService`]({% slug api_scheduler_toolbarservice %}).
20
+ * To emit navigation events, components inside the toolbar can inject the [`ToolbarService`](slug:api_scheduler_toolbarservice).
21
+ *
22
+ * @example
23
+ * ```html
24
+ * <kendo-scheduler>
25
+ * <ng-template kendoSchedulerToolbarTemplate let-selectedDate="selectedDate">
26
+ * <div class="custom-toolbar">
27
+ * <span>Selected Date: {{ selectedDate | date: 'longDate' }}</span>
28
+ * <button kendoButton (click)="navigateToToday()">Today</button>
29
+ * </div>
30
+ * </ng-template>
31
+ * </kendo-scheduler>
32
+ * ```
25
33
  */
26
34
  export class ToolbarTemplateDirective {
27
35
  templateRef;
@@ -6,9 +6,8 @@ import { Injectable } from '@angular/core';
6
6
  import { Subject } from 'rxjs';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * A service for communication with the toolbar controls
10
- * which is used by the toolbar components for publishing navigation actions
11
- * ([see example]({% slug toolbar_scheduler %}#toc-using-the-toolbar-service)).
9
+ * Represents a service for communication with toolbar controls. Toolbar components use this service to publish navigation actions
10
+ * ([see example](slug:toolbar_scheduler#toc-using-the-toolbar-service)).
12
11
  */
13
12
  export class ToolbarService {
14
13
  /**
@@ -31,7 +30,7 @@ export class ToolbarService {
31
30
  /**
32
31
  * Emits the specified navigation action.
33
32
  *
34
- * @param action - The navigation action that will be executed.
33
+ * @param action The navigation action to execute.
35
34
  */
36
35
  navigate(action) {
37
36
  this.actionSource.next(action);
@@ -12,23 +12,29 @@ import * as i0 from "@angular/core";
12
12
  import * as i1 from "./toolbar.service";
13
13
  import * as i2 from "@progress/kendo-angular-l10n";
14
14
  /**
15
- * A toolbar component which contains the controls for switching the views
16
- * ([see example]({% slug toolbar_scheduler %}#toc-including-the-built-in-components)).
15
+ * A toolbar component that contains controls for switching views
16
+ * ([see example](slug:toolbar_scheduler#toc-including-the-built-in-components)).
17
17
  *
18
- * To render the view-selection buttons, include the component in the
19
- * [toolbar template]({% slug api_scheduler_toolbartemplatedirective %}).
18
+ * To render the view-selection buttons, include this component in the [toolbar template](slug:api_scheduler_toolbartemplatedirective).
19
+ *
20
+ * @example
21
+ * ```html
22
+ * <kendo-scheduler>
23
+ * <ng-template kendoSchedulerToolbarTemplate>
24
+ * <div kendoSchedulerToolbarViewSelector responsiveBreakpoint]="960"></div>
25
+ * </ng-template>
26
+ * </kendo-scheduler>
27
+ * ```
20
28
  */
21
29
  export class ToolbarViewSelectorComponent {
22
30
  service;
23
31
  localization;
24
32
  /**
25
- * Specifies the current width of the Toolbar (in pixels) so the responsive calculations can be made.
26
- * The ([schedulerResize]({% slug api_scheduler_schedulercomponent %}#toc-schedulerresize)) event can be used in order to obtain the Toolbar width.
33
+ * Sets the current width of the Toolbar in pixels for responsive calculations. Use the [`schedulerResize`](slug:api_scheduler_schedulercomponent#toc-schedulerresize) event to get the Toolbar width.
27
34
  */
28
35
  toolbarWidth;
29
36
  /**
30
- * Specifies the Toolbar width (in pixels) at which the responsive behavior should be enabled.
31
- * The responsive behavior means that the ButtonGroup with the views will be replaced by a `select` element.
37
+ * Sets the Toolbar width in pixels at which responsive behavior is enabled. When enabled, the ButtonGroup with the views is replaced by a `select` element.
32
38
  *
33
39
  * @default 1024
34
40
  */
@@ -3,16 +3,16 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * The selected CRUD operation when the user edits or removes recurring events.
6
+ * Represents the selected CRUD operation when the user edits or removes recurring events.
7
7
  */
8
8
  export var CrudOperation;
9
9
  (function (CrudOperation) {
10
10
  /**
11
- * The user edits the selected recurring event.
11
+ * Indicates that the selected recurring event is edited.
12
12
  */
13
13
  CrudOperation[CrudOperation["Edit"] = 0] = "Edit";
14
14
  /**
15
- * The user removes the selected recurring event.
15
+ * Indicates that the selected recurring event is removed.
16
16
  */
17
17
  CrudOperation[CrudOperation["Remove"] = 1] = "Remove";
18
18
  })(CrudOperation || (CrudOperation = {}));
@@ -3,8 +3,8 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * The selected edit mode during the update or removal of events.
7
- * For non-recurring events, set to `Event`.
6
+ * Represents the selected edit mode when you update or remove events.
7
+ * For non-recurring events, use `Event`.
8
8
  */
9
9
  export var EditMode;
10
10
  (function (EditMode) {
@@ -3,7 +3,7 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * An abstract class which contains meta information about a Scheduler view.
6
+ * Contains meta information about a Scheduler view.
7
7
  */
8
8
  export class SchedulerView {
9
9
  }
@@ -15,7 +15,14 @@ import * as i1 from "@progress/kendo-angular-l10n";
15
15
  import * as i2 from "../view-context.service";
16
16
  import * as i3 from "../view-state.service";
17
17
  /**
18
- * The component for rendering the **Agenda** view.
18
+ * Represents the component that renders the **Agenda** view in the Scheduler.
19
+ *
20
+ * @example
21
+ * ```html
22
+ * <kendo-scheduler>
23
+ * <kendo-scheduler-agenda-view></kendo-scheduler-agenda-view>
24
+ * </kendo-scheduler>
25
+ * ```
19
26
  */
20
27
  export class AgendaViewComponent extends ConfigurationViewBase {
21
28
  /**
@@ -25,19 +32,16 @@ export class AgendaViewComponent extends ConfigurationViewBase {
25
32
  return this.localization.get('agendaViewTitle');
26
33
  }
27
34
  /**
28
- * The long-date format for displaying the
29
- * selected date in the Scheduler toolbar.
30
- * Defaults to `{0:D} - {1:D}`,
31
- * where `0` is the start and `1` is the end date
32
- * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
35
+ * Sets the long-date format for the selected date in the Scheduler toolbar.
36
+ * Defaults to `'{0:D} - {1:D}'`, where `0` is the start and `1` is the end date.
37
+ * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
38
+ * @default '{0:D} - {1:D}'
33
39
  */
34
40
  selectedDateFormat = '{0:D} - {1:D}';
35
41
  /**
36
- * The short-date format for displaying the
37
- * selected date in the Scheduler toolbar.
38
- * Defaults to `{0:d} - {1:d}`,
39
- * where `0` is the start and `1` is the end date
40
- * ([more information]({% slug parsingandformatting_intl %}#toc-date-formatting)).
42
+ * Sets the short-date format for the selected date in the Scheduler toolbar.
43
+ * Defaults to `'{0:d} - {1:d}'`, where `0` is the start and `1` is the end date.
44
+ * For more information, see [Parsing and Formatting Dates and Numbers](slug:parsingandformatting_intl#date-formatting).
41
45
  * @default '{0:d} - {1:d}'
42
46
  */
43
47
  selectedShortDateFormat = '{0:d} - {1:d}';