@progress/kendo-angular-dialog 19.1.2-develop.1 → 19.1.2-develop.3

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 (61) hide show
  1. package/common/actions-layout.d.ts +4 -1
  2. package/common/animation-types.d.ts +3 -0
  3. package/common/dialog-animation-direction.d.ts +3 -0
  4. package/common/preventable-event.d.ts +4 -0
  5. package/dialog/dialog-actions.component.d.ts +5 -4
  6. package/dialog/dialog-container.directive.d.ts +3 -4
  7. package/dialog/dialog-content-base.d.ts +3 -2
  8. package/dialog/dialog-titlebar.component.d.ts +3 -2
  9. package/dialog/dialog.component.d.ts +56 -33
  10. package/dialog/dialog.service.d.ts +15 -36
  11. package/dialog/models/dialog-action-divider.d.ts +4 -1
  12. package/dialog/models/dialog-action.d.ts +10 -9
  13. package/dialog/models/dialog-animation.d.ts +7 -4
  14. package/dialog/models/dialog-close-result.d.ts +4 -3
  15. package/dialog/models/dialog-ref.d.ts +8 -16
  16. package/dialog/models/dialog-result.d.ts +5 -5
  17. package/dialog/models/dialog-settings.d.ts +33 -44
  18. package/dialog/models/theme-color.d.ts +6 -5
  19. package/dialog.module.d.ts +6 -8
  20. package/dialogs.module.d.ts +5 -9
  21. package/directives.d.ts +54 -6
  22. package/esm2022/common/preventable-event.mjs +4 -0
  23. package/esm2022/dialog/dialog-actions.component.mjs +5 -4
  24. package/esm2022/dialog/dialog-container.directive.mjs +3 -4
  25. package/esm2022/dialog/dialog-content-base.mjs +3 -2
  26. package/esm2022/dialog/dialog-titlebar.component.mjs +3 -2
  27. package/esm2022/dialog/dialog.component.mjs +56 -33
  28. package/esm2022/dialog/dialog.service.mjs +15 -36
  29. package/esm2022/dialog/models/dialog-action.mjs +10 -9
  30. package/esm2022/dialog/models/dialog-close-result.mjs +4 -3
  31. package/esm2022/dialog/models/dialog-ref.mjs +8 -16
  32. package/esm2022/dialog/models/dialog-settings.mjs +33 -44
  33. package/esm2022/dialog.module.mjs +6 -8
  34. package/esm2022/dialogs.module.mjs +5 -9
  35. package/esm2022/directives.mjs +54 -6
  36. package/esm2022/localization/custom-messages.component.mjs +23 -2
  37. package/esm2022/localization/messages.mjs +4 -4
  38. package/esm2022/package-metadata.mjs +2 -2
  39. package/esm2022/window/models/window-close-result.mjs +2 -1
  40. package/esm2022/window/models/window-ref.mjs +5 -16
  41. package/esm2022/window/models/window-settings.mjs +20 -29
  42. package/esm2022/window/window-container.directive.mjs +3 -4
  43. package/esm2022/window/window-titlebar.component.mjs +4 -0
  44. package/esm2022/window/window.component.mjs +29 -46
  45. package/esm2022/window/window.service.mjs +11 -31
  46. package/esm2022/window.module.mjs +6 -8
  47. package/fesm2022/progress-kendo-angular-dialog.mjs +318 -319
  48. package/localization/custom-messages.component.d.ts +23 -2
  49. package/localization/messages.d.ts +4 -4
  50. package/package.json +7 -7
  51. package/schematics/ngAdd/index.js +1 -1
  52. package/window/models/theme-color.d.ts +1 -1
  53. package/window/models/window-close-result.d.ts +2 -1
  54. package/window/models/window-messages.d.ts +2 -2
  55. package/window/models/window-ref.d.ts +5 -16
  56. package/window/models/window-settings.d.ts +20 -29
  57. package/window/window-container.directive.d.ts +3 -4
  58. package/window/window-titlebar.component.d.ts +4 -0
  59. package/window/window.component.d.ts +29 -46
  60. package/window/window.service.d.ts +11 -31
  61. package/window.module.d.ts +6 -8
@@ -21,13 +21,14 @@ import { offset, scrollPosition, positionWithScroll, getDocumentElement, getWind
21
21
  import { IconWrapperComponent, IconsService } from '@progress/kendo-angular-icons';
22
22
 
23
23
  /**
24
- * Specifies the action buttons of the Dialog
25
- * ([see example]({% slug actionbuttons_dialog %})).
24
+ * Represents the action buttons of the Dialog.
25
+ * ([See example.]({% slug actionbuttons_dialog %}))
26
+ *
26
27
  */
27
28
  class DialogActionsComponent {
28
29
  el;
29
30
  /**
30
- * Allows the declarative specification of the actions.
31
+ * Allows the declarative specification of the Dialog `actions`.
31
32
  */
32
33
  set actions(value) {
33
34
  if (value instanceof TemplateRef) {
@@ -49,7 +50,7 @@ class DialogActionsComponent {
49
50
  */
50
51
  actionsTemplate;
51
52
  /**
52
- * Specifies the possible layout of the action buttons.
53
+ * Sets the possible layout of the action buttons.
53
54
  * @default 'stretched'
54
55
  */
55
56
  layout = 'stretched';
@@ -180,6 +181,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
180
181
  args: ['class.k-actions-stretched']
181
182
  }] } });
182
183
 
184
+ /**
185
+ * Represents a preventable event in Dialog and Window components.
186
+ *
187
+ */
183
188
  class PreventableEvent {
184
189
  prevented = false;
185
190
  /**
@@ -250,19 +255,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
250
255
  */
251
256
  class Messages extends ComponentMessages {
252
257
  /**
253
- * The title of the close button.
258
+ * Sets the title for the **Close** button.
254
259
  */
255
260
  closeTitle;
256
261
  /**
257
- * The title of the restore button.
262
+ * Sets the title for the **Restore** button.
258
263
  */
259
264
  restoreTitle;
260
265
  /**
261
- * The title of the maximize button.
266
+ * Sets the title for the **Maximize** button.
262
267
  */
263
268
  maximizeTitle;
264
269
  /**
265
- * The title of the minimize button.
270
+ * Sets the title for the **Minimize** button.
266
271
  */
267
272
  minimizeTitle;
268
273
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: Messages, deps: null, target: i0.ɵɵFactoryTarget.Directive });
@@ -322,14 +327,15 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
322
327
  /**
323
328
  * Represents the [Kendo UI DialogTitleBar component for Angular]({% slug api_dialog_dialogtitlebarcomponent %}).
324
329
  *
325
- * It is used as part of the Dialog content when the component is created dynamically by using an [Angular service]({% slug service_dialog %}).
330
+ * Use this component as part of the Dialog content when you create the Dialog dynamically with an [Angular service]({% slug service_dialog %}).
331
+ *
326
332
  */
