@m3e/tooltip 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,115 @@
+# @m3e/tooltip
+
+The `m3e-tooltip` component provides contextual information in response to user interaction, enhancing comprehension and reducing ambiguity. Tooltips are positioned relative to a target element and support configurable delays for show and hide behavior. Use the `for` attribute to designate the element for which to provide a tooltip.
+
+> **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/tooltip
+```
+
+## 💻 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/tooltip`, 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/tooltip/dist/html-custom-data.json"],
+  "css.customData": ["./node_modules/@m3e/tooltip/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/toolbar/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/a11y": "/node_modules/@m3e/core/dist/a11y.js",
+      "@m3e/core/anchoring": "/node_modules/@m3e/core/dist/anchoring.js",
+      "@m3e/core/platform": "/node_modules/@m3e/core/dist/platform.js"
+    }
+  }
+</script>
+```
+
+> For production, use index.min.js, a11y.min.js, anchoring.min.js, and platform.min.js for faster load times.
+
+## 🗂️ Elements
+
+- `m3e-tooltip` — Adds additional context to a button or other UI element.
+
+## 🧪 Examples
+
+The following example illustrates connecting a tooltip to a button using the `for` attribute.
+
+```html
+<m3e-icon-button id="button" aria-label="Back">
+  <m3e-icon name="arrow_back"></m3e-icon>
+</m3e-icon-button>
+<m3e-tooltip for="button">Go Back</m3e-tooltip>
+```
+
+## 📖 API Reference
+
+This section details the attributes, slots and CSS custom properties available for the `m3e-tooltip` component.
+
+### ⚙️ Attributes
+
+| Attribute    | Type      | Default | Description                                                             |
+| ------------ | --------- | ------- | ----------------------------------------------------------------------- |
+| `disabled`   | `boolean` | `false` | Whether the element is disabled.                                        |
+| `for`        | `string`  |         | The query selector used to specify the element related to this element. |
+| `hide-delay` | `number`  | `200`   | The amount of time, in milliseconds, before hiding the tooltip.         |
+| `position`   | `string`  | `"top"` | The position of the tooltip.                                            |
+| `show-delay` | `number`  | `0`     | The amount of time, in milliseconds, before showing the tooltip.        |
+
+### 🧩 Slots
+
+| Slot        | Description                         |
+| ----------- | ----------------------------------- |
+| _(default)_ | Renders the content of the tooltip. |
+
+### 🎛️ CSS Custom Properties
+
+| Property                                    | Description                                |
+| ------------------------------------------- | ------------------------------------------ |
+| `--m3e-tooltip-padding`                     | Internal spacing of the tooltip container. |
+| `--m3e-tooltip-min-width`                   | Minimum width of the tooltip.              |
+| `--m3e-tooltip-max-width`                   | Maximum width of the tooltip.              |
+| `--m3e-tooltip-min-height`                  | Minimum height of the tooltip container.   |
+| `--m3e-tooltip-max-height`                  | Maximum height of the tooltip.             |
+| `--m3e-tooltip-shape`                       | Border radius of the tooltip container.    |
+| `--m3e-tooltip-container-color`             | Background color of the tooltip.           |
+| `--m3e-tooltip-supporting-text-color`       | Text color of supporting text.             |
+| `--m3e-tooltip-supporting-text-font-size`   | Font size of supporting text.              |
+| `--m3e-tooltip-supporting-text-font-weight` | Font weight of supporting text.            |
+| `--m3e-tooltip-supporting-text-line-height` | Line height of supporting text.            |
+| `--m3e-tooltip-supporting-text-tracking`    | Letter spacing of supporting text.         |
+
+## 🤝 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,71 @@
+<!doctype html>
+<html lang="en" style="overflow-y: auto">
+  <head>
+    <title>Tooltip for M3E</title>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="description" content="Tooltip 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/a11y": "../../core/dist/a11y.min.js",
+          "@m3e/core/anchoring": "../../core/dist/anchoring.min.js",
+          "@m3e/core/platform": "../../core/dist/platform.min.js"
+        }
+      }
+    </script>
+    <script type="module" src="../../button/dist/index.min.js"></script>
+    <script type="module" src="../../icon/dist/index.min.js"></script>
+    <script type="module" src="../../icon-button/dist/index.min.js"></script>
+    <script type="module" src="../../theme/dist/index.min.js"></script>
+    <script type="module" src="../../toolbar/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-toolbar variant="vibrant" shape="rounded">
+        <m3e-icon-button id="btnBack">
+          <m3e-icon name="arrow_back"></m3e-icon>
+        </m3e-icon-button>
+        <m3e-tooltip for="btnBack">Go back</m3e-tooltip>
+        <m3e-icon-button id="btnForward">
+          <m3e-icon name="arrow_forward"></m3e-icon>
+        </m3e-icon-button>
+        <m3e-tooltip for="btnForward">Go forward</m3e-tooltip>
+        <m3e-icon-button id="btnAdd" width="wide" variant="filled">
+          <m3e-icon name="add"></m3e-icon>
+        </m3e-icon-button>
+        <m3e-tooltip for="btnAdd">Create video</m3e-tooltip>
+        <m3e-icon-button id="btnPip">
+          <m3e-icon name="picture_in_picture"></m3e-icon>
+        </m3e-icon-button>
+        <m3e-tooltip for="btnPip">Pop out video</m3e-tooltip>
+        <m3e-icon-button id="btnMore">
+          <m3e-icon name="more_vert"></m3e-icon>
+        </m3e-icon-button>
+        <m3e-tooltip for="btnMore">Show more</m3e-tooltip>
+      </m3e-toolbar>
+    </m3e-theme>
+  </body>
+</html>

package/dist/css-custom-data.json

@@ -0,0 +1,67 @@
+{
+  "$schema": "https://raw.githubusercontent.com/microsoft/vscode-css-languageservice/main/docs/customData.schema.json",
+  "version": 1.1,
+  "properties": [
+    {
+      "name": "--m3e-tooltip-padding",
+      "description": "Internal spacing of the tooltip container.",
+      "values": []
+    },
+    {
+      "name": "--m3e-tooltip-min-width",
+      "description": "Minimum width of the tooltip.",
+      "values": []
+    },
+    {
+      "name": "--m3e-tooltip-max-width",
+      "description": "Maximum width of the tooltip.",
+      "values": []
+    },
+    {
+      "name": "--m3e-tooltip-min-height",
+      "description": "Minimum height of the tooltip container.",
+      "values": []
+    },
+    {
+      "name": "--m3e-tooltip-max-height",
+      "description": "Maximum height of the tooltip.",
+      "values": []
+    },
+    {
+      "name": "--m3e-tooltip-shape",
+      "description": "Border radius of the tooltip container.",
+      "values": []
+    },
+    {
+      "name": "--m3e-tooltip-container-color",
+      "description": "Background color of the tooltip.",
+      "values": []
+    },
+    {
+      "name": "--m3e-tooltip-supporting-text-color",
+      "description": "Text color of supporting text.",
+      "values": []
+    },
+    {
+      "name": "--m3e-tooltip-supporting-text-font-size",
+      "description": "Font size of supporting text.",
+      "values": []
+    },
+    {
+      "name": "--m3e-tooltip-supporting-text-font-weight",
+      "description": "Font weight of supporting text.",
+      "values": []
+    },
+    {
+      "name": "--m3e-tooltip-supporting-text-line-height",
+      "description": "Line height of supporting text.",
+      "values": []
+    },
+    {
+      "name": "--m3e-tooltip-supporting-text-tracking",
+      "description": "Letter spacing of supporting text.",
+      "values": []
+    }
+  ],
+  "pseudoElements": []
+}