@skyux/modals
Version:
This library was generated with [Nx](https://nx.dev).
91 lines (90 loc) • 4.35 kB
TypeScript
import { AfterViewInit, ElementRef, OnDestroy, OnInit, TemplateRef } from '@angular/core';
import { SkyScrollShadowEventArgs } from '@skyux/core';
import { SkyModalError } from './modal-error';
import * as i0 from "@angular/core";
/**
* Provides a common look-and-feel for modal content with options to display
* a common modal header, specify body content, and display a common modal footer
* and buttons.
*/
export declare class SkyModalComponent implements AfterViewInit, OnDestroy, OnInit {
#private;
wrapperClass: string | undefined;
/**
* A list of form-level errors to display to the user.
*/
set formErrors(value: SkyModalError[] | undefined);
/**
* The text to display as the modal's heading.
*/
headingText: string | undefined;
/**
* A help key that identifies the global help content to display. When specified along with `headingText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline) button is
* added to the modal header. Clicking the button invokes global help as configured by the application. This property only applies when `headingText` is also specified.
*/
helpKey: string | undefined;
/**
* The content of the help popover. When specified along with `headingText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline)
* button is added to the modal header. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover)
* when clicked using the specified content and optional title. This property only applies when `headingText` is also specified.
*/
helpPopoverContent: string | TemplateRef<unknown> | undefined;
/**
* The title of the help popover. This property only applies when `helpPopoverContent` is
* also specified.
*/
helpPopoverTitle: string | undefined;
/**
* Used by the confirm component to set a different role for the modal.
* @internal
*/
set ariaRole(value: string | undefined);
ariaRoleOrDefault: string;
/**
* @internal
* @deprecated
*/
tiledBody: boolean | undefined;
/**
* Used by the confirm component to set descriptive text without using a
* modal header.
* @internal
*/
set ariaDescribedBy(id: string | undefined);
get ariaDescribedBy(): string | undefined;
/**
* Used by the confirm component to set descriptive text without using a
* modal header.
* @internal
*/
set ariaLabelledBy(id: string | undefined);
get ariaLabelledBy(): string | undefined;
readonly layout: import("@angular/core").InputSignal<"none" | "fit">;
ariaOwns: string | null;
/**
* @deprecated
*/
legacyHelpKey: string | undefined;
modalState: string;
modalZIndex: number | undefined;
scrollShadow: SkyScrollShadowEventArgs;
size: string;
modalContentWrapperElement: ElementRef | undefined;
protected scrollShadowEnabled: boolean;
constructor();
onDocumentKeyUp(event: KeyboardEvent): void;
onDocumentKeyDown(event: KeyboardEvent): void;
ngOnInit(): void;
ngAfterViewInit(): void;
ngOnDestroy(): void;
/**
* @deprecated
*/
helpButtonClick(): void;
closeButtonClick(): void;
windowResize(): void;
scrollShadowChange(args: SkyScrollShadowEventArgs): void;
viewkeeperEnabled(): boolean;
static ɵfac: i0.ɵɵFactoryDeclaration<SkyModalComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<SkyModalComponent, "sky-modal", never, { "formErrors": { "alias": "formErrors"; "required": false; }; "headingText": { "alias": "headingText"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "ariaRole": { "alias": "ariaRole"; "required": false; }; "tiledBody": { "alias": "tiledBody"; "required": false; }; "ariaDescribedBy": { "alias": "ariaDescribedBy"; "required": false; }; "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; }; "layout": { "alias": "layout"; "required": false; "isSignal": true; }; }, {}, never, ["sky-modal-header", "sky-modal-content", "sky-modal-footer"], true, never>;
}