@m3e/tooltip 1.0.0-rc.2 → 1.0.0-rc.3

package/dist/custom-elements.json

@@ -1338,25 +1338,6 @@
           "kind": "mixin",
           "description": "Mixin that adds support for custom event attributes.",
           "name": "EventAttribute",
-          "members": [
-            {
-              "kind": "method",
-              "name": "dispatchEvent",
-              "return": {
-                "type": {
-                  "text": "boolean"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "event",
-                  "type": {
-                    "text": "Event"
-                  }
-                }
-              ]
-            }
-          ],
           "parameters": [
             {
               "name": "base",
@@ -1654,6 +1635,17 @@
           "description": "Mixin to augment an element with behavior used to submit a form.",
           "name": "FormSubmitter",
           "members": [
+            {
+              "kind": "field",
+              "name": "formAssociated",
+              "type": {
+                "text": "boolean"
+              },
+              "static": true,
+              "readonly": true,
+              "default": "true",
+              "description": "Indicates that this custom element participates in form submission, validation, and form state restoration."
+            },
             {
               "kind": "field",
               "name": "name",

package/dist/src/TooltipElement.d.ts

@@ -0,0 +1,103 @@
+import { CSSResultGroup, LitElement, PropertyValues } from "lit";
+import { TooltipPosition } from "./TooltipPosition";
+import { TooltipTouchGestures } from "./TooltipTouchGestures";
+declare const M3eTooltipElement_base: import("node_modules/@m3e/core/dist/src/shared/mixins/Constructor").Constructor<import("@m3e/core").HtmlForMixin> & import("node_modules/@m3e/core/dist/src/shared/mixins/Constructor").Constructor<import("@m3e/core").AttachInternalsMixin> & typeof LitElement;
+/**
+ * Adds additional context to a button or other UI element.
+ *
+ * @description
+ * 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. The component is designed to reinforce accessibility and usability, especially in dense or
+ * icon-driven interfaces. Use the `for` attribute to designate the element for which to provide a tooltip.
+ *
+ * @example
+ * 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>
+ * ```
+ *
+ * @tag m3e-tooltip
+ *
+ * @slot - Renders the content of the tooltip.
+ *
+ * @attr disabled - Whether the element is disabled.
+ * @attr for - The query selector used to specify the element related to this element.
+ * @attr hide-delay - The amount of time, in milliseconds, before hiding the tooltip.
+ * @attr position - The position of the tooltip.
+ * @attr show-delay - The amount of time, in milliseconds, before showing the tooltip.
+ *
+ * @cssprop --m3e-tooltip-padding - Internal spacing of the tooltip container.
+ * @cssprop --m3e-tooltip-min-width - Minimum width of the tooltip.
+ * @cssprop --m3e-tooltip-max-width - Maximum width of the tooltip.
+ * @cssprop --m3e-tooltip-min-height - Minimum height of the tooltip container.
+ * @cssprop --m3e-tooltip-max-height - Maximum height of the tooltip.
+ * @cssprop --m3e-tooltip-shape - Border radius of the tooltip container.
+ * @cssprop --m3e-tooltip-container-color - Background color of the tooltip.
+ * @cssprop --m3e-tooltip-supporting-text-color - Text color of supporting text.
+ * @cssprop --m3e-tooltip-supporting-text-font-size - Font size of supporting text.
+ * @cssprop --m3e-tooltip-supporting-text-font-weight - Font weight of supporting text.
+ * @cssprop --m3e-tooltip-supporting-text-line-height - Line height of supporting text.
+ * @cssprop --m3e-tooltip-supporting-text-tracking - Letter spacing of supporting text.
+ */
+export declare class M3eTooltipElement extends M3eTooltipElement_base {
+    #private;
+    /** The styles of the element. */
+    static styles: CSSResultGroup;
+    /** @private */ private static readonly __openTooltips;
+    /** @private */ private readonly _base;
+    /**
+     * Whether the element is disabled.
+     * @default false
+     */
+    disabled: boolean;
+    /**
+     * The position of the tooltip.
+     * @default "below"
+     */
+    position: TooltipPosition;
+    /**
+     * The amount of time, in milliseconds, before showing the tooltip.
+     * @default 0
+     */
+    get showDelay(): number;
+    set showDelay(value: number);
+    /**
+     * The amount of time, in milliseconds, before hiding the tooltip.
+     * @default 200
+     */
+    get hideDelay(): number;
+    set hideDelay(value: number);
+    /**
+     * The mode in which to handle touch gestures.
+     * @default "auto"
+     */
+    touchGestures: TooltipTouchGestures;
+    /** @inheritdoc */
+    attach(control: HTMLElement): void;
+    /** @inheritdoc */
+    detach(): void;
+    /** @inheritdoc */
+    connectedCallback(): void;
+    /** @inheritdoc */
+    protected update(changedProperties: PropertyValues<this>): void;
+    /** @inheritdoc */
+    protected render(): unknown;
+    /**
+     * Manually shows the tooltip.
+     * @returns {Promise<void>} A `Promise` that resolves when the tooltip is shown.
+     */
+    show(): Promise<void>;
+    /** Manually hides the tooltip. */
+    hide(): void;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        "m3e-tooltip": M3eTooltipElement;
+    }
+}
+export {};
+//# sourceMappingURL=TooltipElement.d.ts.map

package/dist/src/TooltipElement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TooltipElement.d.ts","sourceRoot":"","sources":["../../src/TooltipElement.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,cAAc,EAAQ,UAAU,EAAE,cAAc,EAAa,MAAM,KAAK,CAAC;AAgBvF,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;;AAQ9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AACH,qBACa,iBAAkB,SAAQ,sBAAoC;;IACzE,iCAAiC;IACjC,OAAgB,MAAM,EAAE,cAAc,CAgFpC;IAEF,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAkC;IAExF,eAAe,CAAiB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAe;IAgCrE;;;OAGG;IACyC,QAAQ,UAAS;IAE7D;;;OAGG;IACS,QAAQ,EAAE,eAAe,CAAW;IAEhD;;;OAGG;IACH,IAAyD,SAAS,IAAI,MAAM,CAE3E;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAE1B;IAED;;;OAGG;IACH,IAAyD,SAAS,IAAI,MAAM,CAE3E;IACD,IAAI,SAAS,CAAC,KAAK,EAAE,MAAM,EAE1B;IAED;;;OAGG;IACwC,aAAa,EAAE,oBAAoB,CAAU;IAExF,kBAAkB;IACT,MAAM,CAAC,OAAO,EAAE,WAAW,GAAG,IAAI;IAiB3C,kBAAkB;IACT,MAAM,IAAI,IAAI;IAcvB,kBAAkB;IACT,iBAAiB,IAAI,IAAI;IAKlC,kBAAkB;cACC,MAAM,CAAC,iBAAiB,EAAE,cAAc,CAAC,IAAI,CAAC,GAAG,IAAI;IAQxE,kBAAkB;cACC,MAAM,IAAI,OAAO;IAMpC;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IA0B3B,kCAAkC;IAClC,IAAI,IAAI,IAAI;CAsDb;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,aAAa,EAAE,iBAAiB,CAAC;KAClC;CACF"}

package/dist/src/TooltipPosition.d.ts

@@ -0,0 +1,3 @@
+/** Specifies the possible positions for a tooltip. */
+export type TooltipPosition = "above" | "below" | "before" | "after";
+//# sourceMappingURL=TooltipPosition.d.ts.map

package/dist/src/TooltipPosition.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TooltipPosition.d.ts","sourceRoot":"","sources":["../../src/TooltipPosition.ts"],"names":[],"mappings":"AAAA,sDAAsD;AACtD,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC"}

package/dist/src/TooltipTouchGestures.d.ts

@@ -0,0 +1,3 @@
+/** Specifies the possible modes in which a tooltip should handle touch gestures. */
+export type TooltipTouchGestures = "auto" | "on" | "off";
+//# sourceMappingURL=TooltipTouchGestures.d.ts.map

package/dist/src/TooltipTouchGestures.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TooltipTouchGestures.d.ts","sourceRoot":"","sources":["../../src/TooltipTouchGestures.ts"],"names":[],"mappings":"AAAA,oFAAoF;AACpF,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,IAAI,GAAG,KAAK,CAAC"}

package/dist/src/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./TooltipElement";
+export * from "./TooltipPosition";
+export * from "./TooltipTouchGestures";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,wBAAwB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@m3e/tooltip",
-  "version": "1.0.0-rc.2",
+  "version": "1.0.0-rc.3",
   "description": "Tooltip for M3E",
   "author": "matraic <matraic@yahoo.com>",
   "license": "MIT",
@@ -30,7 +30,7 @@
     "@material/material-color-utilities": "^0.3.0"
   },
   "peerDependencies": {
-    "@m3e/core": "1.0.0-rc.2",
+    "@m3e/core": "1.0.0-rc.3",
     "lit": "^3.3.0"
   },
   "devDependencies": {