@progress/kendo-angular-popup
Version:
Kendo UI Angular Popup component - an easily customized popup from the most trusted provider of professional Angular components.
66 lines (65 loc) • 2.88 kB
TypeScript
/**-----------------------------------------------------------------------------------------
* Copyright © 2025 Progress Software Corporation. All rights reserved.
* Licensed under commercial license. See LICENSE.md in the project root for more information
*-------------------------------------------------------------------------------------------*/
import { ElementRef, TemplateRef, ViewContainerRef } from '@angular/core';
import { Align } from './align.interface';
import { Collision } from './collision.interface';
import { Margin } from './margin.interface';
import { Offset } from './offset.interface';
import { PositionMode } from './position-mode';
import { PopupAnimation } from './popup-animation.interface';
/**
* Defines the settings for the Popup when you open it through `PopupService` ([see example](slug:api_popup_popupservice#open)).
*/
export interface PopupSettings {
/**
* Controls the Popup animation. By default, the open and close animations are enabled ([see example]({% slug animations_popup %})).
*/
animate?: boolean | PopupAnimation;
/**
* Sets the element to use as an anchor. The Popup opens next to this element.
*/
anchor?: ElementRef | HTMLElement;
/**
* Sets the container to which the Popup appends.
*/
appendTo?: ViewContainerRef;
/**
* Sets the anchor pivot point ([see example]({% slug alignmentpositioning_popup %})).
*/
anchorAlign?: Align;
/**
* Sets the content of the Popup.
*/
content?: TemplateRef<any> | Function;
/**
* Sets the collision behavior of the Popup ([see example]({% slug viewportboundarydetection_popup %})).
*/
collision?: Collision;
/**
* Sets the margin value in pixels. Adds blank space between the Popup and the anchor.
*/
margin?: Margin;
/**
* Sets the position mode of the component. By default, the Popup uses fixed positioning. To use absolute positioning, set this option to `absolute`.
*
* To support mobile browsers with the zoom option, use the `absolute` positioning of the Popup.
*/
positionMode?: PositionMode;
/**
* Sets the pivot point of the Popup ([see example]({% slug alignmentpositioning_popup %})).
*/
popupAlign?: Align;
/**
* Sets a list of CSS classes to add to the internal animated element ([see example]({% slug appearance_popup %})).
*
* > To style the content of the Popup, use this property binding.
*/
popupClass?: string | Array<string> | Object;
/**
* Sets the absolute position of the element ([see example]({% slug alignmentpositioning_popup %}#toc-aligning-to-absolute-points)).
* The Popup opens next to this point. The pivot point of the Popup is defined by the `popupAlign` option. The boundary detection uses the window viewport.
*/
offset?: Offset;
}