File

src/modal/alert-modal.interface.ts

Index

Properties

Properties

click
click: Function
Type : Function
Optional

Callback for the button click event

id
id: string
Type : string
Optional

Optional unique ID for the button

text
text: string
Type : string

Display value of the button

type
type: ModalButtonType
Type : ModalButtonType
Optional

Button type

export enum AlertModalType {
	default = "default",
	danger = "danger"
}

export interface AlertModalData {
	/**
	 * type of the modal
	 */
	type?: AlertModalType;
	/**
	 * Additional label shown over the modal
	 */
	label?: string;
	/**
	 * Primary title for the modal
	 */
	title?: string;
	/**
	 * Content for the modal body, could include HTML tags
	 */
	content?: string;
	/**
	 * Size of the modal to display.
	 */
	size?: "xs" | "sm" | "md" | "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;
	/**
	 * Set to `false` to hide the header's close button.
	 */
	showCloseButton?: 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;
}

results matching ""

    No results matching ""