@m3e/dialog 1.0.0-rc.1

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 matraic
+Contact: matraic@yahoo.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,143 @@
+# @m3e/dialog
+
+The `m3e-dialog` component presents important prompts, alerts, and actions in user flows. Designed according to Material 3 principles, it supports custom header, content, and close icon slots, ARIA accessibility, focus management, and theming via CSS custom properties.
+
+## 📦 Installation
+
+```bash
+npm install @m3e/dialog
+```
+
+## 💻 Editor Integration
+
+This package includes a [Custom Elements Manifest](https://github.com/webcomponents/custom-elements-manifest) to support enhanced editor tooling and developer experience.
+
+### Visual Studio Code
+
+To enable autocomplete and hover documentation for `@m3e/dialog`, install the [Custom Elements Manifest Language Server](https://marketplace.visualstudio.com/items?itemName=pwrs.cem-language-server-vscode) extension. It will automatically detect the manifest bundled with this package and surface tag names, attributes, slots, and events in supported files.
+
+Alternately, you can explicitly reference the `html-custom-data.json` and `css-custom-data.json` in your workspace settings:
+
+```json
+{
+  "html.customData": ["./node_modules/@m3e/dialog/dist/html-custom-data.json"],
+  "css.customData": ["./node_modules/@m3e/dialog/dist/css-custom-data.json"]
+}
+```
+
+## 🚀 Browser Usage
+
+This package uses [JavaScript Modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules#module_specifiers). To use it directly in a browser without a bundler, use a module script similar to the following.
+
+```html
+<script type="module" src="/node_modules/@m3e/dialog/dist/index.js"></script>
+```
+
+You also need a module script for `@m3e/icon-button` due to it being a dependency.
+
+```html
+<script type="module" src="/node_modules/@m3e/icon-button/dist/index.js"></script>
+```
+
+In addition, you must use an [import map](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/script/type/importmap) to include additional dependencies.
+
+```html
+<script type="importmap">
+  {
+    "imports": {
+      "lit": "https://cdn.jsdelivr.net/npm/lit@3.3.0/+esm",
+      "@m3e/core": "/node_modules/@m3e/core/dist/index.js",
+      "@m3e/core/a11y": "/node_modules/@m3e/core/dist/a11y.js"
+    }
+  }
+</script>
+```
+
+> For production, use index.min.js and a11y.min.js for faster load times.
+
+## 🗂️ Elements
+
+- `m3e-dialog` — A Material 3 Expressive dialog for prompts, alerts, and actions.
+- `m3e-dialog-trigger` — An element for opening dialogs by reference (via the `for` attribute).
+
+## 🧪 Examples
+
+The following example illustrates a dialog with a header, content, and actions:
+
+```html
+<m3e-button variant="filled">
+  <m3e-dialog-trigger for="dlg">Open Dialog</m3e-dialog-trigger>
+</m3e-button>
+<m3e-dialog id="dlg" dismissible onclosed="console.log(this.returnValue)">
+  <span slot="header">Dialog Title</span>
+  Dialog content goes here.
+  <div slot="actions" end>
+    <m3e-button autofocus><m3e-dialog-action return-value="ok">Close</m3e-dialog-action></m3e-button>
+  </div>
+</m3e-dialog>
+```
+
+## 📖 API Reference
+
+This section details the attributes, slots, events, and CSS custom properties available for the `m3e-dialog` component.
+
+### ⚙️ Attributes
+
+| Attribute       | Type      | Default   | Description                                                                                 |
+| --------------- | --------- | --------- | ------------------------------------------------------------------------------------------- |
+| `alert`         | `boolean` | `false`   | Whether the dialog is an alert.                                                             |
+| `close-label`   | `string`  | `"Close"` | The accessible label given to the button used to dismiss the dialog.                        |
+| `disable-close` | `boolean` | `false`   | Whether users cannot click the backdrop or press ESC to dismiss the dialog.                 |
+| `dismissible`   | `boolean` | `false`   | Whether a button is presented that can be used to close the dialog.                         |
+| `no-focus-trap` | `boolean` | `false`   | Whether to disable focus trapping, which keeps keyboard `Tab` navigation within the dialog. |
+| `open`          | `boolean` | `false`   | Whether the dialog is open.                                                                 |
+
+### 🧩 Slots
+
+| Slot         | Description                              |
+| ------------ | ---------------------------------------- |
+| _(default)_  | Renders the content of the dialog.       |
+| `header`     | Renders the header of the dialog.        |
+| `close-icon` | Renders the icon of the button to close. |
+| `actions`    | Renders action buttons for the dialog.   |
+
+### 🔔 Events
+
+| Event     | Description                              |
+| --------- | ---------------------------------------- |
+| `opening` | Emitted when the dialog begins to open.  |
+| `opened`  | Emitted when the dialog has opened.      |
+| `cancel`  | Emitted when the dialog is cancelled.    |
+| `closing` | Emitted when the dialog begins to close. |
+| `closed`  | Emitted when the dialog has closed.      |
+
+### 🎛️ CSS Custom Properties
+
+| Property                              | Description                               |
+| ------------------------------------- | ----------------------------------------- |
+| `--m3e-dialog-shape`                  | Border radius of the dialog container.    |
+| `--m3e-dialog-min-width`              | Minimum width of the dialog.              |
+| `--m3e-dialog-max-width`              | Maximum width of the dialog.              |
+| `--m3e-dialog-color`                  | Foreground color of the dialog.           |
+| `--m3e-dialog-container-color`        | Background color of the dialog container. |
+| `--m3e-dialog-scrim-color`            | Color of the scrim (backdrop overlay).    |
+| `--m3e-dialog-scrim-opacity`          | Opacity of the scrim when open.           |
+| `--m3e-dialog-header-container-color` | Background color of the dialog header.    |
+| `--m3e-dialog-header-color`           | Foreground color of the dialog header.    |
+| `--m3e-dialog-header-font-size`       | Font size for the dialog header.          |
+| `--m3e-dialog-header-font-weight`     | Font weight for the dialog header.        |
+| `--m3e-dialog-header-line-height`     | Line height for the dialog header.        |
+| `--m3e-dialog-header-tracking`        | Letter spacing for the dialog header.     |
+| `--m3e-dialog-content-color`          | Foreground color of the dialog content.   |
+| `--m3e-dialog-content-font-size`      | Font size for the dialog content.         |
+| `--m3e-dialog-content-font-weight`    | Font weight for the dialog content.       |
+| `--m3e-dialog-content-line-height`    | Line height for the dialog content.       |
+| `--m3e-dialog-content-tracking`       | Letter spacing for the dialog content.    |
+
+## 🤝 Contributing
+
+See the root monorepo `CONTRIBUTING.md` for guidelines on contributing to this package.
+
+## 📄 License
+
+This package is licensed under the MIT License.

package/cem.config.mjs

@@ -0,0 +1,16 @@
+import { customElementVsCodePlugin } from "custom-element-vs-code-integration";
+
+export default {
+  globs: ["src/**/*.ts"],
+  exclude: ["src/**/*.spec.ts"],
+  packagejson: true,
+  outdir: "dist",
+  litelement: true,
+  plugins: [
+    customElementVsCodePlugin({
+      outdir: "dist",
+      htmlFileName: "html-custom-data.json",
+      cssFileName: "css-custom-data.json",
+    }),
+  ],
+};

package/demo/index.html

@@ -0,0 +1,60 @@
+<!doctype html>
+<html lang="en" style="overflow-y: auto">
+  <head>
+    <title>Dialog for M3E</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="description" content="Dialog for M3E" />
+    <base href="./" />
+    <link rel="preconnect" href="https://fonts.googleapis.com" />
+    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
+    <link
+      href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@0,100..900;1,100..900&display=swap"
+      rel="stylesheet"
+    />
+    <link
+      href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0..1,0"
+      rel="stylesheet"
+    />
+    <script type="importmap">
+      {
+        "imports": {
+          "lit": "https://cdn.jsdelivr.net/npm/lit@3.3.0/+esm",
+          "@m3e/core": "../../core/dist/index.min.js",
+          "@m3e/core/a11y": "../../core/dist/a11y.min.js"
+        }
+      }
+    </script>
+    <script type="module" src="../../icon/dist/index.min.js"></script>
+    <script type="module" src="../../theme/dist/index.min.js"></script>
+    <script type="module" src="../../button/dist/index.min.js"></script>
+    <script type="module" src="../../icon-button/dist/index.min.js"></script>
+    <script type="module" src="../dist/index.min.js"></script>
+    <style>
+      body {
+        font-family: "Roboto";
+      }
+      *:not(:defined) {
+        display: none;
+      }
+    </style>
+  </head>
+  <body>
+    <m3e-theme strong-focus>
+      <m3e-button variant="filled">
+        <m3e-dialog-trigger for="dlg">Open Dialog</m3e-dialog-trigger>
+      </m3e-button>
+      <m3e-dialog id="dlg" dismissible onclosed="console.log(this.returnValue)">
+        <span slot="header">Lorem ipsum dolor sit amet</span>
+        Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore
+        magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+        consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
+        pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est
+        laborum.
+        <div slot="actions" end>
+          <m3e-button autofocus><m3e-dialog-action return-value="ok">Close</m3e-dialog-action></m3e-button>
+        </div>
+      </m3e-dialog>
+    </m3e-theme>
+  </body>
+</html>

package/dist/css-custom-data.json

@@ -0,0 +1,97 @@
+{
+  "$schema": "https://raw.githubusercontent.com/microsoft/vscode-css-languageservice/main/docs/customData.schema.json",
+  "version": 1.1,
+  "properties": [
+    {
+      "name": "--m3e-dialog-shape",
+      "description": "Border radius of the dialog container.",
+      "values": []
+    },
+    {
+      "name": "--m3e-dialog-min-width",
+      "description": "Minimum width of the dialog.",
+      "values": []
+    },
+    {
+      "name": "--m3e-dialog-max-width",
+      "description": "Maximum width of the dialog.",
+      "values": []
+    },
+    {
+      "name": "--m3e-dialog-color",
+      "description": "Foreground color of the dialog.",
+      "values": []
+    },
+    {
+      "name": "--m3e-dialog-container-color",
+      "description": "Background color of the dialog container.",
+      "values": []
+    },
+    {
+      "name": "--m3e-dialog-scrim-color",
+      "description": "Color of the scrim (backdrop overlay).",
+      "values": []
+    },
+    {
+      "name": "--m3e-dialog-scrim-opacity",
+      "description": "Opacity of the scrim when open.",
+      "values": []
+    },
+    {
+      "name": "--m3e-dialog-header-container-color",
+      "description": "Background color of the dialog header.",
+      "values": []
+    },
+    {
+      "name": "--m3e-dialog-header-color",
+      "description": "Foreground color of the dialog header.",
+      "values": []
+    },
+    {
+      "name": "--m3e-dialog-header-font-size",
+      "description": "Font size for the dialog header.",
+      "values": []
+    },
+    {
+      "name": "--m3e-dialog-header-font-weight",
+      "description": "Font weight for the dialog header.",
+      "values": []
+    },
+    {
+      "name": "--m3e-dialog-header-line-height",
+      "description": "Line height for the dialog header.",
+      "values": []
+    },
+    {
+      "name": "--m3e-dialog-header-tracking",
+      "description": "Letter spacing for the dialog header.",
+      "values": []
+    },
+    {
+      "name": "--m3e-dialog-content-color",
+      "description": "Foreground color of the dialog content.",
+      "values": []
+    },
+    {
+      "name": "--m3e-dialog-content-font-size",
+      "description": "Font size for the dialog content.",
+      "values": []
+    },
+    {
+      "name": "--m3e-dialog-content-font-weight",
+      "description": "Font weight for the dialog content.",
+      "values": []
+    },
+    {
+      "name": "--m3e-dialog-content-line-height",
+      "description": "Line height for the dialog content.",
+      "values": []
+    },
+    {
+      "name": "--m3e-dialog-content-tracking",
+      "description": "Letter spacing for the dialog content.",
+      "values": []
+    }
+  ],
+  "pseudoElements": []
+}