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

package/localization/custom-messages.component.d.ts

@@ -6,8 +6,29 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
 import { Messages } from './messages';
 import * as i0 from "@angular/core";
 /**
- * Custom component messages override default component messages
- * ([see example](slug:globalization_dialogs#toc-internationalization)).
+ * Represents a component for customizing the messages in Dialog and Window components.
+ *
+ * Use the `CustomMessagesComponent` to override default messages with custom text. ([See example.](slug:globalization_dialogs#toc-internationalization)).
+ *
+ * @example
+ * ```typescript
+ * import { CustomMessagesComponent } from './custom-messages.component';
+ *
+ * @Component({
+ *   selector: 'my-dialog',
+ *   template: `
+ *     <kendo-dialog>
+ *       <kendo-dialog-messages
+ *         [closeTitle]="'Close dialog'"
+ *         [restoreTitle]="'Restore dialog'"
+ *         [maximizeTitle]="'Maximize dialog'"
+ *         [minimizeTitle]="'Minimize dialog'">
+ *       </kendo-dialog-messages>
+ *     </kendo-dialog>
+ *   `
+ * })
+ * export class MyDialogComponent {}
+ * ```
  */
 export declare class CustomMessagesComponent extends Messages {
     protected service: LocalizationService;

package/localization/messages.d.ts

@@ -9,19 +9,19 @@ import * as i0 from "@angular/core";
  */
 export declare class Messages extends ComponentMessages {
     /**
-     * The title of the close button.
+     * Sets the title for the **Close** button.
      */
     closeTitle: string;
     /**
-     * The title of the restore button.
+     * Sets the title for the **Restore** button.
      */
     restoreTitle: string;
     /**
-     * The title of the maximize button.
+     * Sets the title for the **Maximize** button.
      */
     maximizeTitle: string;
     /**
-     * The title of the minimize button.
+     * Sets the title for the **Minimize** button.
      */
     minimizeTitle: string;
     static ɵfac: i0.ɵɵFactoryDeclaration<Messages, never>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@progress/kendo-angular-dialog",
-  "version": "19.1.2-develop.2",
+  "version": "19.1.2-develop.3",
   "description": "Dialog Package for Angular",
   "license": "SEE LICENSE IN LICENSE.md",
   "author": "Progress",
@@ -23,7 +23,7 @@
     "package": {
       "productName": "Kendo UI for Angular",
       "productCode": "KENDOUIANGULAR",
-      "publishDate": 1749820374,
+      "publishDate": 1750152445,
       "licensingDocsUrl": "https://www.telerik.com/kendo-angular-ui/my-license/"
     }
   },
@@ -33,15 +33,15 @@
     "@angular/core": "16 - 20",
     "@angular/platform-browser": "16 - 20",
     "@progress/kendo-licensing": "^1.5.0",
-    "@progress/kendo-angular-buttons": "19.1.2-develop.2",
-    "@progress/kendo-angular-common": "19.1.2-develop.2",
-    "@progress/kendo-angular-icons": "19.1.2-develop.2",
-    "@progress/kendo-angular-l10n": "19.1.2-develop.2",
+    "@progress/kendo-angular-buttons": "19.1.2-develop.3",
+    "@progress/kendo-angular-common": "19.1.2-develop.3",
+    "@progress/kendo-angular-icons": "19.1.2-develop.3",
+    "@progress/kendo-angular-l10n": "19.1.2-develop.3",
     "rxjs": "^6.5.3 || ^7.0.0"
   },
   "dependencies": {
     "tslib": "^2.3.1",
-    "@progress/kendo-angular-schematics": "19.1.2-develop.2",
+    "@progress/kendo-angular-schematics": "19.1.2-develop.3",
     "@progress/kendo-popup-common": "^1.7.0"
   },
   "schematics": "./schematics/collection.json",

package/schematics/ngAdd/index.js

