@eui/ecl 19.3.3-snapshot-1754912586607 → 21.0.0-alpha.2

package/components/ecl-modal/index.d.ts

@@ -1,19 +1,273 @@
-import { EclModalComponent } from './ecl-modal.component';
-import { EclModalHeaderComponent } from './ecl-modal-header.component';
-import { EclModalFooterComponent } from './ecl-modal-footer.component';
-import { EclModalBodyComponent } from './ecl-modal-body.component';
-import { EclModalBodyFixedContentDirective } from './ecl-modal-body-fixed.directive';
-import { EclModalTriggerDirective } from './ecl-modal-trigger.directive';
-import { EclModalCloseDirective } from './ecl-modal-close.directive';
-export * from './ecl-modal.module';
-export * from './ecl-modal.component';
-export * from './ecl-modal-header.component';
-export * from './ecl-modal-footer.component';
-export * from './ecl-modal-body.component';
-export * from './ecl-modal-body-fixed.directive';
-export * from './ecl-modal-trigger.directive';
-export * from './ecl-modal-close.directive';
-export * from './events/index';
-export * from './models/ecl-modal-result.model';
-export declare const EUI_ECL_MODAL: readonly [typeof EclModalComponent, typeof EclModalHeaderComponent, typeof EclModalFooterComponent, typeof EclModalBodyComponent, typeof EclModalBodyFixedContentDirective, typeof EclModalTriggerDirective, typeof EclModalCloseDirective];
-//# sourceMappingURL=index.d.ts.map
+import * as i0 from '@angular/core';
+import { EventEmitter, OnChanges, AfterContentInit, OnDestroy, QueryList } from '@angular/core';
+import { ECLBaseDirective, EclBaseEvent, EclThemeService } from '@eui/ecl/core';
+import { EclButtonComponent } from '@eui/ecl/components/ecl-button';
+
+/**
+ * Directive that allows an element to close the modal on click.
+ *
+ * Can emit a result and indicate the role (e.g., confirm, cancel).
+ */
+declare class EclModalCloseDirective<T> extends ECLBaseDirective {
+    /**
+     * Optional result value to emit when modal is closed.
+     */
+    eclModalResult: T;
+    /**
+     * Optional role associated with the modal close action (e.g., confirm, cancel).
+     */
+    eclModalRole: 'confirm' | 'cancel' | string;
+    /**
+     * Event emitted when the element is clicked and the modal should be closed.
+     */
+    modalClose: EventEmitter<any>;
+    /**
+     * Handles click events and emits the `modalClose` event.
+     */
+    onClick(evt: MouseEvent): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclModalCloseDirective<any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<EclModalCloseDirective<any>, "[eclModalClose]", never, { "eclModalResult": { "alias": "eclModalClose"; "required": false; }; "eclModalRole": { "alias": "eclModalRole"; "required": false; }; }, { "modalClose": "modalClose"; }, never, never, true, never>;
+}
+
+declare class EclModalOpenEvent extends EclBaseEvent {
+}
+
+interface EclModalResult<T = any> {
+    eclModalData?: T;
+    eclModalRole?: string;
+}
+
+declare class EclModalCloseEvent<T = any> extends EclBaseEvent {
+    eclModalResult?: EclModalResult<T>;
+    constructor(eclModalResult?: EclModalResult<T>);
+}
+
+/**
+ * Header component used within the ECL Modal.
+ *
+ * Displays an icon depending on the modal variant, user-defined content,
+ * and a close button that emits a close event.
+ */
+declare class EclModalHeaderComponent<T = any> extends ECLBaseDirective {
+    eclThemeService: EclThemeService;
+    /**
+     * Defines the visual variant of the modal.
+     *
+     * Determines which icon is shown in the header.
+     *
+     * Possible values:
+     * - `'information'`
+     * - `'success'`
+     * - `'warning'`
+     * - `'error'`
+     * - any other custom string (no icon will be shown)
+     */
+    variant: 'information' | 'success' | 'warning' | 'error' | string;
+    /**
+     * Event emitted when the close button is clicked.
+     *
+     * Emits an `EclModalCloseEvent` object.
+     */
+    modalClose: EventEmitter<EclModalCloseEvent<T>>;
+    /**
+     * Applies the ECL CSS class for modal header container.
+     */
+    closeButton: EclButtonComponent;
+    get cssClasses(): string;
+    /**
+     * Handles the click event on the close button.
+     *
+     * Emits a `modalClose` event with no payload.
+     */
+    onCloseClick(): void;
+    /**
+     * Returns the name of the icon associated with the current variant.
+     *
+     * @returns The icon name, or `null` if no matching variant exists.
+     */
+    getIcon(): 'information' | 'check-filled' | 'warning' | 'error' | null;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclModalHeaderComponent<any>, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<EclModalHeaderComponent<any>, "[eclModalHeader]", never, { "variant": { "alias": "variant"; "required": false; }; }, { "modalClose": "modalClose"; }, never, ["*"], true, never>;
+}
+
+declare class EclModalComponent<T = any> extends ECLBaseDirective implements OnChanges, AfterContentInit, OnDestroy {
+    /**
+     * Defines the visual variant of the modal.
+     *
+     * Possible values: 'information', 'success', 'warning', 'error', or a custom string.
+     */
+    variant: 'information' | 'success' | 'warning' | 'error' | string;
+    /**
+     * Defines the size of the modal.
+     *
+     * Possible values:
+     * - 's' – small
+     * - 'm' – medium
+     * - 'l' – large (default)
+     * - 'full' – full width
+     */
+    size: 's' | 'm' | 'l' | 'full' | string;
+    /**
+     * Controls whether the modal is open.
+     *
+     * Can be set to any truthy value to open the modal.
+     */
+    set isOpen(value: boolean | any);
+    /**
+     * Returns the open state of the modal.
+     */
+    get isOpen(): boolean | null;
+    /**
+     * Emits when the modal is closed.
+     *
+     * Carries an instance of `EclModalCloseEvent`.
+     */
+    modalClose: EventEmitter<EclModalCloseEvent<T>>;
+    /**
+     * Emits when the modal is opened.
+     *
+     * Carries an instance of `EclModalOpenEvent`.
+     */
+    modalOpen: EventEmitter<EclModalOpenEvent>;
+    /**
+     * Header component projected into the modal.
+     */
+    eclModalHeader: EclModalHeaderComponent<T>;
+    /**
+     * All close directives projected inside the modal.
+     */
+    eclModalCloseComponents: QueryList<EclModalCloseDirective<T>>;
+    private _isOpen;
+    private destroy$;
+    /**
+     * Binds the `open` attribute to the modal element.
+     *
+     * Used by the native `<dialog>` element.
+     */
+    get isModalOpened(): boolean;
+    /**
+     * Applies base and variant CSS classes to the modal element.
+     */
+    get cssClasses(): string;
+    /**
+     * Handles ESC key press to close the modal with `cancel` role.
+     */
+    onEscapeKeydownHandler(): void;
+    /**
+     * Reacts to input changes and updates the modal header if available.
+     */
+    ngOnChanges(): void;
+    /**
+     * Subscribes to close events from header and close directives after content is initialized.
+     */
+    ngAfterContentInit(): void;
+    /**
+     * Cleans up subscriptions on component destruction.
+     */
+    ngOnDestroy(): void;
+    /**
+     * Opens the modal and emits a `modalOpen` event.
+     *
+     * If the event is not prevented, the modal will be displayed.
+     */
+    openModal(): void;
+    /**
+     * Closes the modal and emits a `modalClose` event with optional result data.
+     *
+     * If the event is not prevented, the modal will be hidden.
+     */
+    closeModal(result?: EclModalResult<T>): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclModalComponent<any>, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<EclModalComponent<any>, "dialog[eclModal]", never, { "variant": { "alias": "variant"; "required": false; }; "size": { "alias": "size"; "required": false; }; "isOpen": { "alias": "isOpen"; "required": false; }; }, { "modalClose": "modalClose"; "modalOpen": "modalOpen"; }, ["eclModalHeader", "eclModalCloseComponents"], ["*"], true, never>;
+}
+
+/**
+ * Footer component used within the ECL Modal.
+ *
+ * Automatically applies styling to buttons projected into the footer.
+ */
+declare class EclModalFooterComponent extends ECLBaseDirective implements AfterContentInit {
+    /**
+     * Queries all button components projected into the footer.
+     */
+    buttonComponents: QueryList<EclButtonComponent>;
+    /**
+     * Applies the ECL CSS class for modal footer container.
+     */
+    get cssClasses(): string;
+    /**
+     * Lifecycle hook that runs after content projection.
+     *
+     * Applies `ecl-modal__button` class to each projected button component.
+     */
+    ngAfterContentInit(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclModalFooterComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<EclModalFooterComponent, "[eclModalFooter]", never, {}, {}, ["buttonComponents"], ["*"], true, never>;
+}
+
+/**
+ * Body component used inside the ECL Modal.
+ *
+ * Optionally allows scrollable content inside the modal body.
+ */
+declare class EclModalBodyComponent extends ECLBaseDirective {
+    /**
+     * When true, adds a modifier class to allow scrollable content inside the modal body.
+     */
+    isScrollable: boolean;
+    /**
+     * Applies CSS classes for the modal body and scrollable modifier if enabled.
+     */
+    get cssClasses(): string;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclModalBodyComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<EclModalBodyComponent, "[eclModalBody]", never, { "isScrollable": { "alias": "isScrollable"; "required": false; }; }, {}, never, ["[eclModalBodyFixedContent]", "*"], true, never>;
+    static ngAcceptInputType_isScrollable: unknown;
+}
+
+/**
+ * Directive for styling fixed content inside the modal body.
+ *
+ * Applies the appropriate CSS class to mark the element as fixed inside the modal body.
+ */
+declare class EclModalBodyFixedContentDirective extends ECLBaseDirective {
+    /**
+     * Applies the `ecl-modal__body-fixed` class to the host element.
+     */
+    className: boolean;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclModalBodyFixedContentDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<EclModalBodyFixedContentDirective, "[eclModalBodyFixedContent]", never, {}, {}, never, never, true, never>;
+}
+
+/**
+ * Directive used to trigger opening of a target ECL modal on click.
+ */
+declare class EclModalTriggerDirective<T = any> extends ECLBaseDirective {
+    /**
+     * Reference to the modal component that should be opened on click.
+     */
+    eclModalTriggerFor: EclModalComponent<T>;
+    /**
+     * Handles click event and opens the target modal.
+     */
+    onClick(evt: MouseEvent): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclModalTriggerDirective<any>, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<EclModalTriggerDirective<any>, "[eclModalTriggerFor]", never, { "eclModalTriggerFor": { "alias": "eclModalTriggerFor"; "required": false; }; }, {}, never, never, true, never>;
+}
+
+/**
+ * @description
+ * Module that provides the EclModal component and its dependencies.
+ *
+ * @deprecated Use {@link EUI_ECL_MODAL} instead.
+ */
+declare class EclModalModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<EclModalModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<EclModalModule, never, [typeof EclModalComponent, typeof EclModalHeaderComponent, typeof EclModalBodyComponent, typeof EclModalBodyFixedContentDirective, typeof EclModalFooterComponent, typeof EclModalCloseDirective, typeof EclModalTriggerDirective], [typeof EclModalComponent, typeof EclModalHeaderComponent, typeof EclModalBodyComponent, typeof EclModalBodyFixedContentDirective, typeof EclModalFooterComponent, typeof EclModalCloseDirective, typeof EclModalTriggerDirective]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<EclModalModule>;
+}
+
+declare const EUI_ECL_MODAL: readonly [typeof EclModalComponent, typeof EclModalHeaderComponent, typeof EclModalFooterComponent, typeof EclModalBodyComponent, typeof EclModalBodyFixedContentDirective, typeof EclModalTriggerDirective, typeof EclModalCloseDirective];
+
+export { EUI_ECL_MODAL, EclModalBodyComponent, EclModalBodyFixedContentDirective, EclModalCloseDirective, EclModalCloseEvent, EclModalComponent, EclModalFooterComponent, EclModalHeaderComponent, EclModalModule, EclModalOpenEvent, EclModalTriggerDirective };
+export type { EclModalResult };
+//# sourceMappingURL=index.d.ts.map

