src/dialog/dialog-config.interface.ts
Data structure for definig properties of a Dialog component.
Properties |
|
[propName: string]:
|
|
Defined in src/dialog/dialog-config.interface.ts:47
|
|
Additional arbitrary properties (mostly for internal/extended component use) |
| appendInline |
appendInline:
|
Type : boolean
|
| Optional |
|
Set to |
| closeTrigger |
closeTrigger:
|
Type : "mouseout" | "mouseleave"
|
| Optional |
|
Parameter for triggering the |
| content |
content:
|
Type : string | TemplateRef<any>
|
|
Body content for the |
| data |
data:
|
Type : Object
|
| Optional |
|
Config object passed to the rendered component. (Optional) |
| gap |
gap:
|
Type : number
|
| Optional |
|
Used to set the offset of the |
| offset |
offset:
|
Type : literal type
|
| Optional |
|
This specifies any vertical and horizontal offset for the position of the dialog |
| parentRef |
parentRef:
|
Type : ElementRef
|
| Optional |
|
Reference to the Parent element that links the |
| placement |
placement:
|
Type : string
|
| Optional |
|
Parameter defining the placement in which the |
| shouldClose |
shouldClose:
|
Type : function
|
|
Callback to control the closing behaviour. return |
| title |
title:
|
Type : string
|
| Optional |
|
Title for the |
| trigger |
trigger:
|
Type : "click" | "hover" | "mouseenter"
|
| Optional |
|
Parameter for triggering |
| wrapperClass |
wrapperClass:
|
Type : string
|
| Optional |
|
Classes to add to the dialog container |
import { ElementRef, TemplateRef } from "@angular/core";
/**
* Data structure for definig properties of a `Dialog` component.
**/
export interface DialogConfig {
/**
* Title for the `Dialog` header.
*/
title?: string;
/**
* Body content for the `Dialog`.
*/
content: string | TemplateRef<any>;
/**
* Parameter for triggering `Dialog` display.
*/
trigger?: "click" | "hover" | "mouseenter";
/**
* Parameter for triggering the `Dialog` close event.
*/
closeTrigger?: "mouseout" | "mouseleave";
/**
* Callback to control the closing behaviour. return `true` to close, and `false` to prevent closing
*/
shouldClose: () => boolean;
/**
* Parameter defining the placement in which the `Dialog` appears.
*/
placement?: string;
/**
* Used to set the offset of the `Dialog` relative to the content it
* is associated to.
*/
gap?: number;
/**
* Reference to the Parent element that links the `Dialog`.
*/
parentRef?: ElementRef;
/**
* Set to `true` to open the dialog next to the triggering component
*/
appendInline?: boolean;
/**
* Config object passed to the rendered component. (Optional)
*/
data?: Object;
/**
* Additional arbitrary properties (mostly for internal/extended component use)
*/
[propName: string]: any;
/**
* Classes to add to the dialog container
*/
wrapperClass?: string;
/**
* This specifies any vertical and horizontal offset for the position of the dialog
*/
offset?: { x: number, y: number };
}