### File

`src/dialog/dialog-config.interface.ts`

### Description

Data structure for definig properties of a `Dialog` component.

### Index

###### Properties
Optional appendInline Optional closeTrigger content Optional data Optional gap Optional parentRef Optional placement shouldClose Optional title Optional trigger

### Indexable

`[propName: string]: `any``
Defined in src/dialog/dialog-config.interface.ts:47
Additional arbitrary properties (mostly for internal/extended component use)

### Properties

appendInline
`appendInline: `boolean``
Type : `boolean`
Optional
Set to `true` to open the dialog next to the triggering component

closeTrigger
`closeTrigger: `"mouseout" | "mouseleave"``
Type : `"mouseout" | "mouseleave"`
Optional
Parameter for triggering the `Dialog` close event.

content
`content: `string | TemplateRef<any>``
Type : `string | TemplateRef<any>`
Body content for the `Dialog`.

data
`data: `Object``
Type : `Object`
Optional
Config object passed to the rendered component. (Optional)

gap
`gap: `number``
Type : `number`
Optional
Used to set the offset of the `Dialog` relative to the content it is associated to.

parentRef
`parentRef: `ElementRef``
Type : `ElementRef`
Optional
Reference to the Parent element that links the `Dialog`.

placement
`placement: `string``
Type : `string`
Optional
Parameter defining the placement in which the `Dialog` appears.

shouldClose
`shouldClose: `function``
Type : `function`
Callback to control the closing behaviour. return `true` to close, and `false` to prevent closing

title
`title: `string``
Type : `string`
Optional
Title for the `Dialog` header.

trigger
`trigger: `"click" | "hover" | "mouseenter"``
Type : `"click" | "hover" | "mouseenter"`
Optional
Parameter for triggering `Dialog` display.

    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;
    }

# result-matching ""

# No results matching ""