@m3e/loading-indicator 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,93 @@
+# @m3e/loading-indicator
+
+The `m3e-loading-indicator` component uses animation to grab attention, mitigate perceived latency, and indicate that an activity is in progress. Use the `variant` attribute to switch between `uncontained` (default) and `contained` appearances for contrast and context.
+
+> **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/loading-indicator
+```
+
+## 💻 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/loading-indicator`, 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/loading-indicator/dist/html-custom-data.json"],
+  "css.customData": ["./node_modules/@m3e/loading-indicator/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/loading-indicator/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 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.
+
+## 🗂️ Elements
+
+- `m3e-loading-indicator` — Shows indeterminate progress for a short wait time.
+
+## 🧪 Examples
+
+The following example illustrates an uncontained loading indicator.
+
+```html
+<m3e-loading-indicator></m3e-loading-indicator>
+```
+
+## 📖 API Reference
+
+This section details the attributes and CSS custom properties available for the `m3e-loading-indicator` component.
+
+### ⚙️ Attributes
+
+| Attribute | Type                           | Default         | Description                              |
+| --------- | ------------------------------ | --------------- | ---------------------------------------- |
+| `variant` | `"uncontained" \| "contained"` | `"uncontained"` | The appearance variant of the indicator. |
+
+### 🎛️ CSS Custom Properties
+
+| Property                                                   | Description                             |
+| ---------------------------------------------------------- | --------------------------------------- |
+| `--m3e-loading-indicator-active-indicator-color`           | Uncontained active indicator color.     |
+| `--m3e-loading-indicator-contained-active-indicator-color` | Contained active indicator color.       |
+| `--m3e-loading-indicator-contained-container-color`        | Contained container (background) color. |
+| `--m3e-loading-indicator-active-indicator-size`            | Size of the active indicator.           |
+| `--m3e-loading-indicator-container-shape`                  | Container shape.                        |
+| `--m3e-loading-indicator-container-size`                   | Container size.                         |
+
+## 🤝 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,45 @@
+<!doctype html>
+<html lang="en" style="overflow-y: auto">
+  <head>
+    <title>Loading Indicator for M3E</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="description" content="Loading Indicator 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="../../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-loading-indicator></m3e-loading-indicator>
+      <br /><br />
+      <m3e-loading-indicator variant="contained"></m3e-loading-indicator>
+    </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-loading-indicator-active-indicator-color",
+      "description": "Uncontained active indicator color.",
+      "values": []
+    },
+    {
+      "name": "--m3e-loading-indicator-contained-active-indicator-color",
+      "description": "Contained active indicator color.",
+      "values": []
+    },
+    {
+      "name": "--m3e-loading-indicator-contained-container-color",
+      "description": "Contained container (background) color.",
+      "values": []
+    },
+    {
+      "name": "--m3e-loading-indicator-active-indicator-size",
+      "description": "Size of the active indicator.",
+      "values": []
+    },
+    {
+      "name": "--m3e-loading-indicator-container-shape",
+      "description": "Container shape.",
+      "values": []
+    },
+    {
+      "name": "--m3e-loading-indicator-container-size",
+      "description": "Container size.",
+      "values": []
+    }
+  ],
+  "pseudoElements": []
+}

package/dist/custom-elements.json

