@m3e/badge 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,135 @@
+# @m3e/badge
+
+The `m3e-badge` component is a compact visual indicator used to label content. Designed according to Material Design 3 guidelines, it can display counts, presence, or semantic emphasis, and is attachable to icons, buttons, or other components. Badges support dynamic sizing, color, and shape, ensuring clarity and accessibility while maintaining a consistent, expressive appearance across surfaces.
+
+> **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/badge
+```
+
+## 💻 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/badge`, 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/badge/dist/html-custom-data.json"],
+  "css.customData": ["./node_modules/@m3e/badge/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/badge/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",
+      "@m3e/core/bidi": "/node_modules/@m3e/core/dist/bidi.js",
+      "@m3e/core/anchoring": "/node_modules/@m3e/core/dist/anchoring.js"
+    }
+  }
+</script>
+```
+
+> For production, use index.min.js, bidi.min.js, and anchoring.min.js for faster load times.
+
+## 🗂️ Elements
+
+- `m3e-badge` — A visual indicator used to label content.
+
+## 🧪 Examples
+
+The following example illustrates attaching a `m3e-badge` to another element using the `for` attribute.
+
+```html
+<m3e-button id="button">Button</m3e-button><m3e-badge for="button">10</m3e-badge>
+```
+
+## 📖 API Reference
+
+This section details the attributes, slots and CSS custom properties available for the `m3e-badge` component.
+
+### ⚙️ Attributes
+
+| Attribute  | Type                                                                                                              | Default         | Description                                                  |
+| ---------- | ----------------------------------------------------------------------------------------------------------------- | --------------- | ------------------------------------------------------------ |
+| `size`     | `"small" \| "medium" \| "large"`                                                                                  | `"medium"`      | The size of the badge.                                       |
+| `position` | `"above-after" \| "above-before" \| "below-before" \| "below-after" \| "before" \| "after" \| "above" \| "below"` | `"above-after"` | The position of the badge, when attached to another element. |
+
+### 🧩 Slots
+
+| Slot        | Description                       |
+| ----------- | --------------------------------- |
+| _(default)_ | Renders the content of the badge. |
+
+### 🎛️ CSS Custom Properties
+
+The `m3e-badge` element supports scoped CSS custom properties for shape, color, sizing, and typography across badge sizes. These tokens enable consistent theming, semantic clarity, and expressive control.
+
+#### 🧱 Global Properties
+
+| Property                      | Description                              |
+| ----------------------------- | ---------------------------------------- |
+| `--m3e-badge-shape`           | Corner radius of the badge container.    |
+| `--m3e-badge-color`           | Foreground color of badge content.       |
+| `--m3e-badge-container-color` | Background color of the badge container. |
+
+#### 🟢 Small Badge
+
+Used for minimal indicators such as presence dots or unread markers.
+
+| Property                 | Description                       |
+| ------------------------ | --------------------------------- |
+| `--m3e-badge-small-size` | Fixed dimensions for small badge. |
+
+#### 🟡 Medium Badge
+
+Used for numeric counts or short labels.
+
+| Property                         | Description                            |
+| -------------------------------- | -------------------------------------- |
+| `--m3e-badge-medium-size`        | Height and minimum width of the badge. |
+| `--m3e-badge-medium-font-size`   | Font size for badge label.             |
+| `--m3e-badge-medium-font-weight` | Font weight for badge label.           |
+| `--m3e-badge-medium-line-height` | Line height for badge label.           |
+| `--m3e-badge-medium-tracking`    | Letter spacing for badge label.        |
+
+#### 🔵 Large Badge
+
+Used for longer labels or emphasis in dense layouts.
+
+| Property                        | Description                            |
+| ------------------------------- | -------------------------------------- |
+| `--m3e-badge-large-size`        | Height and minimum width of the badge. |
+| `--m3e-badge-large-font-size`   | Font size for badge label.             |
+| `--m3e-badge-large-font-weight` | Font weight for badge label.           |
+| `--m3e-badge-large-line-height` | Line height for badge label.           |
+| `--m3e-badge-large-tracking`    | Letter spacing for badge label.        |
+
+## 🤝 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>Badge for M3E</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="description" content="Badge 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/anchoring": "../../core/dist/anchoring.min.js",
+          "@m3e/core/bidi": "../../core/dist/bidi.min.js"
+        }
+      }
+    </script>
+    <script type="module" src="../../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-badge size="small">10</m3e-badge>
+      <m3e-badge size="medium">10</m3e-badge>
+      <m3e-badge size="large">10</m3e-badge>
+      <br /><br />
+      <m3e-badge>999+</m3e-badge>
+      <br /><br />
+      <m3e-button id="btn1" variant="tonal">Top Right</m3e-button>
+      <m3e-badge for="btn1">10</m3e-badge>
+      <m3e-button id="btn2" variant="tonal">Bottom Right</m3e-button>
+      <m3e-badge for="btn2" position="below-after">10</m3e-badge>
+      &nbsp;&nbsp;&nbsp;&nbsp;
+      <m3e-button id="btn3" variant="tonal">Bottom Left</m3e-button>
+      <m3e-badge for="btn3" position="below-before">10</m3e-badge>
+      <m3e-button id="btn4" variant="tonal">Top Left</m3e-button>
+      <m3e-badge for="btn4" position="above-before">10</m3e-badge>
+    </m3e-theme>
+  </body>
+</html>

package/dist/css-custom-data.json

@@ -0,0 +1,77 @@
+{
+  "$schema": "https://raw.githubusercontent.com/microsoft/vscode-css-languageservice/main/docs/customData.schema.json",
+  "version": 1.1,
+  "properties": [
+    {
+      "name": "--m3e-badge-shape",
+      "description": "Corner radius of the badge.",
+      "values": []
+    },
+    {
+      "name": "--m3e-badge-color",
+      "description": "Foreground color of badge content.",
+      "values": []
+    },
+    {
+      "name": "--m3e-badge-container-color",
+      "description": "Background color of the badge.",
+      "values": []
+    },
+    {
+      "name": "--m3e-badge-small-size",
+      "description": "Fixed dimensions for small badge. Used for minimal indicators (e.g. dot).",
+      "values": []
+    },
+    {
+      "name": "--m3e-badge-medium-size",
+      "description": "Height and min-width for medium badge.",
+      "values": []
+    },
+    {
+      "name": "--m3e-badge-medium-font-size",
+      "description": "Font size for medium badge label.",
+      "values": []
+    },
+    {
+      "name": "--m3e-badge-medium-font-weight",
+      "description": "Font weight for medium badge label.",
+      "values": []
+    },
+    {
+      "name": "--m3e-badge-medium-line-height",
+      "description": "Line height for medium badge label.",
+      "values": []
+    },
+    {
+      "name": "--m3e-badge-medium-tracking",
+      "description": "Letter spacing for medium badge label.",
+      "values": []
+    },
+    {
+      "name": "--m3e-badge-large-size",
+      "description": "Height and min-width for large badge.",
+      "values": []
+    },
+    {
+      "name": "--m3e-badge-large-font-size",
+      "description": "Font size for large badge label.",
+      "values": []
+    },
+    {
+      "name": "--m3e-badge-large-font-weight",
+      "description": "Font weight for large badge label.",
+      "values": []
+    },
+    {
+      "name": "--m3e-badge-large-line-height",
+      "description": "Line height for large badge label.",
+      "values": []
+    },
+    {
+      "name": "--m3e-badge-large-tracking",
+      "description": "Letter spacing for large badge label.",
+      "values": []
+    }
+  ],
+  "pseudoElements": []
+}

package/dist/custom-elements.json

@@ -0,0 +1,240 @@
+{
+  "schemaVersion": "1.0.0",
+  "readme": "",
+  "modules": [
+    {
+      "kind": "javascript-module",
+      "path": "src/BadgeElement.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "M3eBadgeElement",
+          "cssProperties": [
+            {
+              "description": "Corner radius of the badge.",
+              "name": "--m3e-badge-shape"
+            },
+            {
+              "description": "Foreground color of badge content.",
+              "name": "--m3e-badge-color"
+            },
+            {
+              "description": "Background color of the badge.",
+              "name": "--m3e-badge-container-color"
+            },
+            {
+              "description": "Fixed dimensions for small badge. Used for minimal indicators (e.g. dot).",
+              "name": "--m3e-badge-small-size"
+            },
+            {
+              "description": "Height and min-width for medium badge.",
+              "name": "--m3e-badge-medium-size"
+            },
+            {
+              "description": "Font size for medium badge label.",
+              "name": "--m3e-badge-medium-font-size"
+            },
+            {
+              "description": "Font weight for medium badge label.",
+              "name": "--m3e-badge-medium-font-weight"
+            },
+            {
+              "description": "Line height for medium badge label.",
+              "name": "--m3e-badge-medium-line-height"
+            },
+            {
+              "description": "Letter spacing for medium badge label.",
+              "name": "--m3e-badge-medium-tracking"
+            },
+            {
+              "description": "Height and min-width for large badge.",
+              "name": "--m3e-badge-large-size"
+            },
+            {
+              "description": "Font size for large badge label.",
+              "name": "--m3e-badge-large-font-size"
+            },
+            {
+              "description": "Font weight for large badge label.",
+              "name": "--m3e-badge-large-font-weight"
+            },
+            {
+              "description": "Line height for large badge label.",
+              "name": "--m3e-badge-large-line-height"
+            },
+            {
+              "description": "Letter spacing for large badge label.",
+              "name": "--m3e-badge-large-tracking"
+            }
+          ],
+          "slots": [
+            {
+              "description": "Renders the content of the badge.",
+              "name": ""
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "#directionalitySubscription",
+              "privacy": "private",
+              "type": {
+                "text": "() => void | undefined"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "#anchorCleanup",
+              "privacy": "private",
+              "type": {
+                "text": "() => void | undefined"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "size",
+              "type": {
+                "text": "BadgeSize"
+              },
+              "default": "\"medium\"",
+              "description": "The size of the badge.",
+              "attribute": "size",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "position",
+              "type": {
+                "text": "BadgePosition"
+              },
+              "default": "\"above-after\"",
+              "description": "The position of the badge, when attached to another element.",
+              "attribute": "position",
+              "reflects": true
+            },
+            {
+              "kind": "method",
+              "name": "detach",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "#detach",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "#attach",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "Promise<void>"
+                }
+              }
+            }
+          ],
+          "attributes": [
+            {
+              "description": "The size of the badge.",
+              "name": "size",
+              "type": {
+                "text": "BadgeSize"
+              },
+              "default": "\"medium\"",
+              "fieldName": "size"
+            },
+            {
+              "name": "position",
+              "type": {
+                "text": "BadgePosition"
+              },
+              "default": "\"above-after\"",
+              "description": "The position of the badge, when attached to another element.",
+              "fieldName": "position"
+            }
+          ],
+          "mixins": [
+            {
+              "name": "HtmlFor",
+              "package": "@m3e/core"
+            },
+            {
+              "name": "Role",
+              "package": "@m3e/core"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "m3e-badge",
+          "customElement": true,
+          "summary": "A visual indicator used to label content."
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "M3eBadgeElement",
+          "declaration": {
+            "name": "M3eBadgeElement",
+            "module": "src/BadgeElement.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "m3e-badge",
+          "declaration": {
+            "name": "M3eBadgeElement",
+            "module": "src/BadgeElement.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/BadgePosition.ts",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/BadgeSize.ts",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "\"./BadgeElement\""
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "\"./BadgeSize\""
+          }
+        }
+      ]
+    }
+  ]
+}

package/dist/html-custom-data.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json",
+  "version": 1.1,
+  "tags": [
+    {
+      "name": "m3e-badge",
+      "description": "A visual indicator used to label content.\n---\n\n\n### **Slots:**\n - _default_ - Renders the content of the badge.\n\n### **CSS Properties:**\n - **--m3e-badge-shape** - Corner radius of the badge. _(default: undefined)_\n- **--m3e-badge-color** - Foreground color of badge content. _(default: undefined)_\n- **--m3e-badge-container-color** - Background color of the badge. _(default: undefined)_\n- **--m3e-badge-small-size** - Fixed dimensions for small badge. Used for minimal indicators (e.g. dot). _(default: undefined)_\n- **--m3e-badge-medium-size** - Height and min-width for medium badge. _(default: undefined)_\n- **--m3e-badge-medium-font-size** - Font size for medium badge label. _(default: undefined)_\n- **--m3e-badge-medium-font-weight** - Font weight for medium badge label. _(default: undefined)_\n- **--m3e-badge-medium-line-height** - Line height for medium badge label. _(default: undefined)_\n- **--m3e-badge-medium-tracking** - Letter spacing for medium badge label. _(default: undefined)_\n- **--m3e-badge-large-size** - Height and min-width for large badge. _(default: undefined)_\n- **--m3e-badge-large-font-size** - Font size for large badge label. _(default: undefined)_\n- **--m3e-badge-large-font-weight** - Font weight for large badge label. _(default: undefined)_\n- **--m3e-badge-large-line-height** - Line height for large badge label. _(default: undefined)_\n- **--m3e-badge-large-tracking** - Letter spacing for large badge label. _(default: undefined)_",
+      "attributes": [
+        {
+          "name": "size",
+          "description": "The size of the badge.",
+          "values": [{ "name": "BadgeSize" }]
+        },
+        {
+          "name": "position",
+          "description": "The position of the badge, when attached to another element.",
+          "values": [{ "name": "BadgePosition" }]
+        }
+      ],
+      "references": []
+    }
+  ]
+}