src/modal/alert-modal.interface.ts
Properties |
|
buttons |
buttons:
|
Type : Array<ModalButton>
|
Optional |
Array of |
close |
close:
|
Type : function
|
Optional |
Callback for non-specific close events. |
content |
content:
|
Type : string
|
Optional |
Content for the modal body, could include HTML tags |
hasScrollingContent |
hasScrollingContent:
|
Type : boolean
|
Optional |
Specify whether the modal contains scrolling content. This property overrides the automatic detection
of the existence of scrolling content. Set this property to |
label |
label:
|
Type : string
|
Optional |
Additional label shown over the modal |
modalContent |
modalContent:
|
Type : string
|
Optional |
Use of |
modalLabel |
modalLabel:
|
Type : string
|
Optional |
Use of |
modalTitle |
modalTitle:
|
Type : string
|
Optional |
Use of |
modalType |
modalType:
|
Type : string
|
Optional |
Use of |
size |
size:
|
Type : "xs" | "sm" | "lg"
|
Optional |
Size of the modal to display. |
title |
title:
|
Type : string
|
Optional |
Primary title for the modal |
type |
type:
|
Type : AlertModalType
|
Optional |
type of the modal |
export enum AlertModalType {
default = "default",
danger = "danger"
}
export interface AlertModalData {
/**
* Use of `modalType` is deprecated, use `type` instead
*/
modalType?: string;
/**
* type of the modal
*/
type?: AlertModalType;
/**
* Use of `modalLabel` is deprecated, use `label` instead
*/
modalLabel?: string;
/**
* Additional label shown over the modal
*/
label?: string;
/**
* Use of `modalTitle` is deprecated, use `title` instead
*/
modalTitle?: string;
/**
* Primary title for the modal
*/
title?: string;
/**
* Use of `modalContent` is deprecated, use `content` instead
*/
modalContent?: string;
/**
* Content for the modal body, could include HTML tags
*/
content?: string;
/**
* Size of the modal to display.
*/
size?: "xs" | "sm" | "lg";
/**
* Array of `ModalButton`s
*/
buttons?: Array<ModalButton>;
/**
* Specify whether the modal contains scrolling content. This property overrides the automatic detection
* of the existence of scrolling content. Set this property to `true` to force overflow indicator to
* show up or to `false` to force overflow indicator to disappear.
* It is set to `null` by default which indicates not to override automatic detection.
*/
hasScrollingContent?: boolean;
/**
* Callback for non-specific close events. `return false;` to prevent the modal from closing
* Property trigger has a value of `overlay` or `close`
*/
close?: (trigger?: "overlay" | "close") => boolean;
}
export enum ModalButtonType {
primary = "primary",
secondary = "secondary",
tertiary = "tertiary",
ghost = "ghost",
danger = "danger",
danger_primary = "danger--primary"
}
export interface ModalButton {
/**
* Display value of the button
*/
text: string;
/**
* Optional unique ID for the button
*/
id?: string;
/**
* Button type
*/
type?: ModalButtonType;
/**
* Callback for the button `click` event
*/
click?: Function;
}