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

package/esm2022/window/window-titlebar.component.mjs

@@ -10,6 +10,10 @@ import { of } from 'rxjs';
 import { hasClasses, isFocusable, isPresent } from '../common/util';
 import * as i0 from "@angular/core";
 import * as i1 from "./drag-resize.service";
+/**
+ * Represents the title bar of the Window component.
+ *
+ */
 export class WindowTitleBarComponent {
     el;
     ngZone;

package/esm2022/window/window.component.mjs

@@ -28,6 +28,12 @@ import * as i2 from "./navigation.service";
 import * as i3 from "@progress/kendo-angular-l10n";
 /**
  * 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 class WindowComponent {
     el;
@@ -41,11 +47,11 @@ export class WindowComponent {
      */
     autoFocusedElement;
     /**
-     * Specifies the text that is rendered in the title bar.
+     * Sets the text in the title bar.
      */
     title;
     /**
-     * Specifies whether the user will be able to drag the component.
+     * Specifies if the user can drag the component.
      * @default true
      */
     set draggable(value) {
@@ -55,7 +61,7 @@ export class WindowComponent {
         return this.options.draggable;
     }
     /**
-     * Specifies whether the user will be able to resize the component.
+     * Specifies if the user can resize the component.
      * @default true
      */
     set resizable(value) {
@@ -65,13 +71,7 @@ export class WindowComponent {
         return this.options.resizable;
     }
     /**
-     * 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) {
         this.handleThemeColorClass(this.themeColor, themeColor);
@@ -110,18 +110,12 @@ export class WindowComponent {
         return this._htmlAttributes;
     }
     /**
-     * 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 = false;
     /**
-     * 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) {
         this.options.state = value;
@@ -130,8 +124,7 @@ export class WindowComponent {
         return this.options.state;
     }
     /**
-     * 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) {
@@ -141,8 +134,7 @@ export class WindowComponent {
         return this.options.minWidth;
     }
     /**
-     * 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) {
@@ -152,8 +144,7 @@ export class WindowComponent {
         return this.options.minHeight;
     }
     /**
-     * Specifies the width of the Window.
-     * The `width` property has to be set in pixels.
+     * Sets the width in pixels.
      */
     set width(value) {
         this.setOption('width', value);
@@ -162,8 +153,7 @@ export class WindowComponent {
         return this.options.width;
     }
     /**
-     * Specifies the height of the Window.
-     * The `height` property has to be set in pixels.
+     * Sets the height in pixels.
      */
     set height(value) {
         this.setOption('height', value);
@@ -172,8 +162,7 @@ export class WindowComponent {
         return this.options.height;
     }
     /**
-     * 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) {
         this.setOption('top', value);
@@ -182,8 +171,7 @@ export class WindowComponent {
         return this.options.top;
     }
     /**
-     * Specifies the initial left offset of the Window.
-     * Numeric values are treated as pixels.
+     * Sets the initial left offset in pixels.
      */
     set left(value) {
         this.setOption('left', value);
@@ -220,7 +208,7 @@ export class WindowComponent {
      */
     dragStart = new EventEmitter();
     /**
-     * Fires when the Window was moved by the user.
+     * Fires after the Window has been moved by the user.
      */
     dragEnd = new EventEmitter();
     /**
@@ -228,7 +216,7 @@ export class WindowComponent {
      */
     resizeStart = new EventEmitter();
     /**
-     * Fires when the Window was resized by the user.
+     * Fires after the Window has been resized by the user.
      */
     resizeEnd = new EventEmitter();
     /**
@@ -236,28 +224,23 @@ export class WindowComponent {
      */
     close = new EventEmitter();
     /**
-     * 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 = new EventEmitter();
     /**
-     * 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 = new EventEmitter();
     /**
-     * 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 = new EventEmitter();
     /**
-     * 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 = new EventEmitter();
     /**
-     * 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 = new EventEmitter();
     /**
@@ -389,8 +372,8 @@ export class WindowComponent {
      * 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, value) {
         this.setOption(dimension, value);
@@ -402,8 +385,8 @@ export class WindowComponent {
      * 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, value) {
         this.setOption(offset, value);

package/esm2022/window/window.service.mjs

@@ -28,8 +28,9 @@ class WindowInjector {
     }
 }
 /**
- * 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 class WindowService {
     resolver;
@@ -43,39 +44,18 @@ export class WindowService {
         this.containerService = containerService;
     }
     /**
-     * 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) {
         const factory = this.resolver.resolveComponentFactory(WindowComponent);

package/esm2022/window.module.mjs

@@ -19,25 +19,23 @@ import * as i8 from "./dialog/dialog-actions.component";
 import * as i9 from "./localization/custom-messages.component";
 //IMPORTANT: NgModule export kept for backwards compatibility
 /**
- * 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 class WindowModule {