@six-group/ui-library 4.0.4 → 4.1.0

package/dist/collection/components/six-alert/six-alert.js

@@ -1,4 +1,5 @@
 import { h } from "@stencil/core";
+import { getSlot } from "../../utils/slot";
 const toastStack = Object.assign(document.createElement('div'), { className: 'six-toast-stack' });
 /**
  * @since 1.0
@@ -15,356 +16,400 @@ const toastStack = Object.assign(document.createElement('div'), { className: 'si
  * @part close-button - The close button.
  */
 export class SixAlert {
-  constructor() {
-    this.handleCloseClick = () => {
-      this.hide();
-    };
-    this.handleMouseMove = () => {
-      this.restartAutoHide();
-    };
-    this.handleTransitionEnd = (event) => {
-      const target = event.target;
-      // Ensure we only emit one event when the target element is no longer visible
-      if (event.propertyName === 'opacity' && target.classList.contains('alert')) {
-        this.isVisible = this.open;
-        this.open ? this.sixAfterShow.emit() : this.sixAfterHide.emit();
-      }
-    };
-    this.isVisible = false;
-    this.open = false;
-    this.closable = false;
-    this.type = 'primary';
-    this.duration = Infinity;
-  }
-  handleOpenChange() {
-    this.open ? this.show() : this.hide();
-  }
-  handleDurationChange() {
-    this.restartAutoHide();
-  }
-  componentWillLoad() {
-    // Show on init if open
-    if (this.open) {
-      this.show();
-    }
-  }
-  /** Shows the alert. */
-  async show() {
-    // Prevent subsequent calls to the method, whether manually or triggered by the `open` watcher
-    if (this.isVisible) {
-      return;
-    }
-    const sixShow = this.sixShow.emit();
-    if (sixShow.defaultPrevented) {
-      this.open = false;
-      return;
+    constructor() {
+        this.handleCloseClick = () => {
+            this.hide();
+        };
+        this.handleMouseEnter = () => {
+            this.pauseAutoHide();
+        };
+        this.handleMouseLeave = () => {
+            this.resetAutoHide();
+        };
+        this.handleTransitionEnd = (event) => {
+            const target = event.target;
+            // Ensure we only emit one event when the target element is no longer visible
+            if (event.propertyName === 'opacity' && target.classList.contains('alert')) {
+                this.isVisible = this.open;
+                this.open ? this.sixAfterShow.emit() : this.sixAfterHide.emit();
+            }
+        };
+        this.isVisible = false;
+        this.open = false;
+        this.closable = false;
+        this.type = 'primary';
+        this.duration = Infinity;
     }
-    this.isVisible = true;
-    this.open = true;
-    if (this.duration < Infinity) {
-      this.autoHideTimeout = window.setTimeout(() => this.hide(), this.duration);
+    handleOpenChange() {
+        this.open ? this.show() : this.hide();
     }
-  }
-  /** Hides the alert */
-  async hide() {
-    // Prevent subsequent calls to the method, whether manually or triggered by the `open` watcher
-    if (!this.isVisible) {
-      return;
+    handleDurationChange() {
+        this.restartAutoHide();
     }
-    const sixHide = this.sixHide.emit();
-    if (sixHide.defaultPrevented) {
-      this.open = true;
-      return;
+    componentWillLoad() {
+        // Show on init if open
+        if (this.open) {
+            this.show();
+        }
     }
-    clearTimeout(this.autoHideTimeout);
-    this.isVisible = false;
-    this.open = false;
-  }
-  /**
-   * Displays the alert as a toast notification. This will move the alert out of its position in the DOM and, when
-   * dismissed, it will be removed from the DOM completely. By storing a reference to the alert, you can reuse it by
-   * calling this method again. The returned promise will resolve after the alert is hidden.
-   */
-  async toast() {
-    return new Promise((resolve) => {
-      if (!toastStack.parentElement) {
-        document.body.append(toastStack);
-      }
-      toastStack.append(this.host);
-      requestAnimationFrame(() => this.show());
-      this.host.addEventListener('six-alert-after-hide', () => {
-        this.host.remove();
-        resolve();
-        // Remove the toast stack from the DOM when there are no more alerts
-        if (toastStack.querySelector('six-alert') === null) {
-          toastStack.remove();
+    /** Shows the alert. */
+    async show() {
+        // Prevent subsequent calls to the method, whether manually or triggered by the `open` watcher
+        if (this.isVisible) {
+            return;
+        }
+        const sixShow = this.sixShow.emit();
+        if (sixShow.defaultPrevented) {
+            this.open = false;
+            return;
+        }
+        this.isVisible = true;
+        this.open = true;
+        if (this.duration < Infinity) {
+            this.autoHideTimeout = window.setTimeout(() => this.hide(), this.duration);
         }
-      }, { once: true });
-    });
-  }
-  restartAutoHide() {
-    clearTimeout(this.autoHideTimeout);
-    if (this.open && this.duration < Infinity) {
-      this.autoHideTimeout = window.setTimeout(() => this.hide(), this.duration);
     }
-  }
-  render() {
-    return (h("div", { part: "base", class: {
-        alert: true,
-        'alert--open': this.open,
-        'alert--visible': this.isVisible,
-        'alert--closable': this.closable,
-        'alert--primary': this.type === 'primary',
-        'alert--success': this.type === 'success',
-        'alert--info': this.type === 'info',
-        'alert--warning': this.type === 'warning',
-        'alert--danger': this.type === 'danger',
-      }, role: "alert", "aria-live": "assertive", "aria-atomic": "true", "aria-hidden": this.open ? 'false' : 'true', onMouseMove: this.handleMouseMove, onTransitionEnd: this.handleTransitionEnd }, h("span", { part: "icon", class: "alert__icon" }, h("slot", { name: "icon" })), h("span", { part: "message", class: "alert__message" }, h("slot", null)), this.closable && (h("span", { class: "alert__close" }, h("six-icon-button", { name: "clear", exportparts: "base:close-button", onClick: this.handleCloseClick })))));
-  }
-  static get is() { return "six-alert"; }
-  static get encapsulation() { return "shadow"; }
-  static get originalStyleUrls() {
-    return {
-      "$": ["six-alert.scss"]
-    };
-  }
-  static get styleUrls() {
-    return {
-      "$": ["six-alert.css"]
-    };
-  }
-  static get properties() {
-    return {
-      "open": {
-        "type": "boolean",
-        "mutable": true,
-        "complexType": {
-          "original": "boolean",
-          "resolved": "boolean",
-          "references": {}
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [],
-          "text": "Indicates whether or not the alert is open. You can use this in lieu of the show/hide methods."
-        },
-        "attribute": "open",
-        "reflect": true,
-        "defaultValue": "false"
-      },
-      "closable": {
-        "type": "boolean",
-        "mutable": false,
-        "complexType": {
-          "original": "boolean",
-          "resolved": "boolean",
-          "references": {}
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [],
-          "text": "Set to true to make the alert closable."
-        },
-        "attribute": "closable",
-        "reflect": true,
-        "defaultValue": "false"
-      },
-      "type": {
-        "type": "string",
-        "mutable": false,
-        "complexType": {
-          "original": "'primary' | 'success' | 'info' | 'warning' | 'danger'",
-          "resolved": "\"danger\" | \"info\" | \"primary\" | \"success\" | \"warning\"",
-          "references": {}
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [],
-          "text": "The type of alert."
-        },
-        "attribute": "type",
-        "reflect": true,
-        "defaultValue": "'primary'"
-      },
-      "duration": {
-        "type": "number",
-        "mutable": false,
-        "complexType": {
-          "original": "number",
-          "resolved": "number",
-          "references": {}
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [],
-          "text": "The length of time, in milliseconds, the alert will show before closing itself. If the user interacts with the\nalert before it closes (e.g. moves the mouse over it), the timer will restart."
-        },
-        "attribute": "duration",
-        "reflect": false,
-        "defaultValue": "Infinity"
-      }
-    };
-  }
-  static get states() {
-    return {
-      "isVisible": {}
-    };
-  }
-  static get events() {
-    return [{
-        "method": "sixShow",
-        "name": "six-alert-show",
-        "bubbles": true,
-        "cancelable": true,
-        "composed": true,
-        "docs": {
-          "tags": [],
-          "text": "Emitted when the alert opens. Calling `event.preventDefault()` will prevent it from being opened."
-        },
-        "complexType": {
-          "original": "EmptyPayload",
-          "resolved": "undefined",
-          "references": {
-            "EmptyPayload": {
-              "location": "import",
-              "path": "../../utils/types",
-              "id": "src/utils/types.ts::EmptyPayload"
-            }
-          }
+    /** Hides the alert */
+    async hide() {
+        // Prevent subsequent calls to the method, whether manually or triggered by the `open` watcher
+        if (!this.isVisible) {
+            return;
         }
-      }, {
-        "method": "sixAfterShow",
-        "name": "six-alert-after-show",
-        "bubbles": true,
-        "cancelable": true,
-        "composed": true,
-        "docs": {
-          "tags": [],
-          "text": "Emitted after the alert opens and all transitions are complete."
-        },
-        "complexType": {
-          "original": "EmptyPayload",
-          "resolved": "undefined",
-          "references": {
-            "EmptyPayload": {
-              "location": "import",
-              "path": "../../utils/types",
-              "id": "src/utils/types.ts::EmptyPayload"
-            }
-          }
+        const sixHide = this.sixHide.emit();
+        if (sixHide.defaultPrevented) {
+            this.open = true;
+            return;
         }
-      }, {
-        "method": "sixHide",
-        "name": "six-alert-hide",
-        "bubbles": true,
-        "cancelable": true,
-        "composed": true,
-        "docs": {
-          "tags": [],
-          "text": "Emitted when the alert closes. Calling `event.preventDefault()` will prevent it from being closed."
-        },
-        "complexType": {
-          "original": "EmptyPayload",
-          "resolved": "undefined",
-          "references": {
-            "EmptyPayload": {
-              "location": "import",
-              "path": "../../utils/types",
-              "id": "src/utils/types.ts::EmptyPayload"
+        clearTimeout(this.autoHideTimeout);
+        this.isVisible = false;
+        this.open = false;
+    }
+    /**
+     * Displays the alert as a toast notification. This will move the alert out of its position in the DOM and, when
+     * dismissed, it will be removed from the DOM completely. By storing a reference to the alert, you can reuse it by
+     * calling this method again. The returned promise will resolve after the alert is hidden.
+     * @param adjustPosition  If true, the top and right position of the toast stack is shifted according to the
+     *                        six-root header's height and the presence of a vertical scrollbar.
+     */
+    async toast(adjustPosition = true) {
+        return new Promise((resolve) => {
+            var _a;
+            if (!toastStack.parentElement) {
+                document.body.append(toastStack);
             }
-          }
-        }
-      }, {
-        "method": "sixAfterHide",
-        "name": "six-alert-after-hide",
-        "bubbles": true,
-        "cancelable": true,
-        "composed": true,
-        "docs": {
-          "tags": [],
-          "text": "Emitted after the alert closes and all transitions are complete."
-        },
-        "complexType": {
-          "original": "EmptyPayload",
-          "resolved": "undefined",
-          "references": {
-            "EmptyPayload": {
-              "location": "import",
-              "path": "../../utils/types",
-              "id": "src/utils/types.ts::EmptyPayload"
+            toastStack.append(this.host);
+            if (adjustPosition) {
+                const sixRoot = document.querySelector('six-root');
+                const headerSlot = getSlot(sixRoot, 'header');
+                const mainSlot = (_a = sixRoot === null || sixRoot === void 0 ? void 0 : sixRoot.shadowRoot) === null || _a === void 0 ? void 0 : _a.querySelector('host main');
+                if (mainSlot != null && mainSlot instanceof HTMLElement) {
+                    const scrollbarWidth = mainSlot.offsetWidth - mainSlot.clientWidth;
+                    toastStack.style.right = `${scrollbarWidth}px`;
+                }
+                if (headerSlot != null) {
+                    const rect = headerSlot === null || headerSlot === void 0 ? void 0 : headerSlot.getBoundingClientRect();
+                    toastStack.style.top = `${rect.top + rect.height}px`;
+                }
             }
-          }
-        }
-      }];
-  }
-  static get methods() {
-    return {
-      "show": {
-        "complexType": {
-          "signature": "() => Promise<void>",
-          "parameters": [],
-          "references": {
-            "Promise": {
-              "location": "global",
-              "id": "global::Promise"
+            else {
+                toastStack.style.top = '0';
+                toastStack.style.right = '0';
             }
-          },
-          "return": "Promise<void>"
-        },
-        "docs": {
-          "text": "Shows the alert.",
-          "tags": []
+            requestAnimationFrame(() => this.show());
+            this.host.addEventListener('six-alert-after-hide', () => {
+                this.host.remove();
+                resolve();
+                // Remove the toast stack from the DOM when there are no more alerts
+                if (toastStack.querySelector('six-alert') === null) {
+                    toastStack.remove();
+                }
+            }, { once: true });
+        });
+    }
+    pauseAutoHide() {
+        clearTimeout(this.autoHideTimeout);
+    }
+    resetAutoHide() {
+        if (this.open && this.duration < Infinity) {
+            this.autoHideTimeout = window.setTimeout(() => this.hide(), this.duration);
         }
-      },
-      "hide": {
-        "complexType": {
-          "signature": "() => Promise<void>",
-          "parameters": [],
-          "references": {
-            "Promise": {
-              "location": "global",
-              "id": "global::Promise"
+    }
+    restartAutoHide() {
+        this.pauseAutoHide();
+        this.resetAutoHide();
+    }
+    render() {
+        const asToast = this.host.closest('.six-toast-stack') != null;
+        return (h("div", { part: "base", class: {
+                alert: true,
+                'alert--open': this.open,
+                'alert--visible': this.isVisible,
+                'alert--closable': this.closable,
+                'alert--primary': this.type === 'primary',
+                'alert--success': this.type === 'success',
+                'alert--info': this.type === 'info',
+                'alert--warning': this.type === 'warning',
+                'alert--danger': this.type === 'danger',
+                'alert--shadow': asToast,
+            }, role: "alert", "aria-live": "assertive", "aria-atomic": "true", "aria-hidden": this.open ? 'false' : 'true', onTransitionEnd: this.handleTransitionEnd, onMouseEnter: this.handleMouseEnter, onMouseLeave: this.handleMouseLeave }, h("span", { part: "icon", class: "alert__icon" }, h("slot", { name: "icon" })), h("span", { part: "message", class: "alert__message" }, h("slot", null)), this.closable && (h("span", { class: "alert__close" }, h("six-icon-button", { name: "clear", exportparts: "base:close-button", onClick: this.handleCloseClick })))));
+    }
+    static get is() { return "six-alert"; }
+    static get encapsulation() { return "shadow"; }
+    static get originalStyleUrls() {
+        return {
+            "$": ["six-alert.scss"]
+        };
+    }
+    static get styleUrls() {
+        return {
+            "$": ["six-alert.css"]
+        };
+    }
+    static get properties() {
+        return {
+            "open": {
+                "type": "boolean",
+                "mutable": true,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Indicates whether or not the alert is open. You can use this in lieu of the show/hide methods."
+                },
+                "attribute": "open",
+                "reflect": true,
+                "defaultValue": "false"
+            },
+            "closable": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Set to true to make the alert closable."
+                },
+                "attribute": "closable",
+                "reflect": true,
+                "defaultValue": "false"
+            },
+            "type": {
+                "type": "string",
+                "mutable": false,
+                "complexType": {
+                    "original": "AlertType",
+                    "resolved": "\"danger\" | \"info\" | \"primary\" | \"success\" | \"warning\"",
+                    "references": {
+                        "AlertType": {
+                            "location": "local",
+                            "path": "/home/runner/work/six-webcomponents/six-webcomponents/libraries/ui-library/src/components/six-alert/six-alert.tsx",
+                            "id": "src/components/six-alert/six-alert.tsx::AlertType"
+                        }
+                    }
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "The type of alert."
+                },
+                "attribute": "type",
+                "reflect": true,
+                "defaultValue": "'primary'"
+            },
+            "duration": {
+                "type": "number",
+                "mutable": false,
+                "complexType": {
+                    "original": "number",
+                    "resolved": "number",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "The length of time, in milliseconds, the alert will show before closing itself.\nIf the user hovers over the toast alert, the timer will pause.\nOn leaving the element with the mouse, the timer resets."
+                },
+                "attribute": "duration",
+                "reflect": false,
+                "defaultValue": "Infinity"
             }
-          },
-          "return": "Promise<void>"
-        },
-        "docs": {
-          "text": "Hides the alert",
-          "tags": []
-        }
-      },
-      "toast": {
-        "complexType": {
-          "signature": "() => Promise<void>",
-          "parameters": [],
-          "references": {
-            "Promise": {
-              "location": "global",
-              "id": "global::Promise"
+        };
+    }
+    static get states() {
+        return {
+            "isVisible": {}
+        };
+    }
+    static get events() {
+        return [{
+                "method": "sixShow",
+                "name": "six-alert-show",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": "Emitted when the alert opens. Calling `event.preventDefault()` will prevent it from being opened."
+                },
+                "complexType": {
+                    "original": "EmptyPayload",
+                    "resolved": "undefined",
+                    "references": {
+                        "EmptyPayload": {
+                            "location": "import",
+                            "path": "../../utils/types",
+                            "id": "src/utils/types.ts::EmptyPayload"
+                        }
+                    }
+                }
+            }, {
+                "method": "sixAfterShow",
+                "name": "six-alert-after-show",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": "Emitted after the alert opens and all transitions are complete."
+                },
+                "complexType": {
+                    "original": "EmptyPayload",
+                    "resolved": "undefined",
+                    "references": {
+                        "EmptyPayload": {
+                            "location": "import",
+                            "path": "../../utils/types",
+                            "id": "src/utils/types.ts::EmptyPayload"
+                        }
+                    }
+                }
+            }, {
+                "method": "sixHide",
+                "name": "six-alert-hide",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": "Emitted when the alert closes. Calling `event.preventDefault()` will prevent it from being closed."
+                },
+                "complexType": {
+                    "original": "EmptyPayload",
+                    "resolved": "undefined",
+                    "references": {
+                        "EmptyPayload": {
+                            "location": "import",
+                            "path": "../../utils/types",
+                            "id": "src/utils/types.ts::EmptyPayload"
+                        }
+                    }
+                }
+            }, {
+                "method": "sixAfterHide",
+                "name": "six-alert-after-hide",
+                "bubbles": true,
+                "cancelable": true,
+                "composed": true,
+                "docs": {
+                    "tags": [],
+                    "text": "Emitted after the alert closes and all transitions are complete."
+                },
+                "complexType": {
+                    "original": "EmptyPayload",
+                    "resolved": "undefined",
+                    "references": {
+                        "EmptyPayload": {
+                            "location": "import",
+                            "path": "../../utils/types",
+                            "id": "src/utils/types.ts::EmptyPayload"
+                        }
+                    }
+                }
+            }];
+    }
+    static get methods() {
+        return {
+            "show": {
+                "complexType": {
+                    "signature": "() => Promise<void>",
+                    "parameters": [],
+                    "references": {
+                        "Promise": {
+                            "location": "global",
+                            "id": "global::Promise"
+                        }
+                    },
+                    "return": "Promise<void>"
+                },
+                "docs": {
+                    "text": "Shows the alert.",
+                    "tags": []
+                }
+            },
+            "hide": {
+                "complexType": {
+                    "signature": "() => Promise<void>",
+                    "parameters": [],
+                    "references": {
+                        "Promise": {
+                            "location": "global",
+                            "id": "global::Promise"
+                        }
+                    },
+                    "return": "Promise<void>"
+                },
+                "docs": {
+                    "text": "Hides the alert",
+                    "tags": []
+                }
+            },
+            "toast": {
+                "complexType": {
+                    "signature": "(adjustPosition?: boolean) => Promise<void>",
+                    "parameters": [{
+                            "name": "adjustPosition",
+                            "type": "boolean",
+                            "docs": "If true, the top and right position of the toast stack is shifted according to the\nsix-root header's height and the presence of a vertical scrollbar."
+                        }],
+                    "references": {
+                        "Promise": {
+                            "location": "global",
+                            "id": "global::Promise"
+                        }
+                    },
+                    "return": "Promise<void>"
+                },
+                "docs": {
+                    "text": "Displays the alert as a toast notification. This will move the alert out of its position in the DOM and, when\ndismissed, it will be removed from the DOM completely. By storing a reference to the alert, you can reuse it by\ncalling this method again. The returned promise will resolve after the alert is hidden.",
+                    "tags": [{
+                            "name": "param",
+                            "text": "adjustPosition If true, the top and right position of the toast stack is shifted according to the\nsix-root header's height and the presence of a vertical scrollbar."
+                        }]
+                }
             }
-          },
-          "return": "Promise<void>"
-        },
-        "docs": {
-          "text": "Displays the alert as a toast notification. This will move the alert out of its position in the DOM and, when\ndismissed, it will be removed from the DOM completely. By storing a reference to the alert, you can reuse it by\ncalling this method again. The returned promise will resolve after the alert is hidden.",
-          "tags": []
-        }
-      }
-    };
-  }
-  static get elementRef() { return "host"; }
-  static get watchers() {
-    return [{
-        "propName": "open",
-        "methodName": "handleOpenChange"
-      }, {
-        "propName": "duration",
-        "methodName": "handleDurationChange"
-      }];
-  }
+        };
+    }
+    static get elementRef() { return "host"; }
+    static get watchers() {
+        return [{
+                "propName": "open",
+                "methodName": "handleOpenChange"
+            }, {
+                "propName": "duration",
+                "methodName": "handleDurationChange"
+            }];
+    }
 }
 //# sourceMappingURL=six-alert.js.map