327
333
  class DialogTitleBarComponent {
328
334
  zone;
329
335
  hostElement;
330
336
  localizationService;
331
337
  /**
332
- * Fires when the close button of the title-bar is clicked.
338
+ * Fires when the close button in the title bar is clicked.
333
339
  */
334
340
  close = new EventEmitter();
335
341
  /**
@@ -475,8 +481,8 @@ const packageMetadata = {
475
481
  productName: 'Kendo UI for Angular',
476
482
  productCode: 'KENDOUIANGULAR',
477
483
  productCodes: ['KENDOUIANGULAR'],
478
- publishDate: 1749804135,
479
- version: '19.1.2-develop.1',
484
+ publishDate: 1750152445,
485
+ version: '19.1.2-develop.3',
480
486
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
481
487
  };
482
488
 
@@ -659,9 +665,10 @@ const findPrimaryButton = (buttons) => {
659
665
  };
660
666
 
661
667
  /**
662
- * Indicates that the **Close** button is clicked. Used when the results from
663
- * the Dialogs that are opened through `DialogService` are filtered
664
- * ([see example]({% slug api_dialog_dialogservice %}#toc-open)).
668
+ * Represents the result when the **Close** button is clicked in a Dialog opened through `DialogService`.
669
+ *
670
+ * Used when the results from the Dialogs that are opened through `DialogService` are filtered. ([See example.]({% slug api_dialog_dialogservice %}#toc-open))
671
+ *
665
672
  */
666
673
  class DialogCloseResult {
667
674
  }
@@ -767,6 +774,23 @@ const animateContent = (animation, defAnimationConfig, animatedElement, builder)
767
774
  const DEFAULT_ANIMATION_CONFIG = { duration: 300, type: 'translate' };
768
775
  /**
769
776
  * Represents the [Kendo UI Dialog component for Angular]({% slug overview_dialog_dialogs %}).
777
+ *
778
+ * Use this component to display modal dialog windows in your application.
779
+ *
780
+ * @example
781
+ * ```ts
782
+ * import { Component } from '@angular/core';
783
+ *
784
+ * @Component({
785
+ * selector: 'my-app',
786
+ * template: `
787
+ * <kendo-dialog title="Example Dialog">
788
+ * <p>Dialog content goes here.</p>
789
+ * </kendo-dialog>
790
+ * `
791
+ * })
792
+ * export class AppComponent {}
793
+ * ```
770
794
  */
771
795
  class DialogComponent {
772
796
  wrapper;
@@ -775,75 +799,78 @@ class DialogComponent {
775
799
  ngZone;
776
800
  builder;
777
801
  /**
778
- * Specifies the action buttons that will be rendered.
802
+ * Specifies the action buttons to render in the Dialog.
803
+ *
804
+ * @type {DialogAction[]}
779
805
  */
780
806
  actions;
781
807
  /**
782
- * Specifies the layout of the action buttons in the Dialog.
783
- * This option is only applicable if the action buttons are specified through the `actions` options.
808
+ * Sets the layout of the action buttons in the Dialog. Applies only if you specify action buttons through the `actions` option.
784
809
  *
810
+ * @type {ActionsLayout}
785
811
  * @default 'stretched'
786
812
  */
787
813
  actionsLayout = 'stretched';
788
814
  /**
789
- * Specifies the query selector used to set the initial focus ([see examples]({% slug initial_focus_dialog %})).
815
+ * Sets the query selector for the element to receive initial focus. ([See examples.]({% slug initial_focus_dialog %}))
816
+ *
817
+ * @type {string}
790
818
  */
791
819
  autoFocusedElement;
792
820
  /**
793
- * Specifies the text that is rendered in the title bar.
821
+ * Sets the text in the Dialog title bar.
822
+ *
823
+ * @type {string}
794
824
  */
795
825
  title;
796
826
  /**
797
- * Specifies the width of the Dialog.
798
- * A numeric value sets the width in pixels.
799
- * A string value sets the width in arbitrary units&mdash;for example, `50%`.
827
+ * Sets the width of the Dialog. Use a number for pixels or a string for units (for example, `50%`).
828
+ *
829
+ * @type {number | string}
800
830
  */
801
831
  width;
802
832
  /**
803
- * Specifies the minimum width of the Dialog.
804
- * A numeric value sets the minimum width in pixels.
805
- * A string value sets the minimum width in arbitrary units&mdash;for example, `50%`.
833
+ * Sets the minimum width of the Dialog. Use a number for pixels or a string for units (for example, `50%`).
834
+ *
835
+ * @type {number | string}
806
836
  */
807
837
  minWidth;
808
838
  /**
809
- * Specifies the maximum width of the Dialog.
810
- * A numeric value sets the maximum width in pixels.
811
- * A string value sets the maximum width in arbitrary units&mdash;for example, `50%`.
839
+ * Sets the maximum width of the Dialog. Use a number for pixels or a string for units (for example, `50%`).
840
+ *
841
+ * @type {number | string}
812
842
  */
813
843
  maxWidth;
814
844
  /**
815
- * Specifies the height of the Dialog.
816
- * A numeric value sets the height in pixels.
817
- * A string value sets the height in arbitrary units&mdash;for example, `50%`.
845
+ * Sets the height of the Dialog. Use a number for pixels or a string for units (for example, `50%`).
846
+ *
847
+ * @type {number | string}
818
848
  */
819
849
  height;
820
850
  /**
821
- * Specifies the minimum height of the Dialog.
822
- * A numeric value sets the minimum height in pixels.
823
- * A string value sets the minimum height in arbitrary units&mdash;for example, `50%`.
851
+ * Sets the minimum height of the Dialog. Use a number for pixels or a string for units (for example, `50%`).
852
+ *
853
+ * @type {number | string}
824
854
  */
825
855
  minHeight;
826
856
  /**
827
- * Specifies the maximum height of the Dialog.
828
- * A numeric value sets the maximum height in pixels.
829
- * A string value sets the maximum height in arbitrary units&mdash;for example, `50%`.
857
+ * Sets the maximum height of the Dialog. Use a number for pixels or a string for units (for example, `50%`).
858
+ *
859
+ * @type {number | string}
830
860
  */
831
861
  maxHeight;
832
862
  /**
833
863
  * Configures the Dialog opening animation ([see example]({% slug animations_dialog %})).
834
- * By default the animation type is set to `translate` and its duration is `300ms`.
864
+ * The default animation type is `translate` and the duration is `300ms`.
835
865
  *
866
+ * @type {boolean | DialogAnimation}
836
867
  * @default true
837
868
  */
838
869
  animation = true;
839
870
  /**
840
- * The Dialog allows you to specify predefined theme colors.
841
- * The theme color will be applied as a background and border color to the titlebar while also amending the text color accordingly.
871
+ * Sets a predefined theme color for the Dialog. The color applies to the title bar background and border, and updates the text color.
842
872
  *
843
- * The possible values are:
844
- * * `primary`
845
- * * `dark`
846
- * * `light`
873
+ * @type {DialogThemeColor}
847
874
  */
848
875
  set themeColor(themeColor) {
849
876
  this.handleThemeColorClass(this.themeColor, themeColor);
@@ -902,12 +929,15 @@ class DialogComponent {
902
929
  */
903
930
  showLicenseWatermark = false;
904
931
  /**
905
- * Fires when the user clicks an action button of the Dialog.
906
- * The event is fired only when the action buttons are specified through the `actions` options.
932
+ * Emits when the user clicks an action button in the Dialog. Fires only if you specify action buttons through the `actions` option.
933
+ *
934
+ * @type {EventEmitter<DialogAction>}
907
935
  */
908
936
  action = new EventEmitter();
909
937
  /**
910
- * Fires when the user clicks the **Close** button of the Dialog or the **ESC** key.
938
+ * Emits when the user clicks the **Close** button or presses the `ESC` key.
939
+ *
940
+ * @type {EventEmitter<any>}
911
941
  */
912
942
  close = new EventEmitter();
913
943
  get dir() {
@@ -1332,16 +1362,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1332
1362
  }] } });
1333
1363
 
1334
1364
  /**
1335
- * Holds references to the object instance and published events of the Dialog.
1336
- * Controls the Dialogs that were opened through the `DialogService`
1337
- * ([see example]({% slug api_dialog_dialogservice %}#toc-open)).
1365
+ * Holds references to the Dialog instance and published events when you open a Dialog through the `DialogService`.
1366
+ *
1367
+ * Use the `DialogRef` class to control and interact with Dialogs opened programmatically. ([See example.]({% slug api_dialog_dialogservice %}#toc-open))
1368
+ *
1338
1369
  */
1339
1370
  class DialogRef {
1340
1371
  /**
1341
- * Emits events when the Dialog is closed either through the **Close** button of the title bar or through the action buttons.
1342
- * If the **Close** button of the title bar is clicked, `DialogResult` is a `DialogCloseResult` instance.
1343
- * If the Dialog is closed through the action buttons, `DialogResult` contains the object that was passed when the Dialog was opened.
1344
- * When `close` is called with an argument, the result is the passed argument.
1372
+ * Emits events when the Dialog is closed either through the **Close** button of the title bar or through the action buttons. If the **Close** button of the title bar is clicked, `DialogResult` is a `DialogCloseResult` instance. If the Dialog is closed through the action buttons, `DialogResult` contains the object that was passed when the Dialog was opened. When `close` is called with an argument, the result is the passed argument.
1345
1373
  */
1346
1374
  result;
1347
1375
  /**
@@ -1349,19 +1377,13 @@ class DialogRef {
1349
1377
  */
1350
1378
  dialog;
1351
1379
  /**
1352
- * A reference to the child component of the Dialog.
1353
- * Available when the Dialog is opened with [component content](slug:service_dialog#toc-rendering-the-content-area).
1380
+ * A reference to the child component of the Dialog. Available when the Dialog is opened with [component content](slug:service_dialog#toc-rendering-the-content-area).
1354
1381
  */
1355
1382
  content;
1356
1383
  /**
1357
- * Closes the Dialog programmatically.
1358
- *
1359
- * When called without a value, the result Observable emits an empty `DialogCloseResult` object.
1360
- *
1361
- * When called with a value, the result Observable emits the provided value.
1384
+ * Closes the Dialog programmatically. When called without a value, the resulting Observable emits an empty `DialogCloseResult` object. When called with a value, the resulting Observable emits the provided value.
1362
1385
  *
1363
- * Usage Examples:
1364
- * ```typescript
1386
+ * ```ts
1365
1387
  * // Close without arguments: Returns an empty `DialogCloseResult` object.
1366
1388
  * dialogRef.close();
1367
1389
  *
@@ -1376,8 +1398,9 @@ class DialogRef {
1376
1398
  }
1377
1399
 
1378
1400
  /**
1379
- * The base class which will be extended by a component that is provided as content through `content`
1380
- * ([see example](slug:service_dialog#toc-single-component-rendering)).
1401
+ * Serves as the base class for a component provided as Dialog content through the `content` property.
1402
+ * ([See example.](slug:service_dialog#toc-single-component-rendering)).
1403
+ *
1381
1404
  */
1382
1405
  class DialogContentBase {
1383
1406
  dialog;
@@ -1443,33 +1466,34 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
1443
1466
  }] });
