@progress/kendo-angular-dialog
Version:
Dialog Package for Angular
93 lines (92 loc) • 2.94 kB
JavaScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2025 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
/**
* Represents the settings for the Window actions when you open a Window through `WindowService`. ([See example.]({% slug api_dialog_windowservice %}#toc-open))
*/
export class WindowSettings {
/**
* 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;
/**
* Sets the Window `title`.
*/
title;
/**
* Defines the Window `content`.
*/
content;
/**
* Defines the content of the title bar.
*/
titleBarContent;
/**
* Sets the text of the labels shown in the Window. Use for localization.
*/
messages;
/**
* Set to `true` to persist the Window content in the DOM when minimized.
*/
keepContent;
/**
* Sets the width of the Window in pixels.
*/
width;
/**
* Sets the minimum width of the Window in pixels.
*/
minWidth;
/**
* Sets the height of the Window in pixels.
*/
height;
/**
* Sets the minimum height of the Window in pixels.
*/
minHeight;
/**
* Sets the left offset of the Window in pixels.
*/
left;
/**
* Sets the top offset of the Window in pixels.
*/
top;
/**
* Specifies is the Window is draggable.
*/
draggable;
/**
* Sets custom CSS classes for the Window wrapper element. Accepts any value supported by [`ngClass`](link:site.data.urls.angular['ngclassapi']).
*/
cssClass;
/**
* Sets HTML attributes for the Window wrapper element. Accepts string key-value pairs.
*/
htmlAttributes;
/**
* Specifies if the Window is resizable.
*/
resizable;
/**
* Sets the initial state of the Window.
*/
state;
/**
* Defines the container where the Window is inserted. This changes the place in the page hierarchy where the Window appears.
*/
appendTo;
/**
* Sets the query selector for the element to focus automatically.
*/
autoFocusedElement;
/**
* Sets the theme color of the Window.
*/
themeColor;
}