@watermarkinsights/ripple 5.13.0 → 5.13.1-alpha.0

package/dist/collection/components/wm-modal-pss/wm-modal-pss.js

@@ -0,0 +1,369 @@
+import { h, Host } from "@stencil/core";
+import { checkForActiveElInShadow } from "../../global/functions";
+import { generateId } from "../../global/functions";
+export class ModalPss {
+    constructor() {
+        this.open = false;
+        this.elementToFocus = ""; // primary and secondary point to the corresponding buttons, otherwise focus based on element id
+        this.modalType = "modal";
+        this.bodyFocusListener = () => this.redirectFocusFromBody();
+    }
+    get focusOnOpenEl() {
+        let customElementToFocus = null;
+        if (this.elementToFocus === "primary" || this.elementToFocus === "secondary") {
+            customElementToFocus = this.el.querySelector(`#wm-${this.elementToFocus}-${this.uid}`);
+        }
+        else if (this.elementToFocus) {
+            customElementToFocus = this.el.querySelector("#" + this.elementToFocus);
+            !customElementToFocus &&
+                console.warn("Ripple Component Library: The modal component couldn't find an element matching the id you passed for 'elementToFocus'. It will fall back to the default and focus the close button when the modal opens.");
+        }
+        const closeButtonEl = this.el.querySelector(`#wm-modal-close-${this.uid}`);
+        return customElementToFocus ? customElementToFocus : closeButtonEl;
+    }
+    //App can open modal by toggling the prop
+    toggleModal() {
+        this.open ? this.showModal() : this.hideModal();
+    }
+    //The below not implemented in light of the fact that the app does often need to keep track of the modal's state itself so that it can update the data displayed in the body:
+    //App can also open modal by emitting wmShowModal event. Event needs to include the modal's unique id as the event detail, or else all modals on the page will open when wmShowModal event is dispatched.
+    // @Listen("wmShowModal", { target: "window" })
+    // doesEventMatchId(ev: CustomEvent) {
+    //   ev.detail === this.uid && this.showModal();
+    // }
+    handleClick(ev) {
+        this.open && ev.target === this.overlayEl && this.focusOnOpenEl.focus();
+    }
+    closeModalOnEscape(ev) {
+        if (ev.key === "Escape") {
+            // stops propagation prevents nested modal from closing all at once
+            ev.stopPropagation();
+            this.wmModalCloseTriggered.emit();
+            this.open = false;
+        }
+    }
+    showModal() {
+        this.setAriaDescribedbyOnModal();
+        this.setElToFocusOnClose(); //Record where the user was before the modal opened so that focus can return to it when the modal closes
+        document.body.style.overflow = "hidden"; //Keeps the page below the modal from scrolling
+        //Focus listeners as a general catch for keeping focus in case of errors in finding element with id passed in by dev (element is removed from DOM, etc.) or other scenarios
+        document.body.tabIndex = 0;
+        document.body.removeEventListener("focus", this.bodyFocusListener, true);
+        document.body.addEventListener("focus", this.bodyFocusListener, true);
+        window.requestAnimationFrame(() => {
+            // nested requestAnimationFrames allow all elements to become visible on page before assigning focus
+            window.requestAnimationFrame(() => this.focusOnOpenEl.focus()); //Bring focus to element inside modal
+        });
+    }
+    //Close the modal and focus the triggering element when the modal buttons emit their events
+    hideModal() {
+        document.body.style.overflow = "visible";
+        document.body.tabIndex = -1;
+        document.body.removeEventListener("focus", this.bodyFocusListener, true);
+        window.requestAnimationFrame(() => this.focusOnCloseEl.focus()); //Return focus
+    }
+    componentWillLoad() {
+        if (this.elementToFocus === "primary" || this.elementToFocus === "secondary") {
+            if (!this.el.id) {
+                console.error("You are telling the modal to focus an element in the footer when it opens. That's fine! But when you do that, you also need to give the wm-modal-wrapper an ID and set the ID of the modal body to 'content-[id of wm-modal-wrapper]. This is for accessibility purposes.");
+            }
+        }
+        this.el.focus = () => {
+            this.focusOnOpenEl.focus();
+        };
+        this.uid = this.el.id ? this.el.id : generateId();
+    }
+    componentDidLoad() {
+        if (this.open) {
+            this.showModal();
+        }
+    }
+    async emitCloseEvent() {
+        this.wmModalCloseTriggered.emit();
+    }
+    async emitPrimaryEvent() {
+        this.wmModalPrimaryTriggered.emit();
+    }
+    async emitSecondaryEvent() {
+        this.wmModalSecondaryTriggered.emit();
+    }
+    setAriaDescribedbyOnModal() {
+        const modalBody = document.getElementById(`content-${this.uid}`);
+        if (!modalBody) {
+            console.warn("Ripple Component Library: The element containing the body of the modal must include an id in the format 'content-[id of modal]' for accessibility purposes.");
+        }
+        else {
+            this.el.setAttribute("aria-describedby", `wm-modal-heading-text-${this.uid} content-${this.uid}`);
+        }
+    }
+    setElToFocusOnClose() {
+        const elToFocus = document.activeElement;
+        if (elToFocus.tagName === "WM-MENUITEM") {
+            this.focusOnCloseEl = elToFocus.parentElement;
+        }
+        else {
+            this.focusOnCloseEl = checkForActiveElInShadow(elToFocus);
+        }
+    }
+    redirectFocusFromBody() {
+        if (document.activeElement.tagName === "BODY") {
+            this.focusOnOpenEl.focus();
+        }
+    }
+    render() {
+        return (h(Host, { key: '01cbfca5fef86d2177b2156d39ddc94616fc745e', class: `${this.open ? "" : "hide "}${"wm-" + this.modalType}`, role: "dialog", "aria-describedby": `wm-modal-heading-text-${this.uid}`, "aria-modal": "true", tabindex: this.open ? 0 : null, onFocus: () => {
+                this.focusLastElement.emit();
+            } }, h("div", { key: '61d3b91a5bc6f68c0358d1d23fa2a45a059a1cf7', class: "overlay", ref: (el) => (this.overlayEl = el) }), h("div", { key: 'ba39c5a0733ea1e6367299a71aecf73d5a07b0da', class: "sr-only", tabIndex: 0, onFocus: () => {
+                this.focusFirstElement.emit();
+            } })));
+    }
+    static get is() { return "wm-modal-pss"; }
+    static get originalStyleUrls() {
+        return {
+            "$": ["wm-modal-pss.scss"]
+        };
+    }
+    static get styleUrls() {
+        return {
+            "$": ["wm-modal-pss.css"]
+        };
+    }
+    static get properties() {
+        return {
+            "open": {
+                "type": "boolean",
+                "attribute": "open",
+                "mutable": true,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": true,
+                "defaultValue": "false"
+            },
+            "elementToFocus": {
+                "type": "string",
+                "attribute": "element-to-focus",
+                "mutable": true,
+                "complexType": {
+                    "original": "\"primary\" | \"secondary\" | string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false,
+                "defaultValue": "\"\""
+            },
+            "modalType": {
+                "type": "string",
+                "attribute": "modal-type",
+                "mutable": false,
+                "complexType": {
+                    "original": "\"modal\" | \"dialog\"",
+                    "resolved": "\"dialog\" | \"modal\"",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": true,
+                "defaultValue": "\"modal\""
+            },
+            "uid": {
+                "type": "string",
+                "attribute": "uid",
+                "mutable": true,
+                "complexType": {
+                    "original": "string",
+                    "resolved": "string",
+                    "references": {}
+                },
+                "required": true,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": true
+            }
+        };
+    }
+    static get events() {
+        return [{
+                "method": "focusLastElement",
+                "name": "focusLastElement",
+                "bubbles": false,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "complexType": {
+                    "original": "any",
+                    "resolved": "any",
+                    "references": {}
+                }
+            }, {
+                "method": "focusFirstElement",
+                "name": "focusFirstElement",
+                "bubbles": false,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "complexType": {
+                    "original": "any",
+                    "resolved": "any",
+                    "references": {}
+                }
+            }, {
+                "method": "wmModalCloseTriggered",
+                "name": "wmModalCloseTriggered",
+                "bubbles": false,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "complexType": {
+                    "original": "any",
+                    "resolved": "any",
+                    "references": {}
+                }
+            }, {
+                "method": "wmModalPrimaryTriggered",
+                "name": "wmModalPrimaryTriggered",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "complexType": {
+                    "original": "any",
+                    "resolved": "any",
+                    "references": {}
+                }
+            }, {
+                "method": "wmModalSecondaryTriggered",
+                "name": "wmModalSecondaryTriggered",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "complexType": {
+                    "original": "any",
+                    "resolved": "any",
+                    "references": {}
+                }
+            }];
+    }
+    static get methods() {
+        return {
+            "emitCloseEvent": {
+                "complexType": {
+                    "signature": "() => Promise<void>",
+                    "parameters": [],
+                    "references": {
+                        "Promise": {
+                            "location": "global",
+                            "id": "global::Promise"
+                        }
+                    },
+                    "return": "Promise<void>"
+                },
+                "docs": {
+                    "text": "",
+                    "tags": []
+                }
+            },
+            "emitPrimaryEvent": {
+                "complexType": {
+                    "signature": "() => Promise<void>",
+                    "parameters": [],
+                    "references": {
+                        "Promise": {
+                            "location": "global",
+                            "id": "global::Promise"
+                        }
+                    },
+                    "return": "Promise<void>"
+                },
+                "docs": {
+                    "text": "",
+                    "tags": []
+                }
+            },
+            "emitSecondaryEvent": {
+                "complexType": {
+                    "signature": "() => Promise<void>",
+                    "parameters": [],
+                    "references": {
+                        "Promise": {
+                            "location": "global",
+                            "id": "global::Promise"
+                        }
+                    },
+                    "return": "Promise<void>"
+                },
+                "docs": {
+                    "text": "",
+                    "tags": []
+                }
+            }
+        };
+    }
+    static get elementRef() { return "el"; }
+    static get watchers() {
+        return [{
+                "propName": "open",
+                "methodName": "toggleModal"
+            }];
+    }
+    static get listeners() {
+        return [{
+                "name": "click",
+                "method": "handleClick",
+                "target": undefined,
+                "capture": false,
+                "passive": false
+            }, {
+                "name": "keydown",
+                "method": "closeModalOnEscape",
+                "target": undefined,
+                "capture": false,
+                "passive": false
+            }];
+    }
+}