@m3e/shape 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,100 @@
+# @m3e/shape
+
+The `m3e-shape` component allows you to use abstract shapes thoughtfully to add emphasis and decorative flair, including built-in shape morphing.
+
+All shapes are sourced from the Material Shape library: `4-leaf-clover`, `4-sided-cookie`, `6-sided-cookie`, `7-sided-cookie`, `8-leaf-clover`, `9-sided-cookie`, `12-sided-cookie`, `arch`, `arrow`, `boom`, `bun`, `burst`, `circle`, `diamond`, `fan`, `flower`, `gem`, `ghost-ish`, `heart`, `hexagon`, `oval`, `pentagon`, `pill`, `pixel-circle`, `pixel-triangle`, `puffy`, `puffy-diamond`, `semicircle`, `slanted`, `soft-boom`, `soft-burst`, `square`, `sunny`, `triangle`, and `very-sunny`.
+
+Refer to the Material Shape library for visual references and details.
+
+> **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/shape
+```
+
+## 💻 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/shape`, 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/shape/dist/html-custom-data.json"],
+  "css.customData": ["./node_modules/@m3e/shape/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/shape/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-shape` — A shape used to add emphasis and decorative flair.
+
+## 🧪 Examples
+
+The following example illustrates using the `m3e-shape` component to present the `sunny` shape.
+
+```html
+<m3e-shape name="sunny"></m3e-shape>
+```
+
+## 📖 API Reference
+
+This section details the attributes, slots and CSS custom properties available for the `m3e-shape` component.
+
+### ⚙️ Attributes
+
+| Attribute | Type                | Default | Description            |
+| --------- | ------------------- | ------- | ---------------------- |
+| `name`    | `ShapeName \| null` | `null`  | The name of the shape. |
+
+### 🧩 Slots
+
+| Slot        | Description                               |
+| ----------- | ----------------------------------------- |
+| _(default)_ | Renders the clipped content of the shape. |
+
+### 🎛️ CSS Custom Properties
+
+| Property                      | Description                                |
+| ----------------------------- | ------------------------------------------ |
+| `--m3e-shape-size`            | Default size of the shape.                 |
+| `--m3e-shape-container-color` | Container (background) color of the shape. |
+| `--m3e-shape-transition`      | Transition used to morph between shapes.   |
+
+## 🤝 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,100 @@
+<!doctype html>
+<html lang="en" style="overflow-y: auto">
+  <head>
+    <title>Shape for M3E</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="description" content="Shape 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-shape name="12-sided-cookie"></m3e-shape>
+      <m3e-shape name="9-sided-cookie"></m3e-shape>
+      <m3e-shape name="8-leaf-clover"></m3e-shape>
+      <m3e-shape name="7-sided-cookie"></m3e-shape>
+      <m3e-shape name="6-sided-cookie"></m3e-shape>
+      <m3e-shape name="4-sided-cookie"></m3e-shape>
+      <m3e-shape name="4-leaf-clover"></m3e-shape>
+      <br />
+      <m3e-shape name="arch"></m3e-shape>
+      <m3e-shape name="arrow"></m3e-shape>
+      <m3e-shape name="boom"></m3e-shape>
+      <m3e-shape name="bun"></m3e-shape>
+      <m3e-shape name="diamond"></m3e-shape>
+      <m3e-shape name="fan"></m3e-shape>
+      <m3e-shape name="flower"></m3e-shape>
+      <br />
+      <m3e-shape name="gem"></m3e-shape>
+      <m3e-shape name="ghost-ish"></m3e-shape>
+      <m3e-shape name="heart"></m3e-shape>
+      <m3e-shape name="hexagon"></m3e-shape>
+      <m3e-shape name="pentagon"></m3e-shape>
+      <m3e-shape name="pill"></m3e-shape>
+      <m3e-shape name="pixel-circle"></m3e-shape>
+      <br />
+      <m3e-shape name="pixel-triangle"></m3e-shape>
+      <m3e-shape name="puffy"></m3e-shape>
+      <m3e-shape name="puffy-diamond"></m3e-shape>
+      <m3e-shape name="semicircle"></m3e-shape>
+      <m3e-shape name="slanted"></m3e-shape>
+      <m3e-shape name="soft-boom"></m3e-shape>
+      <m3e-shape name="soft-burst"></m3e-shape>
+      <br />
+      <m3e-shape name="square"></m3e-shape>
+      <m3e-shape name="circle"></m3e-shape>
+      <m3e-shape name="triangle"></m3e-shape>
+      <br /><br />
+
+      <m3e-shape name="sunny" style="width: 300px">
+        <img src="https://www.shutterstock.com/shutterstock/videos/1006393/thumb/1.jpg?ip=x480" />
+      </m3e-shape>
+      <br /><br />
+      <m3e-shape name="sunny" style="width: 300px; --m3e-shape-container-color: transparent">
+        <video
+          autoplay
+          loop
+          poster="https://www.shutterstock.com/shutterstock/videos/1006393/thumb/1.jpg?ip=x480"
+          preload="auto"
+        >
+          <source
+            src="https://www.shutterstock.com/shutterstock/videos/1006393/preview/stock-footage-business-people-working-in-office.webm"
+            type="video/webm"
+          />
+          <source
+            src="https://www.shutterstock.com/shutterstock/videos/1006393/preview/stock-footage-business-people-working-in-office.mp4"
+            type="video/mp4"
+          />
+        </video>
+      </m3e-shape>
+    </m3e-theme>
+  </body>
+</html>

package/dist/css-custom-data.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://raw.githubusercontent.com/microsoft/vscode-css-languageservice/main/docs/customData.schema.json",
+  "version": 1.1,
+  "properties": [
+    {
+      "name": "--m3e-shape-size",
+      "description": "Default size of the shape.",
+      "values": []
+    },
+    {
+      "name": "--m3e-shape-container-color",
+      "description": "Container (background) color of the shape.",
+      "values": []
+    },
+    {
+      "name": "--m3e-shape-transition",
+      "description": "Transition used to morph between shapes.",
+      "values": []
+    }
+  ],
+  "pseudoElements": []
+}

