@m3e/snackbar 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,139 @@
+# @m3e/snackbar
+
+The `@m3e/snackbar` package provides the `M3eSnackbar` global service on `window` (`globalThis`) used to present short updates about application processes at the bottom of the screen from anywhere in an application.
+
+> **Part of the [M3E](../../README.md) monorepo**  
+> This package is maintained within the unified M3E repository, which provides a suite of Material 3 web components.
+
+## 📦 Installation
+
+```bash
+npm install @m3e/snackbar
+```
+
+## 💻 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/snackbar`, 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/snackbar/dist/html-custom-data.json"],
+  "css.customData": ["./node_modules/@m3e/snackbar/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/snackbar/dist/index.js"></script>
+```
+
+You also need a module script for `@m3e/button` and `@m3e/icon-button` due to being a dependency.
+
+```html
+<script type="module" src="/node_modules/@m3e/button/dist/index.js"></script>
+<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"
+    }
+  }
+</script>
+```
+
+> For production, use index.min.js for faster load times.
+
+## 🧪 Examples
+
+The following example illustrates basic usage.
+
+```js
+M3eSnackbar.open("File deleted");
+```
+
+The next example illustrates presenting a snackbar with an action and callback.
+
+```js
+M3eSnackbar.open("File deleted", "Undo", {
+  actionCallback: () => {
+    // Undo logic here
+  },
+});
+```
+
+## 📖 API Reference
+
+### 🛠️ Snackbar Service
+
+This section details the methods available for the `M3eSnackbar` service.
+
+#### ⚙️ Methods
+
+| Method    | Signature                                                                                      | Description                                                                                                                                                                                                                                                                                                           |
+| --------- | ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `open`    | `open(message: string, options?: SnackbarOptions): void`                                       | Opens a snackbar with a message.<br>- `message`: The message to show in the snackbar.<br>- `options`: (optional) Options that control the behavior of the snackbar.                                                                                                                                                   |
+| `open`    | `open(message: string, action: string, options?: SnackbarOptions): void`                       | Opens a snackbar with a message and action.<br>- `message`: The message to show in the snackbar.<br>- `action`: The label for the snackbar action.<br>- `options`: (optional) Options that control the behavior of the snackbar.                                                                                      |
+| `open`    | `open(message: string, action: string, dismissible: boolean, options?: SnackbarOptions): void` | Opens a snackbar with a message, action, and optional close affordance.<br>- `message`: The message to show in the snackbar.<br>- `action`: The label for the snackbar action.<br>- `dismissible`: Whether to present close affordance.<br>- `options`: (optional) Options that control the behavior of the snackbar. |
+| `open`    | `open(message: string, dismissible: boolean, options?: SnackbarOptions): void`                 | Opens a snackbar with a message and optional close affordance.<br>- `message`: The message to show in the snackbar.<br>- `dismissible`: Whether to present close affordance.<br>- `options`: (optional) Options that control the behavior of the snackbar.                                                            |
+| `dismiss` | `dismiss(): void`                                                                              | Dismisses the currently visible snackbar.                                                                                                                                                                                                                                                                             |
+
+### 🗂️ Snackbar
+
+This section details the attributes, slots and CSS custom properties available for the `m3e-snackbar` component.
+
+#### ⚙️ Attributes
+
+| Attribute     | Type      | Default   | Description                                                                                |
+| ------------- | --------- | --------- | ------------------------------------------------------------------------------------------ |
+| `action`      | `string`  |           | The label of the snackbar's action.                                                        |
+| `close-label` | `string`  | `"Close"` | The accessible label given to the button used to dismiss the snackbar.                     |
+| `dismissible` | `boolean` | `false`   | Whether a button is presented that can be used to close the snackbar.                      |
+| `duration`    | `number`  | `3000`    | The length of time, in milliseconds, to wait before automatically dismissing the snackbar. |
+
+#### 🧩 Slots
+
+| Slot         | Description                            |
+| ------------ | -------------------------------------- |
+| _(default)_  | Renders the content of the snackbar.   |
+| `close-icon` | Renders the icon for the close button. |
+
+#### 🎛️ CSS Custom Properties
+
+| Property                                     | Description                                  |
+| -------------------------------------------- | -------------------------------------------- |
+| `--m3e-snackbar-margin`                      | Vertical offset from the bottom of viewport. |
+| `--m3e-snackbar-container-shape`             | Border radius of the snackbar container.     |
+| `--m3e-snackbar-container-color`             | Background color of the snackbar.            |
+| `--m3e-snackbar-padding`                     | Internal spacing of the snackbar container.  |
+| `--m3e-snackbar-min-width`                   | Minimum width of the snackbar.               |
+| `--m3e-snackbar-max-width`                   | Maximum width of the snackbar.               |
+| `--m3e-snackbar-supporting-text-font-size`   | Font size for supporting text.               |
+| `--m3e-snackbar-supporting-text-font-weight` | Font weight for supporting text.             |
+| `--m3e-snackbar-supporting-text-line-height` | Line height for supporting text.             |
+| `--m3e-snackbar-supporting-text-tracking`    | Letter spacing for supporting text.          |
+| `--m3e-snackbar-supporting-text-color`       | Color of supporting text.                    |
+| `--m3e-snackbar-action-text-color`           | Color of the action button text.             |
+| `--m3e-snackbar-close-icon-color`            | Color of the close icon.                     |
+
+## 🤝 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,49 @@
+<!doctype html>
+<html lang="en" style="overflow-y: auto">
+  <head>
+    <title>Snackbar for M3E</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="description" content="Snackbar 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"
+        }
+      }
+    </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="../../theme/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
+        onclick="M3eSnackbar.open('Test', 'Custom Action', true, { duration: 5000, actionCallback: () => console.log('Action Taken')})"
+      >
+        Open Snackbar
+      </m3e-button>
+    </m3e-theme>
+  </body>
+</html>

package/dist/css-custom-data.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://raw.githubusercontent.com/microsoft/vscode-css-languageservice/main/docs/customData.schema.json",
+  "version": 1.1,
+  "properties": [
+    {
+      "name": "--m3e-snackbar-margin",
+      "description": "Vertical offset from the bottom of the viewport.",
+      "values": []
+    },
+    {
+      "name": "--m3e-snackbar-container-shape",
+      "description": "Border radius of the snackbar container.",
+      "values": []
+    },
+    {
+      "name": "--m3e-snackbar-container-color",
+      "description": "Background color of the snackbar.",
+      "values": []
+    },
+    {
+      "name": "--m3e-snackbar-padding",
+      "description": "Internal spacing of the snackbar container.",
+      "values": []
+    },
+    {
+      "name": "--m3e-snackbar-min-width",
+      "description": "Minimum width of the snackbar.",
+      "values": []
+    },
+    {
+      "name": "--m3e-snackbar-max-width",
+      "description": "Maximum width of the snackbar.",
+      "values": []
+    }
+  ],
+  "pseudoElements": []
+}