@@ -4,7 +4,7 @@ const schematics_1 = require("@angular-devkit/schematics");
 function default_1(options) {
     const finalOptions = Object.assign(Object.assign({}, options), { mainNgModule: 'DialogsModule', package: 'dialog', peerDependencies: {
             // Peer dependency of buttons
-            '@progress/kendo-angular-popup': '19.1.2-develop.2',
+            '@progress/kendo-angular-popup': '19.1.2-develop.3',
             // Peer dependency of icons
             '@progress/kendo-svg-icons': '^4.0.0'
         } });

package/window/models/theme-color.d.ts

@@ -6,7 +6,7 @@
  * Specifies the possible theme colors of the Window.
  *
  * The possible values are:
- * * `primary` —Applies coloring based on the `primary` theme color.
+ * * `primary`—Applies coloring based on the `primary` theme color.
  * * `light`— Applies coloring based on the `light` theme color.
  * * `dark`— Applies coloring based on the `dark` theme color.
  */

package/window/models/window-close-result.d.ts

@@ -3,7 +3,8 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Indicates that the **Close** button of a Window that is opened through `WindowService` is clicked.
+ * Indicates that the **Close** button of a Window opened through `WindowService` is clicked.
+ *
  */
 export declare class WindowCloseResult {
 }

package/window/models/window-messages.d.ts

@@ -3,8 +3,8 @@
 * Licensed under commercial license. See LICENSE.md in the project root for more information
 *-------------------------------------------------------------------------------------------*/
 /**
- * Defines the text of the labels that are shown within the Window.
- * Used primarily for localization.
+ * Defines the text of the labels that appear in the Window. Use for localization.
+ *
  */
 export interface WindowMessages {
     /**

package/window/models/window-ref.d.ts

@@ -7,34 +7,23 @@ import { Observable } from "rxjs";
 import { WindowComponent } from "../window.component";
 import { WindowCloseResult } from "./window-close-result";
 /**
- * Holds references to the object instance of the Window.
- * Controls the Windows that were opened through `WindowService`
- * ([see example]({% slug api_dialog_windowservice %}#toc-open)).
+ * Holds references to the Window instance. Controls Windows opened through `WindowService`. ([See example.]({% slug api_dialog_windowservice %}#toc-open))
  */
 export declare class WindowRef {
     /**
-     * A reference to the Window instance.
+     * Represents a reference to the Window instance.
      */
     window: ComponentRef<WindowComponent>;
     /**
-     * A reference to the child component of the Window.
-     * Available when the Window is opened with
-     * [component content](slug:service_window#toc-rendering-the-content-area).
+     * 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).
      */
     content: ComponentRef<any>;
     /**
-     * Allows you to close the Window by using code.
-     * When called with no arguments,
-     * the `result` Observable will be of type WindowCloseResult.
-     * When called with an argument, the `result` Observable will hold the provided value.
+     * 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.
      */
     close: Function;
     /**
-     * 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.
+     * 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.
      */
     result: Observable<WindowCloseResult>;
 }

package/window/models/window-settings.d.ts

@@ -8,26 +8,22 @@ import { WindowRef } from './window-ref';
 import { WindowState } from './window-types';
 import { WindowThemeColor } from './theme-color';
 /**
- * The settings for the Window actions when the Window is opened through `WindowService`
- * ([see example]({% slug api_dialog_windowservice %}#toc-open)).
+ * Represents the settings for the Window actions when you open a Window through `WindowService`. ([See example.]({% slug api_dialog_windowservice %}#toc-open))
  */
 export declare class WindowSettings {
     /**
-     * Defines a predicate that verifies if the closing of the Window should be prevented.
-     * It applies to clicking the **Close** button of the title bar, pressing the **Esc** key or calling the `close` method.
-     * Returning true from the predicate prevents the Window from closing.
-     * If the **Close** button of the title bar is clicked or **Esc** is pressed, a [WindowCloseResult]({% slug api_dialog_windowcloseresult %}) instance is passed.
-     * @param {any} ev
-     * @param {WindowRef} [windowRef] - provided only when the window is created using a component.
-     * @returns
+     * 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.
+     * @param {any} ev The event argument.
+     * @param {WindowRef} [windowRef] - The window reference, provided only when you create the window using a component.
+     * @returns Returns `true` to prevent closing the window.
      */
     preventClose?: (ev: any, windowRef?: WindowRef) => boolean;
     /**
-     * Sets the title of the Window.
+     * Sets the Window `title`.
      */
     title?: string;
     /**
-     * Defines the content of the Window.
+     * Defines the Window `content`.
      */
     content?: string | TemplateRef<any> | Function;
     /**
@@ -35,37 +31,35 @@ export declare class WindowSettings {
      */
     titleBarContent?: TemplateRef<any>;
     /**
-     * Defines the text of the labels that are shown within the Window.
-     * Used primarily for localization.
+     * Sets the text of the labels shown in the Window. Use for localization.
      */
     messages?: WindowMessages;
     /**
-     * Specifies if the content of the Window is persisted in the DOM
-     * when the Window is minimized.
+     * Set to `true` to persist the Window content in the DOM when minimized.
      */
     keepContent?: boolean;
     /**
-     * Specifies the width of the Window.
+     * Sets the width of the Window in pixels.
      */
     width?: number;
     /**
-     * Specifies the minimum width of the Window.
+     * Sets the minimum width of the Window in pixels.
      */
     minWidth?: number;
     /**
-     * Specifies the height of the Window.
+     * Sets the height of the Window in pixels.
      */
     height?: number;
     /**
-     * Specifies the minimum height of the Window.
+     * Sets the minimum height of the Window in pixels.
      */
     minHeight?: number;
     /**
-     * Specifies the left offset of the Window.
+     * Sets the left offset of the Window in pixels.
      */
     left?: number;
     /**
-     * Specifies the top offset of the Window.
+     * Sets the top offset of the Window in pixels.
      */
     top?: number;
     /**
@@ -73,13 +67,11 @@ export declare class WindowSettings {
      */
     draggable?: boolean;
     /**
-     * Sets the custom CSS classes that will be rendered on the Window wrapper element.
-     * Supports the union type of values that NgClass accepts [ngClass](link:site.data.urls.angular['ngclassapi']).
+     * Sets custom CSS classes for the Window wrapper element. Accepts any value supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
      */
     cssClass?: any;
     /**
-     * Sets the HTML attributes of the Window wrapper element.
-     * The property accepts string key-value based pairs.
+     * Sets HTML attributes for the Window wrapper element. Accepts string key-value pairs.
      */
     htmlAttributes?: {
         [key: string]: string;
@@ -89,16 +81,15 @@ export declare class WindowSettings {
      */
     resizable?: boolean;
     /**
-     * Specifies the initial state of the Window.
+     * Sets the initial state of the Window.
      */
     state?: WindowState;
     /**
-     * Defines the container in which the Window will be inserted.
-     * Specifying this option changes the place in the page hierarchy where the Window will be inserted.
+     * Defines the container where the Window is inserted. This changes the place in the page hierarchy where the Window appears.
      */
     appendTo?: ViewContainerRef;
     /**
-     * Sets the focused element query selector.
+     * Sets the query selector for the element to focus automatically.
      */
     autoFocusedElement?: string;
     /**

package/window/window-container.directive.d.ts

@@ -6,12 +6,11 @@ import { ViewContainerRef } from '@angular/core';
 import { WindowContainerService } from './window-container.service';
 import * as i0 from "@angular/core";
 /**
- * Provides an insertion point for the Windows which are created through the
- * Window service ([see example]({% slug api_dialog_windowservice %}#toc-open)).
- * Created Windows will be mounted after that element.
+ * Represents an insertion point for Windows created through the Window service.
+ * The created Windows mount after this element. ([See example.]({% slug api_dialog_windowservice %}#toc-open))
  *
  * @example
- * ```html-no-run
+ * ```html
  * <div kendoWindowContainer></div>
  * ```
  */

package/window/window-titlebar.component.d.ts

@@ -5,6 +5,10 @@
 import { OnDestroy, OnInit, ElementRef, NgZone, TemplateRef, AfterViewInit } from '@angular/core';
 import { DragResizeService } from './drag-resize.service';
 import * as i0 from "@angular/core";
+/**
+ * Represents the title bar of the Window component.
+ *
+ */
 export declare class WindowTitleBarComponent implements OnInit, AfterViewInit, OnDestroy {
     el: ElementRef;
     private ngZone;

package/window/window.component.d.ts

@@ -14,6 +14,12 @@ import { WindowThemeColor } from './models';
 import * as i0 from "@angular/core";
 /**
  * Represents the [Kendo UI Window component for Angular]({% slug overview_window_dialogs %}).
+ *
+ * @example
+ * ```html
+ * <kendo-window title="My Window" [width]="400" [height]="300">
+ * </kendo-window>
+ * ```
  */
 export declare class WindowComponent implements OnInit, OnDestroy, OnChanges, AfterViewInit {
     private el;
@@ -27,29 +33,23 @@ export declare class WindowComponent implements OnInit, OnDestroy, OnChanges, Af
      */
     autoFocusedElement: string;
     /**
-     * Specifies the text that is rendered in the title bar.
+     * Sets the text in the title bar.
      */
     title: string;
     /**
-     * Specifies whether the user will be able to drag the component.
+     * Specifies if the user can drag the component.
      * @default true
      */
     set draggable(value: boolean);
     get draggable(): boolean;
     /**
-     * Specifies whether the user will be able to resize the component.
+     * Specifies if the user can resize the component.
      * @default true
      */
     set resizable(value: boolean);
     get resizable(): boolean;
     /**
-     * The Window allows you to specify predefined theme colors.
-     * The theme color will be applied as a background and border color to the titlebar while also amending the text color accordingly.
-     *
-     * The possible values are:
-     * * `primary`
-     * * `dark`
-     * * `light`
+     * Sets the predefined theme color for the Window. The color applies to the title bar background and border, and updates the text color.
      */
     set themeColor(themeColor: WindowThemeColor);
     get themeColor(): WindowThemeColor;
@@ -68,56 +68,44 @@ export declare class WindowComponent implements OnInit, OnDestroy, OnChanges, Af
         [key: string]: string;
     };
     /**
-     * Specifies if the content of the component is persisted in the DOM when minimized.
+     * Specifies if the content stays in the DOM when minimized.
      * @default false
      */
     keepContent: boolean;
     /**
-     * Specifies the initial state of the component.
-     * If not specified, the value is set to `default`.
-     *
-     * The possible values are:
-     * * `minimized`
-     * * `maximized`
-     * * `default`
+     * Sets the initial state of the Window.
      */
     set state(value: WindowState);
     get state(): WindowState;
     /**
-     * Specifies the minimum width of the component.
-     * The `minWidth` property has to be set in pixels.
+     * Sets the minimum width in pixels.
      * @default 120
      */
     set minWidth(value: number);
     get minWidth(): number;
     /**
-     * Specifies the minimum height of the Window.
-     * The `minHeight` property has to be set in pixels.
+     * Sets the minimum height in pixels.
      * @default 100
      */
     set minHeight(value: number);
     get minHeight(): number;
     /**
-     * Specifies the width of the Window.
-     * The `width` property has to be set in pixels.
+     * Sets the width in pixels.
      */
     set width(value: number);
     get width(): number;
     /**
-     * Specifies the height of the Window.
-     * The `height` property has to be set in pixels.
+     * Sets the height in pixels.
      */
     set height(value: number);
     get height(): number;
     /**
-     * Specifies the initial top offset of the Window.
-     * The `top` property has to be set in pixels.
+     * Sets the initial top offset in pixels.
      */
     set top(value: number);
     get top(): number;
     /**
-     * Specifies the initial left offset of the Window.
-     * Numeric values are treated as pixels.
+     * Sets the initial left offset in pixels.
      */
     set left(value: number);
     get left(): number;
@@ -130,7 +118,7 @@ export declare class WindowComponent implements OnInit, OnDestroy, OnChanges, Af
      */
     dragStart: EventEmitter<any>;
     /**
-     * Fires when the Window was moved by the user.
+     * Fires after the Window has been moved by the user.
      */
     dragEnd: EventEmitter<any>;
     /**
@@ -138,7 +126,7 @@ export declare class WindowComponent implements OnInit, OnDestroy, OnChanges, Af
      */
     resizeStart: EventEmitter<any>;
     /**
-     * Fires when the Window was resized by the user.
+     * Fires after the Window has been resized by the user.
      */
     resizeEnd: EventEmitter<any>;
     /**
@@ -146,28 +134,23 @@ export declare class WindowComponent implements OnInit, OnDestroy, OnChanges, Af
      */
     close: EventEmitter<any>;
     /**
-     * Fires when the `width` property of the component was updated. The event is triggered only after the resizing
-     * has ended. The event data contains the new width. Allows a two-way binding of the `width` property.
+     * Fires when the `width` property is updated after resizing. The event data contains the new width. Allows two-way binding of the `width` property.
      */
     widthChange: EventEmitter<number>;
     /**
-     * Fires when the `height` property of the component was updated. The event is triggered only after the resizing
-     * has ended. The event data contains the new height. Allows a two-way binding of the `height` property.
+     * Fires when the `height` property is updated after resizing. The event data contains the new height. Allows two-way binding of the `height` property.
      */
     heightChange: EventEmitter<number>;
     /**
-     * Fires when the `top` property of the component was updated. The event is triggered only after the dragging
-     * and resizing have ended. The event data contains the new top offset. Allows a two-way binding of the `top` property.
+     * 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.
      */
     topChange: EventEmitter<number>;
     /**
-     * Fires when the `left` property of the component was updated. The event is triggered only after the dragging
-     * and resizing have ended. The event data contains the new left offset. Allows a two-way binding of the `left` property.
+     * 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.
      */
     leftChange: EventEmitter<number>;
     /**
-     * Fires when the `state` property of the component was updated. The event data contains the new state. Allows a
-     * two-way binding of the `state` property.
+     * Fires when the `state` property is updated. The event data contains the new state. Allows two-way binding of the `state` property.
      */
     stateChange: EventEmitter<WindowState>;
     /**
@@ -228,8 +211,8 @@ export declare class WindowComponent implements OnInit, OnDestroy, OnChanges, Af
      * corresponding property of the component instance will be updated.
      * This method is intended to be used for sizing dynamically created components using the
      * [`WindowService`]({% slug api_dialog_windowservice %})
-     * @param {WindowDimensionSetting} dimension - The option that will be updated
-     * @param {number} value - The value set in pixels
+     * @param dimension The option to update.
+     * @param value The value in pixels.
      */
     setDimension(dimension: WindowDimensionSetting, value: number): void;
     /**
@@ -238,8 +221,8 @@ export declare class WindowComponent implements OnInit, OnDestroy, OnChanges, Af
      * corresponding property of the component instance will be updated.
      * This method is intended to be used for positioning dynamically created components using the
      * [`WindowService`]({% slug api_dialog_windowservice %})
-     * @param {WindowOffsetSetting} offset - The option that will be updated
-     * @param {number} value - The value set in pixels
+     * @param offset The option to update.
+     * @param value The value in pixels.
      */
     setOffset(offset: WindowOffsetSetting, value: number): void;
     get showDefaultTitleBar(): boolean;

package/window/window.service.d.ts

@@ -8,8 +8,9 @@ import { WindowContainerService } from '../window/window-container.service';
 import { WindowRef } from './models/window-ref';
 import * as i0 from "@angular/core";
 /**
- * A service for opening Windows dynamically
- * ([see example]({% slug service_window %})).
+ * Provides methods for opening Windows dynamically.
+ *
+ * Use this service to open a Window component and manage its lifecycle. ([See example.]({% slug service_window %}))
  */
 export declare class WindowService {
     /**
@@ -23,39 +24,18 @@ export declare class WindowService {
      */
     resolver: ComponentFactoryResolver, containerService: WindowContainerService);
     /**
-     * Opens a Window component.
+     * Opens a Window component with the specified settings.
      *
-     * @param {WindowSettings} settings - The settings that define the Window.
-     * @returns {WindowRef} - A reference to the Window object.
+     * @param settings The settings that configure the Window.
+     * @returns A `WindowRef` instance for controlling the Window.
      *
      * @example
-     *
-     * ```ts-no-run
-     * _@Component({
-     *   selector: 'my-app',
-     *   template: `
-     *     <button kendoButton (click)="open()">Open window</button>
-     *     <div kendoWindowContainer></div>
-     *   `
-     * })
-     * export class AppComponent {
-     *     constructor( private windowService: WindowService ) {}
-     *
-     *     public open() {
-     *         var window = this.windowService.open({
-     *           title: "My window",
-     *           content: "My content!"
-     *         });
-     *
-     *         window.result.subscribe((result) => {
-     *           if (result instanceof WindowCloseResult) {
-     *             console.log("Window was closed");
-     *           }
-     *         });
-     *     }
-     * }
+     * ```ts
+     * const window = windowService.open({
+     *   title: 'My window',
+     *   content: 'My content!'
+     * });
      * ```
-     *
      */
     open(settings: WindowSettings): WindowRef;
     private applyOptions;

package/window.module.d.ts

@@ -13,25 +13,23 @@ import * as i7 from "./window/window-container.directive";
 import * as i8 from "./dialog/dialog-actions.component";
 import * as i9 from "./localization/custom-messages.component";
 /**
- * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi'])
- * definition for the Window component. Imports `WindowModule` into the
- * [root module](link:site.data.urls.angular['ngmodules']#angular-modularity)
- * of your application or into any other sub-module that will use the Window component.
+ * Represents the [NgModule](link:site.data.urls.angular['ngmoduleapi']) definition for the Window component.
+ *
+ * Use the `WindowModule` to include all Window components and directives in your application.
  *
  * @example
- * ```ts-no-run
+ * ```typescript
  * import { NgModule } from '@angular/core';
  * import { BrowserModule } from '@angular/platform-browser';
  * import { WindowModule } from '@progress/kendo-angular-window';
  * import { AppComponent } from './app.component';
  *
- * _@NgModule({
+ * @NgModule({
  *     bootstrap:    [AppComponent],
  *     declarations: [AppComponent],
  *     imports:      [BrowserModule, WindowModule]
  * })
- * export class AppModule {
- * }
+ * export class AppModule {}
  * ```
  */
 export declare class WindowModule {