@@ -0,0 +1,190 @@
+{
+  "schemaVersion": "1.0.0",
+  "readme": "",
+  "modules": [
+    {
+      "kind": "javascript-module",
+      "path": "src/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "\"./LoadingIndicatorElement\""
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "\"./LoadingIndicatorVariant\""
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/LoadingIndicatorElement.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "M3eLoadingIndicatorElement",
+          "cssProperties": [
+            {
+              "description": "Uncontained active indicator color.",
+              "name": "--m3e-loading-indicator-active-indicator-color"
+            },
+            {
+              "description": "Contained active indicator color.",
+              "name": "--m3e-loading-indicator-contained-active-indicator-color"
+            },
+            {
+              "description": "Contained container (background) color.",
+              "name": "--m3e-loading-indicator-contained-container-color"
+            },
+            {
+              "description": "Size of the active indicator.",
+              "name": "--m3e-loading-indicator-active-indicator-size"
+            },
+            {
+              "description": "Container shape.",
+              "name": "--m3e-loading-indicator-container-shape"
+            },
+            {
+              "description": "Container size.",
+              "name": "--m3e-loading-indicator-container-size"
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "_activeIndicator",
+              "type": {
+                "text": "HTMLElement | undefined"
+              },
+              "privacy": "private",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "#shapes",
+              "privacy": "private",
+              "type": {
+                "text": "Array<keyof typeof ShapePolygon>"
+              },
+              "default": "[ \"soft-burst\", \"7-sided-cookie\", \"pentagon\", \"pill\", \"very-sunny\", \"4-sided-cookie\", \"oval\", ]"
+            },
+            {
+              "kind": "field",
+              "name": "#shapeIndex",
+              "privacy": "private",
+              "type": {
+                "text": "number"
+              },
+              "default": "1"
+            },
+            {
+              "kind": "field",
+              "name": "#animationIterationHandler",
+              "privacy": "private",
+              "readonly": true
+            },
+            {
+              "kind": "field",
+              "name": "variant",
+              "type": {
+                "text": "LoadingIndicatorVariant"
+              },
+              "default": "\"uncontained\"",
+              "description": "The appearance variant of the indicator.",
+              "attribute": "variant",
+              "reflects": true
+            }
+          ],
+          "attributes": [
+            {
+              "description": "The appearance variant of the indicator.",
+              "name": "variant",
+              "type": {
+                "text": "LoadingIndicatorVariant"
+              },
+              "default": "\"uncontained\"",
+              "fieldName": "variant"
+            }
+          ],
+          "mixins": [
+            {
+              "name": "Role",
+              "package": "@m3e/core"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "m3e-loading-indicator",
+          "customElement": true,
+          "summary": "Shows indeterminate progress for a short wait time."
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "M3eLoadingIndicatorElement",
+          "declaration": {
+            "name": "M3eLoadingIndicatorElement",
+            "module": "src/LoadingIndicatorElement.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "m3e-loading-indicator",
+          "declaration": {
+            "name": "M3eLoadingIndicatorElement",
+            "module": "src/LoadingIndicatorElement.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/LoadingIndicatorToken.ts",
+      "declarations": [
+        {
+          "kind": "variable",
+          "name": "LoadingIndicatorToken",
+          "type": {
+            "text": "{\r\n  activeIndicatorSize: unsafeCSS(`var(--m3e-loading-indicator-size, 2.375rem)`),\r\n  activeIndicatorColor: unsafeCSS(`var(--m3e-loading-indicator-active-indicator-color, ${DesignToken.color.primary})`),\r\n  containedActiveIndicatorColor: unsafeCSS(\r\n    `var(--m3e-loading-indicator-contained-active-indicator-color, ${DesignToken.color.onPrimaryContainer})`\r\n  ),\r\n  containedContainerColor: unsafeCSS(\r\n    `var(--m3e-loading-indicator-contained-container-color, ${DesignToken.color.secondaryContainer})`\r\n  ),\r\n  containerShape: unsafeCSS(`var(--m3e-loading-indicator-container-shape, ${DesignToken.shape.corner.full})`),\r\n  containerSize: unsafeCSS(`var(--m3e-loading-indicator-container-size, 3rem)`),\r\n}"
+          },
+          "default": "{ activeIndicatorSize: unsafeCSS(`var(--m3e-loading-indicator-size, 2.375rem)`), activeIndicatorColor: unsafeCSS(`var(--m3e-loading-indicator-active-indicator-color, ${DesignToken.color.primary})`), containedActiveIndicatorColor: unsafeCSS( `var(--m3e-loading-indicator-contained-active-indicator-color, ${DesignToken.color.onPrimaryContainer})` ), containedContainerColor: unsafeCSS( `var(--m3e-loading-indicator-contained-container-color, ${DesignToken.color.secondaryContainer})` ), containerShape: unsafeCSS(`var(--m3e-loading-indicator-container-shape, ${DesignToken.shape.corner.full})`), containerSize: unsafeCSS(`var(--m3e-loading-indicator-container-size, 3rem)`), }"
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "LoadingIndicatorToken",
+          "declaration": {
+            "name": "LoadingIndicatorToken",
+            "module": "src/LoadingIndicatorToken.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/LoadingIndicatorVariant.ts",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/ShapePolygon.ts",
+      "declarations": [],
+      "exports": []
+    }
+  ]
+}

package/dist/html-custom-data.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json",
+  "version": 1.1,
+  "tags": [
+    {
+      "name": "m3e-loading-indicator",
+      "description": "Shows indeterminate progress for a short wait time.\n---\n\n\n### **CSS Properties:**\n - **--m3e-loading-indicator-active-indicator-color** - Uncontained active indicator color. _(default: undefined)_\n- **--m3e-loading-indicator-contained-active-indicator-color** - Contained active indicator color. _(default: undefined)_\n- **--m3e-loading-indicator-contained-container-color** - Contained container (background) color. _(default: undefined)_\n- **--m3e-loading-indicator-active-indicator-size** - Size of the active indicator. _(default: undefined)_\n- **--m3e-loading-indicator-container-shape** - Container shape. _(default: undefined)_\n- **--m3e-loading-indicator-container-size** - Container size. _(default: undefined)_",
+      "attributes": [
+        {
+          "name": "variant",
+          "description": "The appearance variant of the indicator.",
+          "values": [{ "name": "LoadingIndicatorVariant" }]
+        }
+      ],
+      "references": []
+    }
+  ]
+}