@tmorrow/cre8-wc 1.2.4 → 1.2.6

package/lib/components/modal/modal.d.ts

@@ -0,0 +1,99 @@
+import { PropertyValues } from 'lit';
+import { Cre8Element } from '../cre8-element';
+import '../icon/icon.js';
+import '@a11y/focus-trap';
+/**
+ * Modal component should be used in all modal situations.
+ * It is natuarally composable and can even have a custom header and remove the close button.
+ * (note: adding `slot="header"` will insert the given element into the header section of the modal,
+ * same for `slot="footer"` and no given slot name will inset it into the body)
+ *
+ * If it is desired to create a utility modal. Cre8Modal requires a status value (see props table below,
+ * and a UtilityModalTitle since all utility modals have a cre8-heading)
+ * @slot - The component content
+ */
+export declare class Cre8Modal extends Cre8Element {
+    static styles: import("lit").CSSResult[];
+    /**
+     * Query the modal window
+     */
+    _modalWindow: HTMLDivElement;
+    /**
+     * Is Active attribute
+     */
+    isActive?: boolean;
+    /**
+     * Status Types
+     * <cre8-text-passage size="sm">
+     * <ul>
+     * <li>**default (no value)** renders a default modal</li>
+     * <li>**error** renders an error modal</li>
+     * <li>**warning** renders a warning modal</li>
+     * <li>**success** renders a success modal</li>
+     * <li>**info** renders an info modal</li>
+     * <li>**help** renders an help modal</li>
+     * </ul>
+     * </cre8-text-passage>
+     */
+    status?: 'error' | 'warning' | 'success' | 'info' | 'help';
+    /**
+     * Utility Modal Heading (String)
+     */
+    utilityModalTitle: string;
+    /**
+     * Not dismissible modal
+     */
+    notDismissible?: boolean;
+    /**
+     * Close Button Text
+     */
+    closeButtonText: string;
+    /**
+     * Close Button Icon
+     */
+    closeButtonIcon: string;
+    /**
+     * Modal Aria Label - This is required for accessibility and provides context of the entire modal!
+     */
+    ariaLabel: string;
+    /**
+     * Handle keydown
+     * 1) Close the modal when escape is hit when the user is focused within the modal
+     */
+    handleKeydown(e: KeyboardEvent): void;
+    /**
+     * Handle on close
+     * 1) On close, set the modal to not active and dispatch event telling the parent the modal was closed.
+     */
+    handleCloseModal(): void;
+    /**
+     * Handle "click outside"
+     * 1) onClick of the area around the modal window, close the modal.
+     */
+    handleOnClickOutside(e: Event): void;
+    /**
+     * Lifecycle method to focus on modal
+     * 1) If there is a changed property, and this.isActive === true, then focus on the modal window.
+     * 2) Disable the body from scrolling behind while the modal is open.
+     */
+    updated(changedProperties: PropertyValues<this>): void;
+    mapStatusToIconModal: (status: string) => import("lit-html").TemplateResult<1>;
+    /**
+     * Lifecycle method on removal from the DOM
+     * Removed body overflow and handle close (isActive set to false)
+     */
+    disconnectedCallback(): void;
+    render(): import("lit-html").TemplateResult<1>;
+}
+export interface CloseModalEvent extends CustomEvent<{
+    isActive: boolean;
+}> {
+    type: 'close-modal';
+    currentTarget: Cre8Modal;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'cre8-modal': Cre8Modal;
+    }
+}
+//# sourceMappingURL=modal.d.ts.map

package/lib/components/modal/modal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modal.d.ts","sourceRoot":"","sources":["../../../components/modal/modal.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAS,MAAM,KAAK,CAAC;AAQ5C,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,iBAAiB,CAAC;AACzB,OAAO,kBAAkB,CAAC;AAG1B;;;;;;;;;GASG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACtC,MAAM,CAAC,MAAM,4BAAY;IAEzB;;OAEG;IAEH,YAAY,EAAE,cAAc,CAAC;IAE7B;;OAEG;IAEH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;;;;;;;;OAYG;IAEH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;IAE3D;;OAEG;IAEH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IAEH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IAEH,eAAe,EAAE,MAAM,CAAW;IAElC;;OAEG;IAEH,eAAe,EAAE,MAAM,CAAW;IAElC;;OAEG;IAEH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,aAAa,CAAC,CAAC,EAAE,aAAa;IAM9B;;;OAGG;IACH,gBAAgB;IAUhB;;;OAGG;IAEH,oBAAoB,CAAC,CAAC,EAAE,KAAK;IAO7B;;;;OAIG;IAEH,OAAO,CAAC,iBAAiB,EAAE,cAAc,CAAC,IAAI,CAAC;IAsB/C,oBAAoB,GAAI,QAAQ,MAAM,0CAepC;IAEF;;;OAGG;IACH,oBAAoB;IAMpB,MAAM;CAyCT;AAMD,MAAM,WAAW,eAAgB,SAAQ,WAAW,CAAC;IAAE,QAAQ,EAAE,OAAO,CAAA;CAAE,CAAC;IACvE,IAAI,EAAE,aAAa,CAAC;IACpB,aAAa,EAAE,SAAS,CAAC;CAC5B;AAED,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,qBAAqB;QAC3B,YAAY,EAAE,SAAS,CAAC;KAC3B;CACJ"}