fundamental-ngx/lib/modal/modal-utils/modal-config.d.ts

SAP Fiori Fundamentals, implemented in Angular

/**
 * Configuration for opening a modal with the ModalService.
 */
export declare class ModalConfig {
    /** Id for the modal component. If omitted, a unique one is generated. */
    id?: string;
    /** Width of the modal. */
    width?: string;
    /** Height of the modal. */
    height?: string;
    /** Minimum width of the modal. */
    minWidth?: string;
    /** Minimum height of the modal. */
    minHeight?: string;
    /** Maximum width of the modal. */
    maxWidth?: string;
    /** Maximum height of the modal. */
    maxHeight?: string;
    /** Aria label for the modal component element. */
    ariaLabel?: string;
    /** Id of the element that labels the modal. */
    ariaLabelledBy?: string;
    /** Id of the element that describes the modal. */
    ariaDescribedBy?: string;
    /** Whether the modal should have a backdrop. */
    hasBackdrop?: boolean;
    /** Global classes to apply to the backdrop. */
    backdropClass?: string;
    /** Whether clicking on the backdrop should close the modal. Only works if hasBackdrop is true. */
    backdropClickCloseable?: boolean;
    /** Global classes to apply to the modal panel. */
    modalPanelClass?: string;
    /** Whether the escape key should close the modal. */
    escKeyCloseable?: boolean;
    /** Whether the modal should be focus trapped. */
    focusTrapped?: boolean;
    /** Data to pass along to the content through the ModalRef. */
    data?: any;
}