package/dist/custom-elements.json

@@ -0,0 +1,145 @@
+{
+  "schemaVersion": "1.0.0",
+  "readme": "",
+  "modules": [
+    {
+      "kind": "javascript-module",
+      "path": "src/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "\"./ShapeElement\""
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "\"./ShapeName\""
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/ShapeElement.ts",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "",
+          "name": "M3eShapeElement",
+          "cssProperties": [
+            {
+              "description": "Default size of the shape.",
+              "name": "--m3e-shape-size"
+            },
+            {
+              "description": "Container (background) color of the shape.",
+              "name": "--m3e-shape-container-color"
+            },
+            {
+              "description": "Transition used to morph between shapes.",
+              "name": "--m3e-shape-transition"
+            }
+          ],
+          "slots": [
+            {
+              "description": "Renders the clipped content of the shape.",
+              "name": ""
+            }
+          ],
+          "members": [
+            {
+              "kind": "field",
+              "name": "name",
+              "type": {
+                "text": "ShapeName | null"
+              },
+              "default": "null",
+              "description": "The name of the shape.",
+              "attribute": "name",
+              "reflects": true
+            }
+          ],
+          "attributes": [
+            {
+              "description": "The name of the shape.",
+              "name": "name",
+              "type": {
+                "text": "ShapeName | null"
+              },
+              "default": "null",
+              "fieldName": "name"
+            }
+          ],
+          "mixins": [
+            {
+              "name": "Role",
+              "package": "@m3e/core"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "m3e-shape",
+          "customElement": true,
+          "summary": "A shape used to add emphasis and decorative flair."
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "M3eShapeElement",
+          "declaration": {
+            "name": "M3eShapeElement",
+            "module": "src/ShapeElement.ts"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "m3e-shape",
+          "declaration": {
+            "name": "M3eShapeElement",
+            "module": "src/ShapeElement.ts"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/ShapeName.ts",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/ShapeNameStyle.ts",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/ShapePolygon.ts",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/ShapeStyle.ts",
+      "declarations": [],
+      "exports": []
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/ShapeToken.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-shape",
+      "description": "A shape used to add emphasis and decorative flair.\n---\n\n\n### **Slots:**\n - _default_ - Renders the clipped content of the shape.\n\n### **CSS Properties:**\n - **--m3e-shape-size** - Default size of the shape. _(default: undefined)_\n- **--m3e-shape-container-color** - Container (background) color of the shape. _(default: undefined)_\n- **--m3e-shape-transition** - Transition used to morph between shapes. _(default: undefined)_",
+      "attributes": [
+        {
+          "name": "name",
+          "description": "The name of the shape.",
+          "values": [{ "name": "ShapeName" }]
+        }
+      ],
+      "references": []
+    }
+  ]
+}