@progress/kendo-angular-dialog
Version:
Dialog Package for Angular
102 lines (101 loc) • 3.11 kB
JavaScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2025 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
/**
* The settings for the Window actions when the Window is opened through `WindowService`
* ([see example]({% slug api_dialog_windowservice %}#toc-open)).
*/
export 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
*/
preventClose;
/**
* Sets the title of the Window.
*/
title;
/**
* Defines the content of the Window.
*/
content;
/**
* Defines the content of the title bar.
*/
titleBarContent;
/**
* Defines the text of the labels that are shown within the Window.
* Used primarily for localization.
*/
messages;
/**
* Specifies if the content of the Window is persisted in the DOM
* when the Window is minimized.
*/
keepContent;
/**
* Specifies the width of the Window.
*/
width;
/**
* Specifies the minimum width of the Window.
*/
minWidth;
/**
* Specifies the height of the Window.
*/
height;
/**
* Specifies the minimum height of the Window.
*/
minHeight;
/**
* Specifies the left offset of the Window.
*/
left;
/**
* Specifies the top offset of the Window.
*/
top;
/**
* Specifies is the Window is draggable.
*/
draggable;
/**
* 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']).
*/
cssClass;
/**
* Sets the HTML attributes of the Window wrapper element.
* The property accepts string key-value based pairs.
*/
htmlAttributes;
/**
* Specifies if the Window is resizable.
*/
resizable;
/**
* Specifies the initial state of the Window.
*/
state;
/**
* 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.
*/
appendTo;
/**
* Sets the focused element query selector.
*/
autoFocusedElement;
/**
* Sets the theme color of the Window.
*/
themeColor;
}