@m3e/heading 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,109 @@
+# @m3e/heading
+
+The `m3e-heading` component provides expressive, accessible headings for pages and sections, supporting display, headline, title, and label variants in multiple sizes. It applies Material 3 typographic tokens for font size, weight, line height, and letter spacing, ensuring visual hierarchy and clarity.
+
+> **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/heading
+```
+
+## 💻 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/heading`, 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/heading/dist/html-custom-data.json"],
+  "css.customData": ["./node_modules/@m3e/heading/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/heading/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-heading` — A heading to a page or section.
+
+## 🧪 Examples
+
+The following example illustrates use of the `m3e-heading` to present each variant and size.
+
+```html
+<m3e-heading variant="display" size="large">Display Large</m3e-heading>
+<m3e-heading variant="display" size="medium">Display Medium</m3e-heading>
+<m3e-heading variant="display" size="small">Display Small</m3e-heading>
+<m3e-heading variant="headline" size="large">Headline Large</m3e-heading>
+<m3e-heading variant="headline" size="medium">Headline Medium</m3e-heading>
+<m3e-heading variant="headline" size="small">Headline Small</m3e-heading>
+<m3e-heading variant="title" size="large">Title Large</m3e-heading>
+<m3e-heading variant="title" size="medium">Title Medium</m3e-heading>
+<m3e-heading variant="title" size="small">Title Small</m3e-heading>
+<m3e-heading variant="label" size="large">Label Large</m3e-heading>
+<m3e-heading variant="label" size="medium">Label Medium</m3e-heading>
+<m3e-heading variant="label" size="small">Label Small</m3e-heading>
+```
+
+The next example illustrates use of the `level` attribute to designate the accessibility level of a heading.
+When specified, ARIA `role="heading"` is applied and the `level` is propagated to `aria-level`.
+
+```html
+<m3e-heading variant="headline" size="large" level="1">Page title</m3e-heading>
+```
+
+## 📖 API Reference
+
+This section details the attributes and slots available for the `m3e-heading` component.
+
+### ⚙️ Attributes
+
+| Attribute    | Type                                                  | Default     | Description                                       |
+| ------------ | ----------------------------------------------------- | ----------- | ------------------------------------------------- |
+| `emphasized` | `boolean`                                             | `false`     | Whether the heading uses an emphasized typescale. |
+| `variant`    | `"display"` \| `"headline"` \| `"title"` \| `"label"` | `"display"` | The appearance variant of the heading.            |
+| `size`       | `"small"` \| `"medium"` \| `"large"`                  | "medium"    | The size of the heading.                          |
+| `level`      | `1` \| `2` \| `3` \| `4` \| `5` \| `6`                |             | The accessibility level of the heading.           |
+
+### 🧩 Slots
+
+| Slot        | Description                         |
+| ----------- | ----------------------------------- |
+| _(default)_ | Renders the content of the heading. |
+
+## 🤝 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,54 @@
+<!doctype html>
+<html lang="en" style="overflow-y: auto">
+  <head>
+    <title>Heading for M3E</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="description" content="Heading 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-heading variant="display" size="large">Display Large</m3e-heading>
+      <m3e-heading variant="display" size="medium">Display Medium</m3e-heading>
+      <m3e-heading variant="display" size="small">Display Small</m3e-heading>
+      <m3e-heading variant="headline" size="large">Headline Large</m3e-heading>
+      <m3e-heading variant="headline" size="medium">Headline Medium</m3e-heading>
+      <m3e-heading variant="headline" size="small">Headline Small</m3e-heading>
+      <m3e-heading variant="title" size="large">Title Large</m3e-heading>
+      <m3e-heading variant="title" size="medium">Title Medium</m3e-heading>
+      <m3e-heading variant="title" size="small">Title Small</m3e-heading>
+      <m3e-heading variant="label" size="large">Label Large</m3e-heading>
+      <m3e-heading variant="label" size="medium">Label Medium</m3e-heading>
+      <m3e-heading variant="label" size="small">Label Small</m3e-heading>
+    </m3e-theme>
+  </body>
+</html>

package/dist/css-custom-data.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://raw.githubusercontent.com/microsoft/vscode-css-languageservice/main/docs/customData.schema.json",
+  "version": 1.1,
+  "properties": [],
+  "pseudoElements": []
+}

