File

src/dialog/dialog-config.interface.ts

Description

Data structure for definig properties of a Dialog component.

Index

Properties

Indexable

[propName: string]: any

Properties

appendInline
appendInline: boolean
Type : boolean

Set to true to open the dialog next to the triggering component

content
content: string | TemplateRef
Type : string | TemplateRef

Body content for the Dialog.

data
data: Object
Type : Object

Config object passed to the rendered component. (Optional)

gap
gap: number
Type : number

Used to set the offset of the Dialog relative to the content it is associated to.

parentRef
parentRef: ElementRef
Type : ElementRef

Reference to the Parent element that links the Dialog.

placement
placement: string
Type : string

Parameter defining the placement in which the Dialog appears.

title
title: string
Type : string

Title for the Dialog header.

trigger
trigger: "click" | "hover" | "mouseenter"
Type : "click" | "hover" | "mouseenter"

Parameter for triggering Dialog display. With the release of v2.0 the type will just be "click" or "hover".

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.
	 * With the release of v2.0 the type will just be "click" or "hover".
	 */
	trigger: "click" | "hover" | "mouseenter";
	/**
	 * Parameter defining the placement in which the `Dialog` appears.
	 * @type {Placement}
	 */
	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;
	[propName: string]: any;
}

results matching ""

    No results matching ""