package/components/ecl-modal/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../components/ecl-modal/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,iCAAiC,EAAE,MAAM,kCAAkC,CAAC;AACrF,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE,cAAc,oBAAoB,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,kCAAkC,CAAC;AACjD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iCAAiC,CAAC;AAEhD,eAAO,MAAM,aAAa,6OAQhB,CAAC"}
+{"version":3,"file":"index.d.ts","sources":["../../../components/ecl-modal/ecl-modal-close.directive.ts","../../../components/ecl-modal/events/ecl-modal-open.event.ts","../../../components/ecl-modal/models/ecl-modal-result.model.ts","../../../components/ecl-modal/events/ecl-modal-close.event.ts","../../../components/ecl-modal/ecl-modal-header.component.ts","../../../components/ecl-modal/ecl-modal.component.ts","../../../components/ecl-modal/ecl-modal-footer.component.ts","../../../components/ecl-modal/ecl-modal-body.component.ts","../../../components/ecl-modal/ecl-modal-body-fixed.directive.ts","../../../components/ecl-modal/ecl-modal-trigger.directive.ts","../../../components/ecl-modal/ecl-modal.module.ts","../../../components/ecl-modal/index.ts"],"sourcesContent":[null,null,null,null,null,null,null,null,null,null,null,null],"names":[],"mappings":";;;;;AAGA;;;;AAIG;AACH;AAII;;AAEG;;AAGH;;AAEG;AACM;AAET;;AAEG;AACO;AAEV;;AAEG;AAEH;;;AAGH;;ACjCD;AAAsD;;ACAhD;;;AAGL;;ACDD;AACoB;AAAA;AAGnB;;ACED;;;;;AAKG;AACH;AAYI;AAEA;;;;;;;;;;;AAWG;;AAGH;;;;AAIG;AACO;AAEV;;AAEG;;;AAQH;;;;AAIG;AACH;AAIA;;;;AAIG;;;;AAcN;;AC7DD;AAQI;;;;AAIG;;AAGH;;;;;;;;AAQG;;AAGH;;;;AAIG;AAEH;AAKA;;AAEG;AACH;AAIA;;;;AAIG;AACO;AAEV;;;;AAIG;AACO;AAEV;;AAEG;AACsD;AAEzD;;AAEG;;;;AAOH;;;;AAIG;;AAMH;;AAEG;;AASH;;AAEG;AAEH;AAIA;;AAEG;AACH;AAMA;;AAEG;AACH;AAkBA;;AAEG;AACH;AAKA;;;;AAIG;AACH;AAUA;;;;AAIG;;;;AAcN;;AClMD;;;;AAIG;AACH;AAMI;;AAEG;AAEH;AAEA;;AAEG;;AAMH;;;;AAIG;AACH;;;AASH;;ACvCD;;;;AAIG;AACH;AASI;;AAEG;AACqC;AAExC;;AAEG;;;;;AAQN;;AC9BD;;;;AAIG;AACH;AAII;;AAEG;AACyC;;;AAC/C;;ACZD;;AAEG;AACH;AAKI;;AAEG;AACM;AAET;;AAEG;AAEH;;;AAGH;;ACLD;;;;;AAKG;AACH;;;;AAI8B;;ACV9B;;;"}