1444
1467
 
1445
1468
  /**
1446
- * The settings for the Dialog actions when the Dialog is opened through `DialogService`
1447
- * ([see example]({% slug api_dialog_dialogservice %}#toc-open)).
1469
+ * Represents the settings for Dialog actions when you open a Dialog through `DialogService`.
1470
+ *
1471
+ * Use the `DialogAction` class to configure action buttons in the Dialog. ([See example.]({% slug api_dialog_dialogservice %}#toc-open))
1472
+ *
1448
1473
  */
1449
1474
  class DialogAction {
1450
1475
  /**
1451
- * The text of the action button.
1476
+ * Sets the text of the action button.
1452
1477
  */
1453
1478
  text;
1454
1479
  /**
1455
- * Determines the theme color of the action button. The theme color will be applied as a background and border color while also amending the text color accordingly.
1480
+ * Sets the theme color of the action button. The theme color applies to the background, border, and text.
1456
1481
  */
1457
1482
  themeColor;
1458
1483
  /**
1459
- * Specifies the background and border styles of the action button.
1484
+ * Sets the background and border styles of the action button.
1460
1485
  */
1461
1486
  fillMode;
1462
1487
  /**
1463
- * Sets the CSS classes that will be rendered on the action button.
1464
- * Supports the union type of values that [ngClass](link:site.data.urls.angular['ngclassapi']) accepts.
1488
+ * Sets the CSS classes for the action button. Accepts any value supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
1465
1489
  */
1466
1490
  cssClass;
1467
1491
  /**
1468
- * Specifies the [SVG icon](slug:svgicon_list) to be rendered within the action button.
1492
+ * Sets the [SVG icon](slug:svgicon_list) to display in the action button.
1469
1493
  */
1470
1494
  svgIcon;
1471
1495
  /**
1472
- * Specifies the name of the [font icon](slug:icon_list) to be rendered within the action button.
1496
+ * Sets the name of the [font icon](slug:icon_list) to display in the action button.
1473
1497
  */
1474
1498
  icon;
1475
1499
  /**
@@ -1479,104 +1503,93 @@ class DialogAction {
1479
1503
  }
1480
1504
 
1481
1505
  /**
1482
- * The settings that can be used when the Dialog is opened through `DialogService`.
1483
- * ([see example]({% slug api_dialog_dialogservice %}#toc-open)).
1506
+ * Represents the settings for opening a Dialog through the `DialogService`.
1507
+ * ([See example.]({% slug api_dialog_dialogservice %}#toc-open))
1508
+ *
1484
1509
  */
1485
1510
  class DialogSettings {
1486
1511
  /**
1487
- * Defines a predicate that verifies if the pressed dialog action should be prevented. Returning true from the predicate prevents the dialog from closing.
1488
- * If the **Close** button of the title bar is clicked, `DialogResult` is a `DialogCloseResult` instance.
1489
- * If the Dialog is closed through the action buttons, `DialogResult` contains the object that was passed when the Dialog was opened. ([see example](slug:service_dialog#toc-dialog-close-prevention))
1490
- * @param {DialogResult} ev
1491
- * @param {DialogRef} [dialogRef] - provided only when the dialog is created using a component.
1492
- * @returns
1512
+ * Use the `preventAction` callback to check if the pressed Dialog action should be prevented. If `true`, the Dialog does not close.
1513
+ * If the **Close** button in the title bar is clicked, `DialogResult` is a `DialogCloseResult` instance.
1514
+ * If the action buttons are used to close the Dialog, `DialogResult` contains the object passed when opening the Dialog. ([See example.](slug:service_dialog#toc-dialog-close-prevention))
1515
+ * @param {DialogResult} ev The Dialog result.
1516
+ * @param {DialogRef} [dialogRef] The Dialog reference, provided only when you create the Dialog using a component.
1517
+ * @returns Returns `true` to prevent closing the Dialog.
1493
1518
  */
1494
1519
  preventAction;
1495
1520
  /**
1496
- * Sets the title of the Dialog. If `title` is omitted,
1497
- * the Dialog will not render a **Close** button.
1521
+ * Sets the Dialog `title`. If you omit `title`, the Dialog does not render a **Close** button.
1498
1522
  */
1499
1523
  title;
1500
1524
  /**
1501
- * Sets the CSS classes that will be rendered on the Dialog wrapper element.
1502
- * Supports the union type of values that NgClass accepts [ngClass](link:site.data.urls.angular['ngclassapi']).
1525
+ * Sets the CSS classes for the Dialog wrapper element. Accepts any value supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
1503
1526
  */
1504
1527
  cssClass;
1505
1528
  /**
1506
- * Configures the Dialog opening animation ([see example]({% slug animations_dialog %})).
1507
- * By default the animation type is set to `translate` and its duration is `300ms`.
1529
+ * Configures the Dialog opening `animation` ([see example]({% slug animations_dialog %})).
1530
+ * @default { type: 'translate', duration: 300 }
1508
1531
  */
1509
1532
  animation;
1510
1533
  /**
1511
- * Sets the HTML attributes of the Dialog wrapper element.
1512
- * The property accepts string key-value based pairs.
1534
+ * Sets the HTML attributes for the Dialog wrapper element. Accepts string key-value pairs.
1513
1535
  */
1514
1536
  htmlAttributes;
1515
1537
  /**
1516
- * Defines the content of the Dialog.
1517
- * ([see example](slug:service_dialog#toc-rendering-the-content-area)).
1538
+ * Defines the Dialog `content`. ([See example.](slug:service_dialog#toc-rendering-the-content-area))
1518
1539
  */
1519
1540
  content;
1520
1541
  /**
1521
- * Specifies the width of the Dialog.
1522
- * A numeric value sets the width in pixels.
1523
- * A string value sets the width in arbitrary units&mdash;for example, `50%`.
1542
+ * Sets the width of the Dialog.
1543
+ * Use a number for pixels or a string for other units, for example, `50%`.
1524
1544
  */
1525
1545
  width;
1526
1546
  /**
1527
- * Specifies the minimum width of the Dialog.
1528
- * A numeric value sets the minimum width in pixels.
1529
- * A string value sets the minimum width in arbitrary units&mdash;for example, `50%`.
1547
+ * Sets the minimum width of the Dialog.
1548
+ * Use a number for pixels or a string for other units, for example, `50%`.
1530
1549
  */
1531
1550
  minWidth;
1532
1551
  /**
1533
- * Specifies the maximum width of the Dialog.
1534
- * A numeric value sets the maximum width in pixels.
1535
- * A string value sets the maximum width in arbitrary units&mdash;for example, `50%`.
1552
+ * Sets the maximum width of the Dialog.
1553
+ * Use a number for pixels or a string for other units, for example, `50%`.
1536
1554
  */
1537
1555
  maxWidth;
1538
1556
  /**
1539
- * Specifies the height of the Dialog.
1540
- * A numeric value sets the height in pixels.
1541
- * A string value sets the height in arbitrary units&mdash;for example, `50%`.
1557
+ * Sets the height of the Dialog.
1558
+ * Use a number for pixels or a string for other units, for example, `50%`.
1542
1559
  */
1543
1560
  height;
1544
1561
  /**
1545
- * Specifies the minimum height of the Dialog.
1546
- * A numeric value sets the minimum height in pixels.
1547
- * A string value sets the minimum height in arbitrary units&mdash;for example, `50%`.
1562
+ * Sets the minimum height of the Dialog.
1563
+ * Use a number for pixels or a string for other units, for example, `50%`.
1548
1564
  */
1549
1565
  minHeight;
1550
1566
  /**
1551
- * Specifies the maximum height of the Dialog.
1552
- * A numeric value sets the maximum height in pixels.
1553
- * A string value sets the maximum height in arbitrary units&mdash;for example, `50%`.
1567
+ * Sets the maximum height of the Dialog.
1568
+ * Use a number for pixels or a string for other units, for example, `50%`.
1554
1569
  */
1555
1570
  maxHeight;
1556
1571
  /**
1557
- * Defines the container in which the Dialog will be inserted.
1558
- * Specifying this option changes the place in the page hierarchy where the Dialog will be inserted.
1559
- * The styling of the component will remain the same.
1572
+ * Defines the container where the Dialog is inserted. This changes the place in the page hierarchy where the Dialog appears. The component styling stays the same.
1560
1573
  */
1561
1574
  appendTo;
1562
1575
  /**
1563
- * Specifies the title of the close button.
1576
+ * Sets the `closeTitle` for the **Close** button.
1564
1577
  */
1565
1578
  closeTitle;
1566
1579
  /**
1567
- * Sets the action buttons of the Dialog.
1580
+ * Sets the Dialog `actions` buttons.
1568
1581
  */
1569
1582
  actions;
1570
1583
  /**
1571
- * Specifies the layout of the action buttons in the Dialog.
1584
+ * Sets the layout of the Dialog action buttons with `actionsLayout`.
1572
1585
  */
1573
1586
  actionsLayout;
1574
1587
  /**
1575
- * Sets the focused element query selector.
1588
+ * Sets the query selector for the element to focus automatically with `autoFocusedElement`.
1576
1589
  */
1577
1590
  autoFocusedElement;
1578
1591
  /**
1579
- * Specifies the theme color of the Dialog.
1592
+ * Sets the theme color of the Dialog.
1580
1593
  */
1581
1594
  themeColor;
1582
1595
  }
@@ -1598,8 +1611,7 @@ class DialogInjector {
1598
1611
  }
1599
1612
  }
