@m3e/progress-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/NOTICE.md

@@ -0,0 +1,8 @@
+# NOTICE
+
+This package includes code adapted from third-party sources under the MIT license:
+
+- Angular Material Progress Bar & Spinner
+  Source: https://github.com/angular/components  
+  License: MIT  
+  Copyright (c) Google LLC

package/README.md

@@ -0,0 +1,132 @@
+# @m3e/progress-indicator
+
+The `m3e-linear-progress-indicator` and `m3e-circular-progress-indicator` components provide accessible, animated progress indicators for tracking the completion of tasks or processes. Both components support multiple modes and are fully customizable via CSS custom properties.
+
+> **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/progress-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/progress-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/progress-indicator/dist/html-custom-data.json"],
+  "css.customData": ["./node_modules/@m3e/progress-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/progress-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-linear-progress-indicator` — A horizontal bar for indicating progress and activity.
+- `m3e-circular-progress-indicator` — A circular indicator of progress and activity.
+
+## 🧪 Example
+
+The following example illustrates determinate progress indicators.
+
+```html
+<m3e-linear-progress-indicator value="30"></m3e-linear-progress-indicator>
+<m3e-circular-progress-indicator value="30"></m3e-circular-progress-indicator>
+```
+
+The next example illustrates indeterminate progress indicators.
+
+```html
+<m3e-linear-progress-indicator mode="indeterminate"></m3e-linear-progress-indicator>
+<m3e-circular-progress-indicator indeterminate></m3e-circular-progress-indicator>
+```
+
+## 📖 API Reference
+
+### 🗂️ m3e-linear-progress-indicator
+
+This section details the attributes and CSS custom properties available for the `m3e-linear-progress-indicator` component.
+
+#### ⚙️ Attributes
+
+| Attribute    | Type                                                      | Default         | Description                                                          |
+| ------------ | --------------------------------------------------------- | --------------- | -------------------------------------------------------------------- |
+| buffer-value | `number`                                                  | `0`             | A fractional value, between 0 and `max`, indicating buffer progress. |
+| max          | `number`                                                  | `100`           | The maximum progress value.                                          |
+| mode         | `"determinate" \| "indeterminate" \| "buffer" \| "query"` | `"determinate"` | The mode of the progress bar.                                        |
+| value        | `number`                                                  | `0`             | A fractional value, between 0 and `max`, indicating progress.        |
+
+#### 🎛️ CSS Custom Properties
+
+| Property                                    | Description                                          |
+| ------------------------------------------- | ---------------------------------------------------- |
+| `--m3e-linear-progress-indicator-thickness` | Thickness (height) of the progress bar.              |
+| `--m3e-linear-progress-indicator-shape`     | Border radius of the progress bar.                   |
+| `--m3e-progress-indicator-track-color`      | Track color of the progress bar (background/buffer). |
+| `--m3e-progress-indicator-color`            | Color of the progress indicator (foreground).        |
+
+### 🗂️ m3e-circular-progress-indicator
+
+This section details the attributes, slots, and CSS custom properties available for the `m3e-circular-progress-indicator` component.
+
+#### ⚙️ Attributes
+
+| Attribute     | Type      | Default | Description                                                        |
+| ------------- | --------- | ------- | ------------------------------------------------------------------ |
+| diameter      | `number`  | `40`    | The diameter, in pixels, of the progress spinner.                  |
+| indeterminate | `boolean` | `false` | Whether to show something is happening without conveying progress. |
+| max           | `number`  | `100`   | The maximum progress value.                                        |
+| stroke-width  | `number`  | `10`    | The stroke width, in pixels, of the progress spinner.              |
+| value         | `number`  | `0`     | A fractional value, between 0 and `max`, indicating progress.      |
+
+#### 🧩 Slots
+
+| Slot        | Description                                        |
+| ----------- | -------------------------------------------------- |
+| _(default)_ | Renders the content inside the progress indicator. |
+
+#### 🎛️ CSS Custom Properties
+
+| Property                               | Description                                          |
+| -------------------------------------- | ---------------------------------------------------- |
+| `--m3e-progress-indicator-track-color` | Track color of the progress bar (background/buffer). |
+| `--m3e-progress-indicator-color`       | Color of the progress indicator (foreground).        |
+
+## 🤝 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,53 @@
+<!doctype html>
+<html lang="en" style="overflow-y: auto">
+  <head>
+    <title>Progress Indicator for M3E</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="description" content="Progress 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-linear-progress-indicator value="20"></m3e-linear-progress-indicator>
+      <br />
+      <m3e-linear-progress-indicator mode="indeterminate"></m3e-linear-progress-indicator>
+      <br />
+      <m3e-linear-progress-indicator mode="query"></m3e-linear-progress-indicator>
+      <br />
+      <m3e-linear-progress-indicator mode="buffer" value="30"></m3e-linear-progress-indicator>
+      <br />
+      <m3e-circular-progress-indicator value="20"></m3e-circular-progress-indicator>
+      <br />
+      <m3e-circular-progress-indicator indeterminate></m3e-circular-progress-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-progress-indicator-track-color",
+      "description": "Track color of the progress bar (background/buffer).",
+      "values": []
+    },
+    {
+      "name": "--m3e-progress-indicator-color",
+      "description": "Color of the progress indicator (foreground).",
+      "values": []
+    },
+    {
+      "name": "--m3e-linear-progress-indicator-thickness",
+      "description": "Thickness (height) of the progress bar.",
+      "values": []
+    },
+    {
+      "name": "--m3e-linear-progress-indicator-shape",
+      "description": "Border radius of the progress bar.",
+      "values": []
+    },
+    {
+      "name": "--m3e-progress-indicator-track-color",
+      "description": "Track color of the progress bar (background/buffer).",
+      "values": []
+    },
+    {
+      "name": "--m3e-progress-indicator-color",
+      "description": "Color of the progress indicator (foreground).",
+      "values": []
+    }
+  ],
+  "pseudoElements": []
+}