@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
@@ -3,33 +3,34 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * The settings for the Dialog actions when the Dialog is opened through `DialogService`
7
- * ([see example]({% slug api_dialog_dialogservice %}#toc-open)).
6
+ * Represents the settings for Dialog actions when you open a Dialog through `DialogService`.
7
+ *
8
+ * Use the `DialogAction` class to configure action buttons in the Dialog. ([See example.]({% slug api_dialog_dialogservice %}#toc-open))
9
+ *
8
10
  */
9
11
  export class DialogAction {
10
12
  /**
11
- * The text of the action button.
13
+ * Sets the text of the action button.
12
14
  */
13
15
  text;
14
16
  /**
15
- * 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.
17
+ * Sets the theme color of the action button. The theme color applies to the background, border, and text.
16
18
  */
17
19
  themeColor;
18
20
  /**
19
- * Specifies the background and border styles of the action button.
21
+ * Sets the background and border styles of the action button.
20
22
  */
21
23
  fillMode;
22
24
  /**
23
- * Sets the CSS classes that will be rendered on the action button.
24
- * Supports the union type of values that [ngClass](link:site.data.urls.angular['ngclassapi']) accepts.
25
+ * Sets the CSS classes for the action button. Accepts any value supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
25
26
  */
26
27
  cssClass;
27
28
  /**
28
- * Specifies the [SVG icon](slug:svgicon_list) to be rendered within the action button.
29
+ * Sets the [SVG icon](slug:svgicon_list) to display in the action button.
29
30
  */
30
31
  svgIcon;
31
32
  /**
32
- * Specifies the name of the [font icon](slug:icon_list) to be rendered within the action button.
33
+ * Sets the name of the [font icon](slug:icon_list) to display in the action button.
33
34
  */
34
35
  icon;
35
36
  /**
@@ -3,9 +3,10 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Indicates that the **Close** button is clicked. Used when the results from
7
- * the Dialogs that are opened through `DialogService` are filtered
8
- * ([see example]({% slug api_dialog_dialogservice %}#toc-open)).
6
+ * Represents the result when the **Close** button is clicked in a Dialog opened through `DialogService`.
7
+ *
8
+ * Used when the results from the Dialogs that are opened through `DialogService` are filtered. ([See example.]({% slug api_dialog_dialogservice %}#toc-open))
9
+ *
9
10
  */
10
11
  export class DialogCloseResult {
11
12
  }
@@ -3,16 +3,14 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Holds references to the object instance and published events of the Dialog.
7
- * Controls the Dialogs that were opened through the `DialogService`
8
- * ([see example]({% slug api_dialog_dialogservice %}#toc-open)).
6
+ * Holds references to the Dialog instance and published events when you open a Dialog through the `DialogService`.
7
+ *
8
+ * Use the `DialogRef` class to control and interact with Dialogs opened programmatically. ([See example.]({% slug api_dialog_dialogservice %}#toc-open))
9
+ *
9
10
  */
10
11
  export class DialogRef {
11
12
  /**
12
- * Emits events when the Dialog is closed either through the **Close** button of the title bar or through the action buttons.
13
- * If the **Close** button of the title bar is clicked, `DialogResult` is a `DialogCloseResult` instance.
14
- * If the Dialog is closed through the action buttons, `DialogResult` contains the object that was passed when the Dialog was opened.
15
- * When `close` is called with an argument, the result is the passed argument.
13
+ * 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.
16
14
  */
17
15
  result;
18
16
  /**
@@ -20,19 +18,13 @@ export class DialogRef {
20
18
  */
21
19
  dialog;
22
20
  /**
23
- * A reference to the child component of the Dialog.
24
- * Available when the Dialog is opened with [component content](slug:service_dialog#toc-rendering-the-content-area).
21
+ * 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).
25
22
  */
26
23
  content;
27
24
  /**
28
- * Closes the Dialog programmatically.
25
+ * 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.
29
26
  *
30
- * When called without a value, the result Observable emits an empty `DialogCloseResult` object.
31
- *
32
- * When called with a value, the result Observable emits the provided value.
33
- *
34
- * Usage Examples:
35
- * ```typescript
27
+ * ```ts
36
28
  * // Close without arguments: Returns an empty `DialogCloseResult` object.
37
29
  * dialogRef.close();
38
30
  *
@@ -3,104 +3,93 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * The settings that can be used when the Dialog is opened through `DialogService`.
7
- * ([see example]({% slug api_dialog_dialogservice %}#toc-open)).
6
+ * Represents the settings for opening a Dialog through the `DialogService`.
7
+ * ([See example.]({% slug api_dialog_dialogservice %}#toc-open))
8
+ *
8
9
  */
9
10
  export class DialogSettings {
10
11
  /**
11
- * Defines a predicate that verifies if the pressed dialog action should be prevented. Returning true from the predicate prevents the dialog from closing.
12
- * If the **Close** button of the title bar is clicked, `DialogResult` is a `DialogCloseResult` instance.
13
- * 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))
14
- * @param {DialogResult} ev
15
- * @param {DialogRef} [dialogRef] - provided only when the dialog is created using a component.
16
- * @returns
12
+ * Use the `preventAction` callback to check if the pressed Dialog action should be prevented. If `true`, the Dialog does not close.
13
+ * If the **Close** button in the title bar is clicked, `DialogResult` is a `DialogCloseResult` instance.
14
+ * 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))
15
+ * @param {DialogResult} ev The Dialog result.
16
+ * @param {DialogRef} [dialogRef] The Dialog reference, provided only when you create the Dialog using a component.
17
+ * @returns Returns `true` to prevent closing the Dialog.
17
18
  */
18
19
  preventAction;
19
20
  /**
20
- * Sets the title of the Dialog. If `title` is omitted,
21
- * the Dialog will not render a **Close** button.
21
+ * Sets the Dialog `title`. If you omit `title`, the Dialog does not render a **Close** button.
22
22
  */
23
23
  title;
24
24
  /**
25
- * Sets the CSS classes that will be rendered on the Dialog wrapper element.
26
- * Supports the union type of values that NgClass accepts [ngClass](link:site.data.urls.angular['ngclassapi']).
25
+ * Sets the CSS classes for the Dialog wrapper element. Accepts any value supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
27
26
  */
28
27
  cssClass;
29
28
  /**
30
- * Configures the Dialog opening animation ([see example]({% slug animations_dialog %})).
31
- * By default the animation type is set to `translate` and its duration is `300ms`.
29
+ * Configures the Dialog opening `animation` ([see example]({% slug animations_dialog %})).
30
+ * @default { type: 'translate', duration: 300 }
32
31
  */
33
32
  animation;
34
33
  /**
35
- * Sets the HTML attributes of the Dialog wrapper element.
36
- * The property accepts string key-value based pairs.
34
+ * Sets the HTML attributes for the Dialog wrapper element. Accepts string key-value pairs.
37
35
  */
38
36
  htmlAttributes;
39
37
  /**
40
- * Defines the content of the Dialog.
41
- * ([see example](slug:service_dialog#toc-rendering-the-content-area)).
38
+ * Defines the Dialog `content`. ([See example.](slug:service_dialog#toc-rendering-the-content-area))
42
39
  */
43
40
  content;
44
41
  /**
45
- * Specifies the width of the Dialog.
46
- * A numeric value sets the width in pixels.
47
- * A string value sets the width in arbitrary units—for example, `50%`.
42
+ * Sets the width of the Dialog.
43
+ * Use a number for pixels or a string for other units, for example, `50%`.
48
44
  */
49
45
  width;
50
46
  /**
51
- * Specifies the minimum width of the Dialog.
52
- * A numeric value sets the minimum width in pixels.
53
- * A string value sets the minimum width in arbitrary units—for example, `50%`.
47
+ * Sets the minimum width of the Dialog.
48
+ * Use a number for pixels or a string for other units, for example, `50%`.
54
49
  */
55
50
  minWidth;
56
51
  /**
57
- * Specifies the maximum width of the Dialog.
58
- * A numeric value sets the maximum width in pixels.
59
- * A string value sets the maximum width in arbitrary units—for example, `50%`.
52
+ * Sets the maximum width of the Dialog.
53
+ * Use a number for pixels or a string for other units, for example, `50%`.
60
54
  */
61
55
  maxWidth;
62
56
  /**
63
- * Specifies the height of the Dialog.
64
- * A numeric value sets the height in pixels.
65
- * A string value sets the height in arbitrary units—for example, `50%`.
57
+ * Sets the height of the Dialog.
58
+ * Use a number for pixels or a string for other units, for example, `50%`.
66
59
  */
67
60
  height;
68
61
  /**
69
- * Specifies the minimum height of the Dialog.
70
- * A numeric value sets the minimum height in pixels.
71
- * A string value sets the minimum height in arbitrary units—for example, `50%`.
62
+ * Sets the minimum height of the Dialog.
63
+ * Use a number for pixels or a string for other units, for example, `50%`.
72
64
  */
73
65
  minHeight;
74
66
  /**
75
- * Specifies the maximum height of the Dialog.
76
- * A numeric value sets the maximum height in pixels.
77
- * A string value sets the maximum height in arbitrary units—for example, `50%`.
67
+ * Sets the maximum height of the Dialog.
68
+ * Use a number for pixels or a string for other units, for example, `50%`.
78
69
  */
79
70
  maxHeight;
80
71
  /**
81
- * Defines the container in which the Dialog will be inserted.
82
- * Specifying this option changes the place in the page hierarchy where the Dialog will be inserted.
83
- * The styling of the component will remain the same.
72
+ * 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.
84
73
  */
85
74
  appendTo;
86
75
  /**
87
- * Specifies the title of the close button.
76
+ * Sets the `closeTitle` for the **Close** button.
88
77
  */
89
78
  closeTitle;
90
79
  /**
91
- * Sets the action buttons of the Dialog.
80
+ * Sets the Dialog `actions` buttons.
92
81
  */
93
82
  actions;
94
83
  /**
95
- * Specifies the layout of the action buttons in the Dialog.
84
+ * Sets the layout of the Dialog action buttons with `actionsLayout`.
96
85
  */
97
86
  actionsLayout;
98
87
  /**
99
- * Sets the focused element query selector.
88
+ * Sets the query selector for the element to focus automatically with `autoFocusedElement`.
100
89
  */
101
90
  autoFocusedElement;
102
91
  /**
103
- * Specifies the theme color of the Dialog.
92
+ * Sets the theme color of the Dialog.
104
93
  */
105
94
  themeColor;
106
95
  }
@@ -15,25 +15,23 @@ import * as i4 from "./dialog/dialog-actions.component";
15
15
  import * as i5 from "./localization/custom-messages.component";
16
16
  //IMPORTANT: NgModule export kept for backwards compatibility
17
17
  /**
18
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
19
- * definition for the Dialog component that includes all Dialog components and directives.
20
- * Imports `DialogModule` into the [root module](link:site.data.urls.angular['ngmodules']#angular-modularity)
21
- * of your application or into any other sub-module that will use the Dialog component.
18
+ * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi']) definition for the Dialog component.
19
+ *
20
+ * Use the `DialogModule` to include all Dialog components and directives in your application.
22
21
  *
23
22
  * @example
24
- * ```ts-no-run
23
+ * ```typescript
25
24
  * import { NgModule } from '@angular/core';
26
25
  * import { BrowserModule } from '@angular/platform-browser';
27
26
  * import { DialogModule } from '@progress/kendo-angular-dialog';
28
27
  * import { AppComponent } from './app.component';
29
28
  *
30
- * _@NgModule({
29
+ * @NgModule({
31
30
  * bootstrap: [AppComponent],
32
31
  * declarations: [AppComponent],
33
32
  * imports: [BrowserModule, DialogModule]
34
33
  * })
35
- * export class AppModule {
36
- * }
34
+ * export class AppModule {}
37
35
  * ```
38
36
  */
39
37
  export class DialogModule {
@@ -24,28 +24,24 @@ import * as i11 from "./window/window-titlebar.component";
24
24
  import * as i12 from "./window/window-container.directive";
25
25
  //IMPORTANT: NgModule export kept for backwards compatibility
26
26
  /**
27
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
28
- * definition for the Dialogs components.
27
+ * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi']) definition for the Dialogs components.
29
28
  *
30
- * @example
29
+ * Use the `DialogsModule` to include all Dialog and Window components and services in your application.
31
30
  *
32
- * ```ts
31
+ * @example
32
+ * ```typescript
33
33
  * import { DialogsModule } from '@progress/kendo-angular-dialog';
34
- *
35
34
  * import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
36
35
  * import { NgModule } from '@angular/core';
37
- *
38
36
  * import { AppComponent } from './app.component';
39
37
  *
40
- * _@NgModule({
38
+ * @NgModule({
41
39
  * declarations: [AppComponent],
42
40
  * imports: [BrowserModule, DialogsModule],
43
41
  * bootstrap: [AppComponent]
44
42
  * })
45
43
  * export class AppModule {}
46
44
  *
47
- * platformBrowserDynamic().bootstrapModule(AppModule);
48
- *
49
45
  * ```
50
46
  */
51
47
  export class DialogsModule {
@@ -15,8 +15,24 @@ import { WindowContainerDirective } from "./window/window-container.directive";
15
15
  import { WindowTitleBarComponent } from "./window/window-titlebar.component";
16
16
  import { WindowComponent } from "./window/window.component";
17
17
  /**
18
- * Utility array that contains all `Dialog` related components and directives.
19
- */
18
+ * Represents the utility array that that contains all `Dialog`-related components and directives.
19
+ *
20
+ * Use `KENDO_DIALOG` to import all Dialog components and directives at once.
21
+ *
22
+ * @example
23
+ * ```typescript
24
+ * import { Component } from '@angular/core';
25
+ * import { KENDO_DIALOG } from '@progress/kendo-angular-dialog';
26
+ *
27
+ * @Component({
28
+ * selector: 'my-dialog-app',
29
+ * standalone: true,
30
+ * imports: [KENDO_DIALOG],
31
+ * template: `...`
32
+ * })
33
+ * export class DialogAppComponent {}
34
+ * ```
35
+ */
20
36
  export const KENDO_DIALOG = [
21
37
  DialogComponent,
22
38
  DialogTitleBarComponent,
@@ -25,8 +41,24 @@ export const KENDO_DIALOG = [
25
41
  CustomMessagesComponent
26
42
  ];
27
43
  /**
28
- * Utility array that contains all `Window` related components and directives.
29
- */
44
+ * Represents the utility array that contains all `Window`-related components and directives.
45
+ *
46
+ * Use `KENDO_WINDOW` to import all Window components and directives at once.
47
+ *
48
+ * @example
49
+ * ```typescript
50
+ * import { Component } from '@angular/core';
51
+ * import { KENDO_WINDOW } from '@progress/kendo-angular-dialog';
52
+ *
53
+ * @Component({
54
+ * selector: 'my-window-app',
55
+ * standalone: true,
56
+ * imports: [KENDO_WINDOW],
57
+ * template: `...`
58
+ * })
59
+ * export class WindowAppComponent {}
60
+ * ```
61
+ */
30
62
  export const KENDO_WINDOW = [
31
63
  WindowComponent,
32
64
  WindowCloseActionDirective,
@@ -39,8 +71,24 @@ export const KENDO_WINDOW = [
39
71
  CustomMessagesComponent
40
72
  ];
41
73
  /**
42
- * Utility array that contains all `@progress/kendo-angular-dialog` related components and directives.
43
- */
74
+ * Represents the utility array that contains all `@progress/kendo-angular-dialog`-related components and directives.
75
+ *
76
+ * Use `KENDO_DIALOGS` to import all Dialog and Window components and directives at once.
77
+ *
78
+ * @example
79
+ * ```typescript
80
+ * import { Component } from '@angular/core';
81
+ * import { KENDO_DIALOGS } from '@progress/kendo-angular-dialog';
82
+ *
83
+ * @Component({
84
+ * selector: 'my-app',
85
+ * standalone: true,
86
+ * imports: [KENDO_DIALOGS],
87
+ * template: `...`
88
+ * })
89
+ * export class AppComponent {}
90
+ * ```
91
+ */
44
92
  export const KENDO_DIALOGS = [
45
93
  ...KENDO_DIALOG,
46
94
  ...KENDO_WINDOW
@@ -8,8 +8,29 @@ import { Messages } from './messages';
8
8
  import * as i0 from "@angular/core";
9
9
  import * as i1 from "@progress/kendo-angular-l10n";
10
10
  /**
11
- * Custom component messages override default component messages
12
- * ([see example](slug:globalization_dialogs#toc-internationalization)).
11
+ * Represents a component for customizing the messages in Dialog and Window components.
12
+ *
13
+ * Use the `CustomMessagesComponent` to override default messages with custom text. ([See example.](slug:globalization_dialogs#toc-internationalization)).
14
+ *
15
+ * @example
16
+ * ```typescript
17
+ * import { CustomMessagesComponent } from './custom-messages.component';
18
+ *
19
+ * @Component({
20
+ * selector: 'my-dialog',
21
+ * template: `
22
+ * <kendo-dialog>
23
+ * <kendo-dialog-messages
24
+ * [closeTitle]="'Close dialog'"
25
+ * [restoreTitle]="'Restore dialog'"
26
+ * [maximizeTitle]="'Maximize dialog'"
27
+ * [minimizeTitle]="'Minimize dialog'">
28
+ * </kendo-dialog-messages>
29
+ * </kendo-dialog>
30
+ * `
31
+ * })
32
+ * export class MyDialogComponent {}
33
+ * ```
13
34
  */
14
35
  export class CustomMessagesComponent extends Messages {
15
36
  service;
@@ -10,19 +10,19 @@ import * as i0 from "@angular/core";
10
10
  */
11
11
  export class Messages extends ComponentMessages {
12
12
  /**
13
- * The title of the close button.
13
+ * Sets the title for the **Close** button.
14
14
  */
15
15
  closeTitle;
16
16
  /**
17
- * The title of the restore button.
17
+ * Sets the title for the **Restore** button.
18
18
  */
19
19
  restoreTitle;
20
20
  /**
21
- * The title of the maximize button.
21
+ * Sets the title for the **Maximize** button.
22
22
  */
23
23
  maximizeTitle;
24
24
  /**
25
- * The title of the minimize button.
25
+ * Sets the title for the **Minimize** button.
26
26
  */
27
27
  minimizeTitle;
28
28
  static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.12", ngImport: i0, type: Messages, deps: null, target: i0.ɵɵFactoryTarget.Directive });
@@ -10,7 +10,7 @@ export const packageMetadata = {
10
10
  productName: 'Kendo UI for Angular',
11
11
  productCode: 'KENDOUIANGULAR',
12
12
  productCodes: ['KENDOUIANGULAR'],
13
- publishDate: 1749804135,
14
- version: '19.1.2-develop.1',
13
+ publishDate: 1750152445,
14
+ version: '19.1.2-develop.3',
15
15
  licensingDocsUrl: 'https://www.telerik.com/kendo-angular-ui/my-license/'
16
16
  };
@@ -3,7 +3,8 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Indicates that the **Close** button of a Window that is opened through `WindowService` is clicked.
6
+ * Indicates that the **Close** button of a Window opened through `WindowService` is clicked.
7
+ *
7
8
  */
8
9
  export class WindowCloseResult {
9
10
  }
@@ -3,34 +3,23 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * Holds references to the object instance of the Window.
7
- * Controls the Windows that were opened through `WindowService`
8
- * ([see example]({% slug api_dialog_windowservice %}#toc-open)).
6
+ * Holds references to the Window instance. Controls Windows opened through `WindowService`. ([See example.]({% slug api_dialog_windowservice %}#toc-open))
9
7
  */
10
8
  export class WindowRef {
11
9
  /**
12
- * A reference to the Window instance.
10
+ * Represents a reference to the Window instance.
13
11
  */
14
12
  window;
15
13
  /**
16
- * A reference to the child component of the Window.
17
- * Available when the Window is opened with
18
- * [component content](slug:service_window#toc-rendering-the-content-area).
14
+ * 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).
19
15
  */
20
16
  content;
21
17
  /**
22
- * Allows you to close the Window by using code.
23
- * When called with no arguments,
24
- * the `result` Observable will be of type WindowCloseResult.
25
- * When called with an argument, the `result` Observable will hold the provided value.
18
+ * 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.
26
19
  */
27
20
  close;
28
21
  /**
29
- * Emits events when the Window is closed through the **Esc** key, the **Close** button of the title bar or
30
- * by calling the `close` method.
31
- * When the Window is closed with the title bar button, **Esc** or by calling `close` with no arguments,
32
- * the result is of type [WindowCloseResult]({% slug api_dialog_windowcloseresult %}).
33
- * When `close` is called with an argument, the result is the passed argument.
22
+ * 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.
34
23
  */
35
24
  result;
36
25
  }
@@ -3,26 +3,22 @@
3
3
  * Licensed under commercial license. See LICENSE.md in the project root for more information
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  /**
6
- * The settings for the Window actions when the Window is opened through `WindowService`
7
- * ([see example]({% slug api_dialog_windowservice %}#toc-open)).
6
+ * Represents the settings for the Window actions when you open a Window through `WindowService`. ([See example.]({% slug api_dialog_windowservice %}#toc-open))
8
7
  */
9
8
  export class WindowSettings {
10
9
  /**
11
- * Defines a predicate that verifies if the closing of the Window should be prevented.
12
- * It applies to clicking the **Close** button of the title bar, pressing the **Esc** key or calling the `close` method.
13
- * Returning true from the predicate prevents the Window from closing.
14
- * If the **Close** button of the title bar is clicked or **Esc** is pressed, a [WindowCloseResult]({% slug api_dialog_windowcloseresult %}) instance is passed.
15
- * @param {any} ev
16
- * @param {WindowRef} [windowRef] - provided only when the window is created using a component.
17
- * @returns
10
+ * 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.
11
+ * @param {any} ev The event argument.
12
+ * @param {WindowRef} [windowRef] - The window reference, provided only when you create the window using a component.
13
+ * @returns Returns `true` to prevent closing the window.
18
14
  */
19
15
  preventClose;
20
16
  /**
21
- * Sets the title of the Window.
17
+ * Sets the Window `title`.
22
18
  */
23
19
  title;
24
20
  /**
25
- * Defines the content of the Window.
21
+ * Defines the Window `content`.
26
22
  */
27
23
  content;
28
24
  /**
@@ -30,37 +26,35 @@ export class WindowSettings {
30
26
  */
31
27
  titleBarContent;
32
28
  /**
33
- * Defines the text of the labels that are shown within the Window.
34
- * Used primarily for localization.
29
+ * Sets the text of the labels shown in the Window. Use for localization.
35
30
  */
36
31
  messages;
37
32
  /**
38
- * Specifies if the content of the Window is persisted in the DOM
39
- * when the Window is minimized.
33
+ * Set to `true` to persist the Window content in the DOM when minimized.
40
34
  */
41
35
  keepContent;
42
36
  /**
43
- * Specifies the width of the Window.
37
+ * Sets the width of the Window in pixels.
44
38
  */
45
39
  width;
46
40
  /**
47
- * Specifies the minimum width of the Window.
41
+ * Sets the minimum width of the Window in pixels.
48
42
  */
49
43
  minWidth;
50
44
  /**
51
- * Specifies the height of the Window.
45
+ * Sets the height of the Window in pixels.
52
46
  */
53
47
  height;
54
48
  /**
55
- * Specifies the minimum height of the Window.
49
+ * Sets the minimum height of the Window in pixels.
56
50
  */
57
51
  minHeight;
58
52
  /**
59
- * Specifies the left offset of the Window.
53
+ * Sets the left offset of the Window in pixels.
60
54
  */
61
55
  left;
62
56
  /**
63
- * Specifies the top offset of the Window.
57
+ * Sets the top offset of the Window in pixels.
64
58
  */
65
59
  top;
66
60
  /**
@@ -68,13 +62,11 @@ export class WindowSettings {
68
62
  */
69
63
  draggable;
70
64
  /**
71
- * Sets the custom CSS classes that will be rendered on the Window wrapper element.
72
- * Supports the union type of values that NgClass accepts [ngClass](link:site.data.urls.angular['ngclassapi']).
65
+ * Sets custom CSS classes for the Window wrapper element. Accepts any value supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
73
66
  */
74
67
  cssClass;
75
68
  /**
76
- * Sets the HTML attributes of the Window wrapper element.
77
- * The property accepts string key-value based pairs.
69
+ * Sets HTML attributes for the Window wrapper element. Accepts string key-value pairs.
78
70
  */
79
71
  htmlAttributes;
80
72
  /**
@@ -82,16 +74,15 @@ export class WindowSettings {
82
74
  */
83
75
  resizable;
84
76
  /**
85
- * Specifies the initial state of the Window.
77
+ * Sets the initial state of the Window.
86
78
  */
87
79
  state;
88
80
  /**
89
- * Defines the container in which the Window will be inserted.
90
- * Specifying this option changes the place in the page hierarchy where the Window will be inserted.
81
+ * Defines the container where the Window is inserted. This changes the place in the page hierarchy where the Window appears.
91
82
  */
92
83
  appendTo;
93
84
  /**
94
- * Sets the focused element query selector.
85
+ * Sets the query selector for the element to focus automatically.
95
86
  */
96
87
  autoFocusedElement;
97
88
  /**
@@ -7,12 +7,11 @@ import { WindowContainerService } from './window-container.service';
7
7
  import * as i0 from "@angular/core";
8
8
  import * as i1 from "./window-container.service";
9
9
  /**
10
- * Provides an insertion point for the Windows which are created through the
11
- * Window service ([see example]({% slug api_dialog_windowservice %}#toc-open)).
12
- * Created Windows will be mounted after that element.
10
+ * Represents an insertion point for Windows created through the Window service.
11
+ * The created Windows mount after this element. ([See example.]({% slug api_dialog_windowservice %}#toc-open))
13
12
  *
14
13
  * @example
15
- * ```html-no-run
14
+ * ```html
16
15
  * <div kendoWindowContainer></div>
17
16
  * ```
18
17
  */