1600
1613
  /**
1601
- * A service for opening Dialog windows dynamically
1602
- * ([see example]({% slug service_dialog %})).
1614
+ * Provides a service for opening Dialog windows dynamically ([see example]({% slug service_dialog %})).
1603
1615
  */
1604
1616
  class DialogService {
1605
1617
  resolver;
@@ -1615,45 +1627,25 @@ class DialogService {
1615
1627
  /**
1616
1628
  * Opens a Dialog window. Requires an element in the application that uses the
1617
1629
  * [`kendoDialogContainer`]({% slug api_dialog_dialogcontainerdirective %}) directive.
1618
- * Created Dialogs will be mounted in the DOM directly after that element.
1630
+ * The created Dialog mounts in the DOM directly after that element.
1619
1631
  *
1620
1632
  * @param {DialogAction} options - The options that define the Dialog.
1621
- * @returns {DialogRef} - A reference to the Dialog object and the convenience properties.
1633
+ * @returns {DialogRef} - A reference to the Dialog object and its convenience properties.
1622
1634
  *
1623
1635
  * @example
1624
- *
1625
- * ```ts-no-run
1626
- * _@Component({
1627
- * selector: 'my-app',
1628
- * template: `
1629
- * <button kendoButton (click)="open()">Harmless button</button>
1630
- * <div kendoDialogContainer></div>
1631
- * `
1632
- * })
1633
- * export class AppComponent {
1634
- * constructor( private dialogService: DialogService ) {}
1635
- *
1636
- * public open() {
1637
- * var dialog = this.dialogService.open({
1638
- * title: "Please confirm",
1639
- * content: "Are you sure?",
1640
- * actions: [
1641
- * { text: "No" },
1642
- * { text: "Yes", themeColor: 'primary' }
1643
- * ]
1644
- * });
1645
- *
1646
- * dialog.result.subscribe((result) => {
1647
- * if (result instanceof DialogCloseResult) {
1648
- * console.log("close");
1649
- * } else {
1650
- * console.log("action", result);
1651
- * }
1652
- * });
1653
- * }
1654
- * }
1636
+ * ```typescript
1637
+ * const dialog = this.dialogService.open({
1638
+ * title: 'Confirm',
1639
+ * content: 'Are you sure?',
1640
+ * actions: [
1641
+ * { text: 'No' },
1642
+ * { text: 'Yes', themeColor: 'primary' }
1643
+ * ]
1644
+ * });
1645
+ * dialog.result.subscribe(result => {
1646
+ * // handle result
1647
+ * });
1655
1648
  * ```
1656
- *
1657
1649
  */
1658
1650
  open(options) {
1659
1651
  const factory = this.resolver.resolveComponentFactory(DialogComponent);
@@ -2189,6 +2181,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
2189
2181
  args: ['class.k-resize-handle']
2190
2182
  }] } });
