@progress/kendo-angular-dialog
Version:
Dialog Package for Angular
35 lines (34 loc) • 1.64 kB
JavaScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2025 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
/**
* Holds references to the object instance and published events of the Dialog.
* Controls the Dialogs that were opened through the `DialogService`
* ([see example]({% slug api_dialog_dialogservice %}#toc-open)).
*/
export class DialogRef {
/**
* 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.
*/
result;
/**
* A reference to the Dialog instance.
*/
dialog;
/**
* 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).
*/
content;
/**
* Allows you to close the Dialog through code.
* When called with no arguments,
* the `result` Observable will be of type DialogCloseResult.
* When called with an argument, the `result` Observable will hold the provided value.
*/
close;
}