@m3e/dialog 1.0.0-rc.1

package/dist/custom-elements.json

@@ -0,0 +1,639 @@
+{
+  "schemaVersion": "1.0.0",
+  "readme": "",
+  "modules": [
+    {
+      "kind": "javascript-module",
+      "path": "src/DialogActionElement.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "An element, nested within a clickable element, used to close a parenting dialog.",
+          "name": "M3eDialogActionElement",
+          "members": [
+            {
+              "kind": "field",
+              "name": "returnValue",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
+              "description": "The value to return from the dialog.",
+              "attribute": "return-value"
+            },
+            {
+              "kind": "field",
+              "name": "#clickHandler",
+              "privacy": "private",
+              "readonly": true
+            }
+          ],
+          "attributes": [
+            {
+              "description": "The value to return from the dialog.",
+              "name": "return-value",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
+              "fieldName": "returnValue"
+            }
+          ],
+          "mixins": [
+            {
+              "name": "AttachInternals",
+              "package": "@m3e/core"
+            },
+            {
+              "name": "Role",
+              "package": "@m3e/core"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "m3e-dialog-action",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "M3eDialogActionElement",
+          "declaration": {
+            "name": "M3eDialogActionElement",
+            "module": "src/DialogActionElement.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "m3e-dialog-action",
+          "declaration": {
+            "name": "M3eDialogActionElement",
+            "module": "src/DialogActionElement.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/DialogElement.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "M3eDialogElement",
+          "cssProperties": [
+            {
+              "description": "Border radius of the dialog container.",
+              "name": "--m3e-dialog-shape"
+            },
+            {
+              "description": "Minimum width of the dialog.",
+              "name": "--m3e-dialog-min-width"
+            },
+            {
+              "description": "Maximum width of the dialog.",
+              "name": "--m3e-dialog-max-width"
+            },
+            {
+              "description": "Foreground color of the dialog.",
+              "name": "--m3e-dialog-color"
+            },
+            {
+              "description": "Background color of the dialog container.",
+              "name": "--m3e-dialog-container-color"
+            },
+            {
+              "description": "Color of the scrim (backdrop overlay).",
+              "name": "--m3e-dialog-scrim-color"
+            },
+            {
+              "description": "Opacity of the scrim when open.",
+              "name": "--m3e-dialog-scrim-opacity"
+            },
+            {
+              "description": "Background color of the dialog header.",
+              "name": "--m3e-dialog-header-container-color"
+            },
+            {
+              "description": "Foreground color of the dialog header.",
+              "name": "--m3e-dialog-header-color"
+            },
+            {
+              "description": "Font size for the dialog header.",
+              "name": "--m3e-dialog-header-font-size"
+            },
+            {
+              "description": "Font weight for the dialog header.",
+              "name": "--m3e-dialog-header-font-weight"
+            },
+            {
+              "description": "Line height for the dialog header.",
+              "name": "--m3e-dialog-header-line-height"
+            },
+            {
+              "description": "Letter spacing for the dialog header.",
+              "name": "--m3e-dialog-header-tracking"
+            },
+            {
+              "description": "Foreground color of the dialog content.",
+              "name": "--m3e-dialog-content-color"
+            },
+            {
+              "description": "Font size for the dialog content.",
+              "name": "--m3e-dialog-content-font-size"
+            },
+            {
+              "description": "Font weight for the dialog content.",
+              "name": "--m3e-dialog-content-font-weight"
+            },
+            {
+              "description": "Line height for the dialog content.",
+              "name": "--m3e-dialog-content-line-height"
+            },
+            {
+              "description": "Letter spacing for the dialog content.",
+              "name": "--m3e-dialog-content-tracking"
+            }
+          ],
+          "slots": [
+            {
+              "description": "Renders the content of the dialog.",
+              "name": ""
+            },
+            {
+              "description": "Renders the header of the dialog.",
+              "name": "header"
+            },
+            {
+              "description": "Renders the icon of the button used to close the dialog.",
+              "name": "close-icon"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "__nextId",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "private",
+              "static": true,
+              "default": "0"
+            },
+            {
+              "kind": "field",
+              "name": "#id",
+              "privacy": "private",
+              "default": "M3eDialogElement.__nextId++"
+            },
+            {
+              "kind": "field",
+              "name": "#open",
+              "privacy": "private",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "#escapePressedWithoutCancel",
+              "privacy": "private",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "_hasActions",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false"
+            },
+            {
+              "kind": "field",
+              "name": "_base",
+              "type": {
+                "text": "HTMLDialogElement"
+              },
+              "privacy": "private",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "_content",
+              "type": {
+                "text": "HTMLDialogElement"
+              },
+              "privacy": "private",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "alert",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether the dialog is an alert.",
+              "attribute": "alert"
+            },
+            {
+              "kind": "field",
+              "name": "open",
+              "description": "Whether the dialog is open.",
+              "default": "false",
+              "attribute": "open",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "dismissible",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether a button is presented that can be used to close the dialog.",
+              "attribute": "dismissible"
+            },
+            {
+              "kind": "field",
+              "name": "disableClose",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether users cannot click the backdrop or press ESC to dismiss the dialog.",
+              "attribute": "disable-close"
+            },
+            {
+              "kind": "field",
+              "name": "noFocusTrap",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether to disable focus trapping, which keeps keyboard `Tab` navigation within the dialog.",
+              "attribute": "no-focus-trap"
+            },
+            {
+              "kind": "field",
+              "name": "closeLabel",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"Close\"",
+              "description": "The accessible label given to the button used to dismiss the dialog.",
+              "attribute": "close-label"
+            },
+            {
+              "kind": "field",
+              "name": "returnValue",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"\"",
+              "description": "The return value of the dialog."
+            },
+            {
+              "kind": "method",
+              "name": "show",
+              "return": {
+                "type": {
+                  "text": "Promise<void>"
+                }
+              },
+              "description": "Asynchronously opens the dialog."
+            },
+            {
+              "kind": "method",
+              "name": "hide",
+              "return": {
+                "type": {
+                  "text": "Promise<void>"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "returnValue",
+                  "default": "this.returnValue",
+                  "type": {
+                    "text": "string"
+                  },
+                  "description": "The value to return."
+                }
+              ],
+              "description": "Asynchronously closes the dialog."
+            },
+            {
+              "kind": "method",
+              "name": "#renderCloseButton",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "unknown"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "#handleClose",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "#handleCancel",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "e",
+                  "type": {
+                    "text": "Event"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "#handleClick",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "e",
+                  "type": {
+                    "text": "Event"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "#handleKeyDown",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "e",
+                  "type": {
+                    "text": "KeyboardEvent"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "#handleActionsSlotChange",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "e",
+                  "type": {
+                    "text": "Event"
+                  }
+                }
+              ]
+            }
+          ],
+          "events": [
+            {
+              "name": "opening",
+              "type": {
+                "text": "Event"
+              },
+              "description": "Emitted when the dialog begins to open."
+            },
+            {
+              "name": "opened",
+              "type": {
+                "text": "Event"
+              },
+              "description": "Emitted when the dialog has opened."
+            },
+            {
+              "name": "closing",
+              "type": {
+                "text": "Event"
+              },
+              "description": "Emitted when the dialog begins to close."
+            },
+            {
+              "name": "closed",
+              "type": {
+                "text": "Event"
+              },
+              "description": "Emitted when the dialog has closed."
+            },
+            {
+              "name": "cancel",
+              "type": {
+                "text": "Event"
+              },
+              "description": "Emitted when the dialog is cancelled."
+            }
+          ],
+          "attributes": [
+            {
+              "description": "Whether the dialog is an alert.",
+              "name": "alert",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "alert"
+            },
+            {
+              "description": "The accessible label given to the button used to dismiss the dialog.",
+              "name": "close-label",
+              "type": {
+                "text": "string"
+              },
+              "default": "\"Close\"",
+              "fieldName": "closeLabel"
+            },
+            {
+              "description": "Whether users cannot click the backdrop or press ESC to dismiss the dialog.",
+              "name": "disable-close",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "disableClose"
+            },
+            {
+              "description": "Whether a button is presented that can be used to close the dialog.",
+              "name": "dismissible",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "dismissible"
+            },
+            {
+              "description": "Whether to disable focus trapping, which keeps keyboard `Tab` navigation within the dialog.",
+              "name": "no-focus-trap",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "noFocusTrap"
+            },
+            {
+              "description": "Whether the dialog is open.",
+              "name": "open",
+              "default": "false",
+              "fieldName": "open"
+            }
+          ],
+          "mixins": [
+            {
+              "name": "EventAttribute",
+              "package": "@m3e/core"
+            },
+            {
+              "name": "Role",
+              "package": "@m3e/core"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "m3e-dialog",
+          "customElement": true,
+          "summary": "A dialog that provides important prompts in a user flow."
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "M3eDialogElement",
+          "declaration": {
+            "name": "M3eDialogElement",
+            "module": "src/DialogElement.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "m3e-dialog",
+          "declaration": {
+            "name": "M3eDialogElement",
+            "module": "src/DialogElement.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/DialogTriggerElement.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "An element, nested within a clickable element, used to open a dialog.",
+          "name": "M3eDialogTriggerElement",
+          "members": [
+            {
+              "kind": "field",
+              "name": "#clickHandler",
+              "privacy": "private"
+            }
+          ],
+          "mixins": [
+            {
+              "name": "HtmlFor",
+              "package": "@m3e/core"
+            },
+            {
+              "name": "AttachInternals",
+              "package": "@m3e/core"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "m3e-dialog-trigger",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "M3eDialogTriggerElement",
+          "declaration": {
+            "name": "M3eDialogTriggerElement",
+            "module": "src/DialogTriggerElement.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "m3e-dialog-trigger",
+          "declaration": {
+            "name": "M3eDialogTriggerElement",
+            "module": "src/DialogTriggerElement.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "\"./DialogActionElement\""
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "\"./DialogElement\""
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "\"./DialogTriggerElement\""
+          }
+        }
+      ]
+    }
+  ]
+}

package/dist/html-custom-data.json

@@ -0,0 +1,61 @@
+{
+  "$schema": "https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json",
+  "version": 1.1,
+  "tags": [
+    {
+      "name": "m3e-dialog-action",
+      "description": "An element, nested within a clickable element, used to close a parenting dialog.\n---\n",
+      "attributes": [
+        {
+          "name": "return-value",
+          "description": "The value to return from the dialog.",
+          "values": []
+        }
+      ],
+      "references": []
+    },
+    {
+      "name": "m3e-dialog",
+      "description": "A dialog that provides important prompts in a user flow.\n---\n\n\n### **Events:**\n - **opening** - Emitted when the dialog begins to open.\n- **opened** - Emitted when the dialog has opened.\n- **closing** - Emitted when the dialog begins to close.\n- **closed** - Emitted when the dialog has closed.\n- **cancel** - Emitted when the dialog is cancelled.\n\n### **Methods:**\n - **show(): _Promise<void>_** - Asynchronously opens the dialog.\n- **hide(returnValue: _string_): _Promise<void>_** - Asynchronously closes the dialog.\n\n### **Slots:**\n - _default_ - Renders the content of the dialog.\n- **header** - Renders the header of the dialog.\n- **close-icon** - Renders the icon of the button used to close the dialog.\n\n### **CSS Properties:**\n - **--m3e-dialog-shape** - Border radius of the dialog container. _(default: undefined)_\n- **--m3e-dialog-min-width** - Minimum width of the dialog. _(default: undefined)_\n- **--m3e-dialog-max-width** - Maximum width of the dialog. _(default: undefined)_\n- **--m3e-dialog-color** - Foreground color of the dialog. _(default: undefined)_\n- **--m3e-dialog-container-color** - Background color of the dialog container. _(default: undefined)_\n- **--m3e-dialog-scrim-color** - Color of the scrim (backdrop overlay). _(default: undefined)_\n- **--m3e-dialog-scrim-opacity** - Opacity of the scrim when open. _(default: undefined)_\n- **--m3e-dialog-header-container-color** - Background color of the dialog header. _(default: undefined)_\n- **--m3e-dialog-header-color** - Foreground color of the dialog header. _(default: undefined)_\n- **--m3e-dialog-header-font-size** - Font size for the dialog header. _(default: undefined)_\n- **--m3e-dialog-header-font-weight** - Font weight for the dialog header. _(default: undefined)_\n- **--m3e-dialog-header-line-height** - Line height for the dialog header. _(default: undefined)_\n- **--m3e-dialog-header-tracking** - Letter spacing for the dialog header. _(default: undefined)_\n- **--m3e-dialog-content-color** - Foreground color of the dialog content. _(default: undefined)_\n- **--m3e-dialog-content-font-size** - Font size for the dialog content. _(default: undefined)_\n- **--m3e-dialog-content-font-weight** - Font weight for the dialog content. _(default: undefined)_\n- **--m3e-dialog-content-line-height** - Line height for the dialog content. _(default: undefined)_\n- **--m3e-dialog-content-tracking** - Letter spacing for the dialog content. _(default: undefined)_",
+      "attributes": [
+        {
+          "name": "alert",
+          "description": "Whether the dialog is an alert.",
+          "values": []
+        },
+        {
+          "name": "close-label",
+          "description": "The accessible label given to the button used to dismiss the dialog.",
+          "values": []
+        },
+        {
+          "name": "disable-close",
+          "description": "Whether users cannot click the backdrop or press ESC to dismiss the dialog.",
+          "values": []
+        },
+        {
+          "name": "dismissible",
+          "description": "Whether a button is presented that can be used to close the dialog.",
+          "values": []
+        },
+        {
+          "name": "no-focus-trap",
+          "description": "Whether to disable focus trapping, which keeps keyboard `Tab` navigation within the dialog.",
+          "values": []
+        },
+        {
+          "name": "open",
+          "description": "Whether the dialog is open.",
+          "values": []
+        }
+      ],
+      "references": []
+    },
+    {
+      "name": "m3e-dialog-trigger",
+      "description": "An element, nested within a clickable element, used to open a dialog.\n---\n",
+      "attributes": [],
+      "references": []
+    }
+  ]
+}