2191
2183
 
2184
+ /**
2185
+ * Represents the title bar of the Window component.
2186
+ *
2187
+ */
2192
2188
  class WindowTitleBarComponent {
2193
2189
  el;
2194
2190
  ngZone;
@@ -2866,6 +2862,12 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
2866
2862
 
2867
2863
  /**
2868
2864
  * Represents the [Kendo UI Window component for Angular]({% slug overview_window_dialogs %}).
2865
+ *
2866
+ * @example
2867
+ * ```html
2868
+ * <kendo-window title="My Window" [width]="400" [height]="300">
2869
+ * </kendo-window>
2870
+ * ```
2869
2871
  */
2870
2872
  class WindowComponent {
2871
2873
  el;
@@ -2879,11 +2881,11 @@ class WindowComponent {
2879
2881
  */
2880
2882
  autoFocusedElement;
2881
2883
  /**
2882
- * Specifies the text that is rendered in the title bar.
2884
+ * Sets the text in the title bar.
2883
2885
  */
2884
2886
  title;
2885
2887
  /**
2886
- * Specifies whether the user will be able to drag the component.
2888
+ * Specifies if the user can drag the component.
2887
2889
  * @default true
2888
2890
  */
2889
2891
  set draggable(value) {
@@ -2893,7 +2895,7 @@ class WindowComponent {
2893
2895
  return this.options.draggable;
2894
2896
  }
2895
2897
  /**
2896
- * Specifies whether the user will be able to resize the component.
2898
+ * Specifies if the user can resize the component.
2897
2899
  * @default true
2898
2900
  */
2899
2901
  set resizable(value) {
@@ -2903,13 +2905,7 @@ class WindowComponent {
2903
2905
  return this.options.resizable;
2904
2906
  }
2905
2907
  /**
2906
- * The Window allows you to specify predefined theme colors.
2907
- * The theme color will be applied as a background and border color to the titlebar while also amending the text color accordingly.
2908
- *
2909
- * The possible values are:
2910
- * * `primary`
2911
- * * `dark`
2912
- * * `light`
2908
+ * Sets the predefined theme color for the Window. The color applies to the title bar background and border, and updates the text color.
2913
2909
  */
2914
2910
  set themeColor(themeColor) {
2915
2911
  this.handleThemeColorClass(this.themeColor, themeColor);
@@ -2948,18 +2944,12 @@ class WindowComponent {
2948
2944
  return this._htmlAttributes;
2949
2945
  }
2950
2946
  /**
2951
- * Specifies if the content of the component is persisted in the DOM when minimized.
2947
+ * Specifies if the content stays in the DOM when minimized.
2952
2948
  * @default false
2953
2949
  */
2954
2950
  keepContent = false;
2955
2951
  /**
2956
- * Specifies the initial state of the component.
2957
- * If not specified, the value is set to `default`.
2958
- *
2959
- * The possible values are:
2960
- * * `minimized`
2961
- * * `maximized`
2962
- * * `default`
2952
+ * Sets the initial state of the Window.
2963
2953
  */
2964
2954
  set state(value) {
2965
2955
  this.options.state = value;
@@ -2968,8 +2958,7 @@ class WindowComponent {
2968
2958
  return this.options.state;
2969
2959
  }
2970
2960
  /**
2971
- * Specifies the minimum width of the component.
2972
- * The `minWidth` property has to be set in pixels.
2961
+ * Sets the minimum width in pixels.
2973
2962
  * @default 120
2974
2963
  */
2975
2964
  set minWidth(value) {
@@ -2979,8 +2968,7 @@ class WindowComponent {
2979
2968
  return this.options.minWidth;
2980
2969
  }
2981
2970
  /**
2982
- * Specifies the minimum height of the Window.
2983
- * The `minHeight` property has to be set in pixels.
2971
+ * Sets the minimum height in pixels.
2984
2972
  * @default 100
2985
2973
  */
2986
2974
  set minHeight(value) {
@@ -2990,8 +2978,7 @@ class WindowComponent {
2990
2978
  return this.options.minHeight;
2991
2979
  }
2992
2980
  /**
2993
- * Specifies the width of the Window.
2994
- * The `width` property has to be set in pixels.
2981
+ * Sets the width in pixels.
2995
2982
  */
2996
2983
  set width(value) {
2997
2984
  this.setOption('width', value);
@@ -3000,8 +2987,7 @@ class WindowComponent {
3000
2987
  return this.options.width;
3001
2988
  }
3002
2989
  /**
3003
- * Specifies the height of the Window.
3004
- * The `height` property has to be set in pixels.
2990
+ * Sets the height in pixels.
3005
2991
  */
3006
2992
  set height(value) {
3007
2993
  this.setOption('height', value);
@@ -3010,8 +2996,7 @@ class WindowComponent {
3010
2996
  return this.options.height;
3011
2997
  }
3012
2998
  /**
3013
- * Specifies the initial top offset of the Window.
3014
- * The `top` property has to be set in pixels.
2999
+ * Sets the initial top offset in pixels.
3015
3000
  */
3016
3001
  set top(value) {
3017
3002
  this.setOption('top', value);
@@ -3020,8 +3005,7 @@ class WindowComponent {
3020
3005
  return this.options.top;
3021
3006
  }
3022
3007
  /**
3023
- * Specifies the initial left offset of the Window.
3024
- * Numeric values are treated as pixels.
3008
+ * Sets the initial left offset in pixels.
3025
3009
  */
3026
3010
  set left(value) {
3027
3011
  this.setOption('left', value);
@@ -3058,7 +3042,7 @@ class WindowComponent {
3058
3042
  */
3059
3043
  dragStart = new EventEmitter();
3060
3044
  /**
3061
- * Fires when the Window was moved by the user.
3045
+ * Fires after the Window has been moved by the user.
3062
3046
  */
3063
3047
  dragEnd = new EventEmitter();
3064
3048
  /**
@@ -3066,7 +3050,7 @@ class WindowComponent {
3066
3050
  */
3067
3051
  resizeStart = new EventEmitter();
3068
3052
  /**
3069
- * Fires when the Window was resized by the user.
3053
+ * Fires after the Window has been resized by the user.
3070
3054
  */
3071
3055
  resizeEnd = new EventEmitter();
3072
3056
  /**
@@ -3074,28 +3058,23 @@ class WindowComponent {
3074
3058
  */
3075
3059
  close = new EventEmitter();
3076
3060
  /**
3077
- * Fires when the `width` property of the component was updated. The event is triggered only after the resizing
3078
- * has ended. The event data contains the new width. Allows a two-way binding of the `width` property.
3061
+ * Fires when the `width` property is updated after resizing. The event data contains the new width. Allows two-way binding of the `width` property.
3079
3062
  */
3080
3063
  widthChange = new EventEmitter();
3081
3064
  /**
3082
- * Fires when the `height` property of the component was updated. The event is triggered only after the resizing
3083
- * has ended. The event data contains the new height. Allows a two-way binding of the `height` property.
3065
+ * Fires when the `height` property is updated after resizing. The event data contains the new height. Allows two-way binding of the `height` property.
3084
3066
  */
3085
3067
  heightChange = new EventEmitter();
3086
3068
  /**
3087
- * Fires when the `top` property of the component was updated. The event is triggered only after the dragging
3088
- * and resizing have ended. The event data contains the new top offset. Allows a two-way binding of the `top` property.
3069
+ * Fires when the `top` property is updated after dragging or resizing. The event data contains the new top offset. Allows two-way binding of the `top` property.
3089
3070
  */
3090
3071
  topChange = new EventEmitter();
3091
3072
  /**
3092
- * Fires when the `left` property of the component was updated. The event is triggered only after the dragging
3093
- * and resizing have ended. The event data contains the new left offset. Allows a two-way binding of the `left` property.
3073
+ * Fires when the `left` property is updated after dragging or resizing. The event data contains the new left offset. Allows two-way binding of the `left` property.
3094
3074
  */
3095
3075
  leftChange = new EventEmitter();
3096
3076
  /**
3097
- * Fires when the `state` property of the component was updated. The event data contains the new state. Allows a
3098
- * two-way binding of the `state` property.
3077
+ * Fires when the `state` property is updated. The event data contains the new state. Allows two-way binding of the `state` property.
3099
3078
  */
3100
3079
  stateChange = new EventEmitter();
3101
3080
  /**
@@ -3227,8 +3206,8 @@ class WindowComponent {
3227
3206
  * corresponding property of the component instance will be updated.
3228
3207
  * This method is intended to be used for sizing dynamically created components using the
3229
3208
  * [`WindowService`]({% slug api_dialog_windowservice %})
3230
- * @param {WindowDimensionSetting} dimension - The option that will be updated
3231
- * @param {number} value - The value set in pixels
3209
+ * @param dimension The option to update.
3210
+ * @param value The value in pixels.
3232
3211
  */
3233
3212
  setDimension(dimension, value) {
3234
3213
  this.setOption(dimension, value);
@@ -3240,8 +3219,8 @@ class WindowComponent {
3240
3219
  * corresponding property of the component instance will be updated.
3241
3220
  * This method is intended to be used for positioning dynamically created components using the
3242
3221
  * [`WindowService`]({% slug api_dialog_windowservice %})
3243
- * @param {WindowOffsetSetting} offset - The option that will be updated
3244
- * @param {number} value - The value set in pixels
3222
+ * @param offset The option to update.
3223
+ * @param value The value in pixels.
3245
3224
  */
3246
3225
  setOffset(offset, value) {
3247
3226
  this.setOption(offset, value);
@@ -3650,65 +3629,51 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
3650
3629
  }] } });
3651
3630
 
3652
3631
  /**
3653
- * Indicates that the **Close** button of a Window that is opened through `WindowService` is clicked.
3632
+ * Indicates that the **Close** button of a Window opened through `WindowService` is clicked.
3633
+ *
3654
3634
  */
3655
3635
  class WindowCloseResult {
3656
3636
  }
3657
3637
 
3658
3638
  /**
3659
- * Holds references to the object instance of the Window.
3660
- * Controls the Windows that were opened through `WindowService`
3661
- * ([see example]({% slug api_dialog_windowservice %}#toc-open)).
3639
+ * Holds references to the Window instance. Controls Windows opened through `WindowService`. ([See example.]({% slug api_dialog_windowservice %}#toc-open))
3662
3640
  */
3663
3641
  class WindowRef {
3664
3642
  /**
3665
- * A reference to the Window instance.
3643
+ * Represents a reference to the Window instance.
3666
3644
  */
3667
3645
  window;
3668
3646
  /**
3669
- * A reference to the child component of the Window.
3670
- * Available when the Window is opened with
3671
- * [component content](slug:service_window#toc-rendering-the-content-area).
3647
+ * Represents a reference to the child component of the Window. Available when you open the Window with [component content](slug:service_window#toc-rendering-the-content-area).
3672
3648
  */
3673
3649
  content;
3674
3650
  /**
3675
- * Allows you to close the Window by using code.
3676
- * When called with no arguments,
3677
- * the `result` Observable will be of type WindowCloseResult.
3678
- * When called with an argument, the `result` Observable will hold the provided value.
3651
+ * Allows you to close the Window by using code. When called with no arguments, the `result` Observable is of type `WindowCloseResult`. When called with an argument, the `result` Observable holds the provided value.
3679
3652
  */
3680
3653
  close;
3681
3654
  /**
3682
- * Emits events when the Window is closed through the **Esc** key, the **Close** button of the title bar or
3683
- * by calling the `close` method.
3684
- * When the Window is closed with the title bar button, **Esc** or by calling `close` with no arguments,
3685
- * the result is of type [WindowCloseResult]({% slug api_dialog_windowcloseresult %}).
3686
- * When `close` is called with an argument, the result is the passed argument.
3655
+ * Emits events when the Window is closed through the `Esc` key, the **Close** button of the title bar, or by calling the `close` method. When the Window is closed with the title bar button, `Esc`, or by calling `close` with no arguments, the result is of type [`WindowCloseResult`]({% slug api_dialog_windowcloseresult %}). When `close` is called with an argument, the result is the passed argument.
3687
3656
  */
3688
3657
  result;
3689
3658
  }
3690
3659
 
3691
3660
  /**
3692
- * The settings for the Window actions when the Window is opened through `WindowService`
3693
- * ([see example]({% slug api_dialog_windowservice %}#toc-open)).
3661
+ * Represents the settings for the Window actions when you open a Window through `WindowService`. ([See example.]({% slug api_dialog_windowservice %}#toc-open))
3694
3662
  */
3695
3663
  class WindowSettings {
3696
3664
  /**
3697
- * Defines a predicate that verifies if the closing of the Window should be prevented.
3698
- * It applies to clicking the **Close** button of the title bar, pressing the **Esc** key or calling the `close` method.
3699
- * Returning true from the predicate prevents the Window from closing.
3700
- * If the **Close** button of the title bar is clicked or **Esc** is pressed, a [WindowCloseResult]({% slug api_dialog_windowcloseresult %}) instance is passed.
3701
- * @param {any} ev
3702
- * @param {WindowRef} [windowRef] - provided only when the window is created using a component.
3703
- * @returns
3665
+ * Use the `preventClose` predicate to check if closing the Window should be prevented. Applies to clicking the **Close** button, pressing **Esc**, or calling the `close` method. Return `true` to prevent closing. If the **Close** button or **Esc** is used, a [`WindowCloseResult`]({% slug api_dialog_windowcloseresult %}) instance is passed.
3666
+ * @param {any} ev The event argument.
3667
+ * @param {WindowRef} [windowRef] - The window reference, provided only when you create the window using a component.
3668
+ * @returns Returns `true` to prevent closing the window.
3704
3669
  */
3705
3670
  preventClose;
3706
3671
  /**
3707
- * Sets the title of the Window.
3672
+ * Sets the Window `title`.
3708
3673
  */
3709
3674
  title;
3710
3675
  /**
3711
- * Defines the content of the Window.
3676
+ * Defines the Window `content`.
3712
3677
  */
3713
3678
  content;
3714
3679
  /**
@@ -3716,37 +3681,35 @@ class WindowSettings {
3716
3681
  */
3717
3682
  titleBarContent;
3718
3683
  /**
3719
- * Defines the text of the labels that are shown within the Window.
3720
- * Used primarily for localization.
3684
+ * Sets the text of the labels shown in the Window. Use for localization.
3721
3685
  */
3722
3686
  messages;
3723
3687
  /**
3724
- * Specifies if the content of the Window is persisted in the DOM
3725
- * when the Window is minimized.
3688
+ * Set to `true` to persist the Window content in the DOM when minimized.
3726
3689
  */
3727
3690
  keepContent;
3728
3691
  /**
3729
- * Specifies the width of the Window.
3692
+ * Sets the width of the Window in pixels.
3730
3693
  */
3731
3694
  width;
3732
3695
  /**
3733
- * Specifies the minimum width of the Window.
3696
+ * Sets the minimum width of the Window in pixels.
3734
3697
  */
3735
3698
  minWidth;
3736
3699
  /**
3737
- * Specifies the height of the Window.
3700
+ * Sets the height of the Window in pixels.
3738
3701
  */
3739
3702
  height;
3740
3703
  /**
3741
- * Specifies the minimum height of the Window.
3704
+ * Sets the minimum height of the Window in pixels.
3742
3705
  */
3743
3706
  minHeight;
3744
3707
  /**
3745
- * Specifies the left offset of the Window.
3708
+ * Sets the left offset of the Window in pixels.
3746
3709
  */
3747
3710
  left;
3748
3711
  /**
3749
- * Specifies the top offset of the Window.
3712
+ * Sets the top offset of the Window in pixels.
3750
3713
  */
3751
3714
  top;
3752
3715
  /**
@@ -3754,13 +3717,11 @@ class WindowSettings {
3754
3717
  */
3755
3718
  draggable;
3756
3719
  /**
3757
- * Sets the custom CSS classes that will be rendered on the Window wrapper element.
3758
- * Supports the union type of values that NgClass accepts [ngClass](link:site.data.urls.angular['ngclassapi']).
3720
+ * Sets custom CSS classes for the Window wrapper element. Accepts any value supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
3759
3721
  */
3760
3722
  cssClass;
3761
3723
  /**
3762
- * Sets the HTML attributes of the Window wrapper element.
3763
- * The property accepts string key-value based pairs.
3724
+ * Sets HTML attributes for the Window wrapper element. Accepts string key-value pairs.
3764
3725
  */
3765
3726
  htmlAttributes;
3766
3727
  /**
@@ -3768,16 +3729,15 @@ class WindowSettings {
3768
3729
  */
3769
3730
  resizable;
3770
3731
  /**
3771
- * Specifies the initial state of the Window.
3732
+ * Sets the initial state of the Window.
3772
3733
  */
3773
3734
  state;
3774
3735
  /**
3775
- * Defines the container in which the Window will be inserted.
3776
- * Specifying this option changes the place in the page hierarchy where the Window will be inserted.
3736
+ * Defines the container where the Window is inserted. This changes the place in the page hierarchy where the Window appears.
3777
3737
  */
3778
3738
  appendTo;
3779
3739
  /**
3780
- * Sets the focused element query selector.
3740
+ * Sets the query selector for the element to focus automatically.
3781
3741
  */
3782
3742
  autoFocusedElement;
3783
3743
  /**
@@ -3823,8 +3783,9 @@ class WindowInjector {
3823
3783
  }
3824
3784
  }
3825
3785
  /**
3826
- * A service for opening Windows dynamically
3827
- * ([see example]({% slug service_window %})).
3786
+ * Provides methods for opening Windows dynamically.
3787
+ *
3788
+ * Use this service to open a Window component and manage its lifecycle. ([See example.]({% slug service_window %}))
3828
3789
  */
3829
3790
  class WindowService {
3830
3791
  resolver;
@@ -3838,39 +3799,18 @@ class WindowService {
3838
3799
  this.containerService = containerService;
3839
3800
  }
3840
3801
  /**
3841
- * Opens a Window component.
3802
+ * Opens a Window component with the specified settings.
3842
3803
  *
3843
- * @param {WindowSettings} settings - The settings that define the Window.
3844
- * @returns {WindowRef} - A reference to the Window object.
3804
+ * @param settings The settings that configure the Window.
3805
+ * @returns A `WindowRef` instance for controlling the Window.
3845
3806
  *
3846
3807
  * @example
3847
- *
3848
- * ```ts-no-run
3849
- * _@Component({
3850
- * selector: 'my-app',
3851
- * template: `
3852
- * <button kendoButton (click)="open()">Open window</button>
3853
- * <div kendoWindowContainer></div>
3854
- * `
3855
- * })
3856
- * export class AppComponent {
3857
- * constructor( private windowService: WindowService ) {}
3858
- *
3859
- * public open() {
3860
- * var window = this.windowService.open({
3861
- * title: "My window",
3862
- * content: "My content!"
3863
- * });
3864
- *
3865
- * window.result.subscribe((result) => {
3866
- * if (result instanceof WindowCloseResult) {
3867
- * console.log("Window was closed");
3868
- * }
3869
- * });
3870
- * }
3871
- * }
3808
+ * ```ts
3809
+ * const window = windowService.open({
3810
+ * title: 'My window',
3811
+ * content: 'My content!'
3812
+ * });
3872
3813
  * ```
3873
- *
3874
3814
  */
3875
3815
  open(settings) {
3876
3816
  const factory = this.resolver.resolveComponentFactory(WindowComponent);
@@ -4021,12 +3961,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4021
3961
  }] }]; } });
4022
3962
 
4023
3963
  /**
4024
- * Provides an insertion point for the Dialogs which are created through the
4025
- * Dialog service ([see example]({% slug api_dialog_dialogservice %}#toc-open)).
4026
- * Created Dialogs will be mounted after that element.
3964
+ * Represents an insertion point for Dialogs created through the Dialog service.
3965
+ * The created Dialogs mount after this element. ([See example.]({% slug api_dialog_dialogservice %}#toc-open))
4027
3966
  *
4028
3967
  * @example
4029
- * ```html-no-run
3968
+ * ```html
4030
3969
  * <div kendoDialogContainer></div>
4031
3970
  * ```
4032
3971
  */
@@ -4046,8 +3985,29 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4046
3985
  }], ctorParameters: function () { return [{ type: i0.ViewContainerRef }, { type: DialogContainerService }]; } });
4047
3986
 
4048
3987
  /**
4049
- * Custom component messages override default component messages
4050
- * ([see example](slug:globalization_dialogs#toc-internationalization)).
3988
+ * Represents a component for customizing the messages in Dialog and Window components.
3989
+ *
3990
+ * Use the `CustomMessagesComponent` to override default messages with custom text. ([See example.](slug:globalization_dialogs#toc-internationalization)).
3991
+ *
3992
+ * @example
3993
+ * ```typescript
3994
+ * import { CustomMessagesComponent } from './custom-messages.component';
3995
+ *
3996
+ * @Component({
3997
+ * selector: 'my-dialog',
3998
+ * template: `
3999
+ * <kendo-dialog>
4000
+ * <kendo-dialog-messages
4001
+ * [closeTitle]="'Close dialog'"
4002
+ * [restoreTitle]="'Restore dialog'"
4003
+ * [maximizeTitle]="'Maximize dialog'"
4004
+ * [minimizeTitle]="'Minimize dialog'">
4005
+ * </kendo-dialog-messages>
4006
+ * </kendo-dialog>
4007
+ * `
4008
+ * })
4009
+ * export class MyDialogComponent {}
4010
+ * ```
4051
4011
  */
4052
4012
  class CustomMessagesComponent extends Messages {
4053
4013
  service;
@@ -4082,12 +4042,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4082
4042
  }], ctorParameters: function () { return [{ type: i1$1.LocalizationService }]; } });
4083
4043
 
4084
4044
  /**
4085
- * Provides an insertion point for the Windows which are created through the
4086
- * Window service ([see example]({% slug api_dialog_windowservice %}#toc-open)).
4087
- * Created Windows will be mounted after that element.
4045
+ * Represents an insertion point for Windows created through the Window service.
4046
+ * The created Windows mount after this element. ([See example.]({% slug api_dialog_windowservice %}#toc-open))
4088
4047
  *
4089
4048
  * @example
4090
- * ```html-no-run
4049
+ * ```html
4091
4050
  * <div kendoWindowContainer></div>
4092
4051
  * ```
4093
4052
  */
@@ -4107,8 +4066,24 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4107
4066
  }], ctorParameters: function () { return [{ type: i0.ViewContainerRef }, { type: WindowContainerService }]; } });