package/dist/custom-elements.json

@@ -0,0 +1,194 @@
+{
+  "schemaVersion": "1.0.0",
+  "readme": "",
+  "modules": [
+    {
+      "kind": "javascript-module",
+      "path": "src/HeadingElement.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "M3eHeadingElement",
+          "slots": [
+            {
+              "description": "Renders the content of the heading.",
+              "name": ""
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "emphasized",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Whether the heading uses an emphasized typescale.",
+              "attribute": "emphasized",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "variant",
+              "type": {
+                "text": "HeadingVariant"
+              },
+              "default": "\"display\"",
+              "description": "The appearance variant of the heading.",
+              "attribute": "variant",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "size",
+              "type": {
+                "text": "HeadingSize"
+              },
+              "default": "\"medium\"",
+              "description": "The size of the heading.",
+              "attribute": "size",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "level",
+              "type": {
+                "text": "HeadingLevel | undefined"
+              },
+              "description": "The accessibility level of the heading.",
+              "default": "undefined",
+              "attribute": "level"
+            }
+          ],
+          "attributes": [
+            {
+              "description": "Whether the heading uses an emphasized typescale.",
+              "name": "emphasized",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "fieldName": "emphasized"
+            },
+            {
+              "description": "The accessibility level of the heading.",
+              "name": "level",
+              "type": {
+                "text": "HeadingLevel | undefined"
+              },
+              "default": "undefined",
+              "fieldName": "level"
+            },
+            {
+              "description": "The size of the heading.",
+              "name": "size",
+              "type": {
+                "text": "HeadingSize"
+              },
+              "default": "\"medium\"",
+              "fieldName": "size"
+            },
+            {
+              "description": "The appearance variant of the heading.",
+              "name": "variant",
+              "type": {
+                "text": "HeadingVariant"
+              },
+              "default": "\"display\"",
+              "fieldName": "variant"
+            }
+          ],
+          "mixins": [
+            {
+              "name": "Role",
+              "package": "@m3e/core"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "m3e-heading",
+          "customElement": true,
+          "summary": "A heading to a page or section."
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "M3eHeadingElement",
+          "declaration": {
+            "name": "M3eHeadingElement",
+            "module": "src/HeadingElement.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "m3e-heading",
+          "declaration": {
+            "name": "M3eHeadingElement",
+            "module": "src/HeadingElement.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/HeadingLevel.ts",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/HeadingSize.ts",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/HeadingVariant.ts",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "\"./HeadingElement\""
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "\"./HeadingLevel\""
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "\"./HeadingSize\""
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "\"./HeadingVariant\""
+          }
+        }
+      ]
+    }
+  ]
+}

package/dist/html-custom-data.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json",
+  "version": 1.1,
+  "tags": [
+    {
+      "name": "m3e-heading",
+      "description": "A heading to a page or section.\n---\n\n\n### **Slots:**\n - _default_ - Renders the content of the heading.",
+      "attributes": [
+        {
+          "name": "emphasized",
+          "description": "Whether the heading uses an emphasized typescale.",
+          "values": []
+        },
+        {
+          "name": "level",
+          "description": "The accessibility level of the heading.",
+          "values": [{ "name": "HeadingLevel" }]
+        },
+        {
+          "name": "size",
+          "description": "The size of the heading.",
+          "values": [{ "name": "HeadingSize" }]
+        },
+        {
+          "name": "variant",
+          "description": "The appearance variant of the heading.",
+          "values": [{ "name": "HeadingVariant" }]
+        }
+      ],
+      "references": []
+    }
+  ]
+}