4108
4067
 
4109
4068
  /**
4110
- * Utility array that contains all `Dialog` related components and directives.
4111
- */
4069
+ * Represents the utility array that that contains all `Dialog`-related components and directives.
4070
+ *
4071
+ * Use `KENDO_DIALOG` to import all Dialog components and directives at once.
4072
+ *
4073
+ * @example
4074
+ * ```typescript
4075
+ * import { Component } from '@angular/core';
4076
+ * import { KENDO_DIALOG } from '@progress/kendo-angular-dialog';
4077
+ *
4078
+ * @Component({
4079
+ * selector: 'my-dialog-app',
4080
+ * standalone: true,
4081
+ * imports: [KENDO_DIALOG],
4082
+ * template: `...`
4083
+ * })
4084
+ * export class DialogAppComponent {}
4085
+ * ```
4086
+ */
4112
4087
  const KENDO_DIALOG = [
4113
4088
  DialogComponent,
4114
4089
  DialogTitleBarComponent,
@@ -4117,8 +4092,24 @@ const KENDO_DIALOG = [
4117
4092
  CustomMessagesComponent
4118
4093
  ];
4119
4094
  /**
4120
- * Utility array that contains all `Window` related components and directives.
4121
- */
4095
+ * Represents the utility array that contains all `Window`-related components and directives.
4096
+ *
4097
+ * Use `KENDO_WINDOW` to import all Window components and directives at once.
4098
+ *
4099
+ * @example
4100
+ * ```typescript
4101
+ * import { Component } from '@angular/core';
4102
+ * import { KENDO_WINDOW } from '@progress/kendo-angular-dialog';
4103
+ *
4104
+ * @Component({
4105
+ * selector: 'my-window-app',
4106
+ * standalone: true,
4107
+ * imports: [KENDO_WINDOW],
4108
+ * template: `...`
4109
+ * })
4110
+ * export class WindowAppComponent {}
4111
+ * ```
4112
+ */
4122
4113
  const KENDO_WINDOW = [
4123
4114
  WindowComponent,
4124
4115
  WindowCloseActionDirective,
@@ -4131,8 +4122,24 @@ const KENDO_WINDOW = [
4131
4122
  CustomMessagesComponent
4132
4123
  ];
4133
4124
  /**
4134
- * Utility array that contains all `@progress/kendo-angular-dialog` related components and directives.
4135
- */
4125
+ * Represents the utility array that contains all `@progress/kendo-angular-dialog`-related components and directives.
4126
+ *
4127
+ * Use `KENDO_DIALOGS` to import all Dialog and Window components and directives at once.
4128
+ *
4129
+ * @example
4130
+ * ```typescript
4131
+ * import { Component } from '@angular/core';
4132
+ * import { KENDO_DIALOGS } from '@progress/kendo-angular-dialog';
4133
+ *
4134
+ * @Component({
4135
+ * selector: 'my-app',
4136
+ * standalone: true,
4137
+ * imports: [KENDO_DIALOGS],
4138
+ * template: `...`
4139
+ * })
4140
+ * export class AppComponent {}
4141
+ * ```
4142
+ */
4136
4143
  const KENDO_DIALOGS = [
4137
4144
  ...KENDO_DIALOG,
4138
4145
  ...KENDO_WINDOW
@@ -4140,25 +4147,23 @@ const KENDO_DIALOGS = [
4140
4147
 
4141
4148
  //IMPORTANT: NgModule export kept for backwards compatibility
4142
4149
  /**
4143
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
4144
- * definition for the Dialog component that includes all Dialog components and directives.
4145
- * Imports `DialogModule` into the [root module](link:site.data.urls.angular['ngmodules']#angular-modularity)
4146
- * of your application or into any other sub-module that will use the Dialog component.
4150
+ * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi']) definition for the Dialog component.
4151
+ *
4152
+ * Use the `DialogModule` to include all Dialog components and directives in your application.
4147
4153
  *
4148
4154
  * @example
4149
- * ```ts-no-run
4155
+ * ```typescript
4150
4156
  * import { NgModule } from '@angular/core';
4151
4157
  * import { BrowserModule } from '@angular/platform-browser';
4152
4158
  * import { DialogModule } from '@progress/kendo-angular-dialog';
4153
4159
  * import { AppComponent } from './app.component';
4154
4160
  *
4155
- * _@NgModule({
4161
+ * @NgModule({
4156
4162
  * bootstrap: [AppComponent],
4157
4163
  * declarations: [AppComponent],
4158
4164
  * imports: [BrowserModule, DialogModule]
4159
4165
  * })
4160
- * export class AppModule {
4161
- * }
4166
+ * export class AppModule {}
4162
4167
  * ```
4163
4168
  */
4164
4169
  class DialogModule {
@@ -4177,25 +4182,23 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4177
4182
 
4178
4183
  //IMPORTANT: NgModule export kept for backwards compatibility
4179
4184
  /**
4180
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
4181
- * definition for the Window component. Imports `WindowModule` into the
4182
- * [root module](link:site.data.urls.angular['ngmodules']#angular-modularity)
4183
- * of your application or into any other sub-module that will use the Window component.
4185
+ * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi']) definition for the Window component.
4186
+ *
4187
+ * Use the `WindowModule` to include all Window components and directives in your application.
4184
4188
  *
4185
4189
  * @example
4186
- * ```ts-no-run
4190
+ * ```typescript
4187
4191
  * import { NgModule } from '@angular/core';
4188
4192
  * import { BrowserModule } from '@angular/platform-browser';
4189
4193
  * import { WindowModule } from '@progress/kendo-angular-window';
4190
4194
  * import { AppComponent } from './app.component';
4191
4195
  *
4192
- * _@NgModule({
4196
+ * @NgModule({
4193
4197
  * bootstrap: [AppComponent],
4194
4198
  * declarations: [AppComponent],
4195
4199
  * imports: [BrowserModule, WindowModule]
4196
4200
  * })
4197
- * export class AppModule {
4198
- * }
4201
+ * export class AppModule {}
4199
4202
  * ```
4200
4203
  */
4201
4204
  class WindowModule {
@@ -4214,28 +4217,24 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.12", ngImpo
4214
4217
 
4215
4218
  //IMPORTANT: NgModule export kept for backwards compatibility
4216
4219
  /**
4217
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
4218
- * definition for the Dialogs components.
4220
+ * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi']) definition for the Dialogs components.
4219
4221
  *
4220
- * @example
4222
+ * Use the `DialogsModule` to include all Dialog and Window components and services in your application.
4221
4223
  *
4222
- * ```ts
4224
+ * @example
4225
+ * ```typescript
4223
4226
  * import { DialogsModule } from '@progress/kendo-angular-dialog';
4224
- *
4225
4227
  * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
4226
4228
  * import { NgModule } from '@angular/core';
4227
- *
4228
4229
  * import { AppComponent } from './app.component';
4229
4230
  *
4230
- * _@NgModule({
4231
+ * @NgModule({
4231
4232
  * declarations: [AppComponent],
4232
4233
  * imports: [BrowserModule, DialogsModule],
4233
4234
  * bootstrap: [AppComponent]
4234
4235
  * })
4235
4236
  * export class AppModule {}
4236
4237
  *
4237
- * platformBrowserDynamic().bootstrapModule(AppModule);
4238
- *
4239
4238
  * ```
4240
4239
  */
4241
4240
  class DialogsModule {