@zag-js/tooltip 1.34.1 → 1.35.0

package/dist/tooltip.types.d.ts

@@ -0,0 +1,119 @@
+import { Machine, EventObject, Service } from '@zag-js/core';
+import { PositioningOptions, Placement } from '@zag-js/popper';
+export { Placement, PositioningOptions } from '@zag-js/popper';
+import { PropTypes, RequiredBy, DirectionProperty, CommonProperties } from '@zag-js/types';
+
+interface OpenChangeDetails {
+    open: boolean;
+}
+type ElementIds = Partial<{
+    trigger: string;
+    content: string;
+    arrow: string;
+    positioner: string;
+}>;
+interface TooltipProps extends DirectionProperty, CommonProperties {
+    /**
+     * The ids of the elements in the tooltip. Useful for composition.
+     */
+    ids?: ElementIds | undefined;
+    /**
+     * The open delay of the tooltip.
+     * @default 400
+     */
+    openDelay?: number | undefined;
+    /**
+     * The close delay of the tooltip.
+     * @default 150
+     */
+    closeDelay?: number | undefined;
+    /**
+     * Whether to close the tooltip on pointerdown.
+     * @default true
+     */
+    closeOnPointerDown?: boolean | undefined;
+    /**
+     * Whether to close the tooltip when the Escape key is pressed.
+     * @default true
+     */
+    closeOnEscape?: boolean | undefined;
+    /**
+     * Whether the tooltip should close on scroll
+     * @default true
+     */
+    closeOnScroll?: boolean | undefined;
+    /**
+     * Whether the tooltip should close on click
+     * @default true
+     */
+    closeOnClick?: boolean | undefined;
+    /**
+     * Whether the tooltip's content is interactive.
+     * In this mode, the tooltip will remain open when user hovers over the content.
+     * @see https://www.w3.org/TR/WCAG21/#content-on-hover-or-focus
+     *
+     * @default false
+     */
+    interactive?: boolean | undefined;
+    /**
+     * Function called when the tooltip is opened.
+     */
+    onOpenChange?: ((details: OpenChangeDetails) => void) | undefined;
+    /**
+     * Custom label for the tooltip.
+     */
+    "aria-label"?: string | undefined;
+    /**
+     * The user provided options used to position the popover content
+     */
+    positioning?: PositioningOptions | undefined;
+    /**
+     * Whether the tooltip is disabled
+     */
+    disabled?: boolean | undefined;
+    /**
+     * The controlled open state of the tooltip
+     */
+    open?: boolean | undefined;
+    /**
+     * The initial open state of the tooltip when rendered.
+     * Use when you don't need to control the open state of the tooltip.
+     */
+    defaultOpen?: boolean | undefined;
+}
+type PropsWithDefault = "openDelay" | "closeDelay" | "closeOnPointerDown" | "closeOnEscape" | "closeOnScroll" | "closeOnClick" | "interactive" | "id" | "positioning";
+interface TooltipSchema {
+    state: "open" | "closed" | "opening" | "closing";
+    props: RequiredBy<TooltipProps, PropsWithDefault>;
+    context: {
+        currentPlacement: Placement | undefined;
+        hasPointerMoveOpened: boolean;
+    };
+    event: EventObject;
+    action: string;
+    effect: string;
+    guard: string;
+}
+type TooltipService = Service<TooltipSchema>;
+type TooltipMachine = Machine<TooltipSchema>;
+interface TooltipApi<T extends PropTypes = PropTypes> {
+    /**
+     * Whether the tooltip is open.
+     */
+    open: boolean;
+    /**
+     * Function to open the tooltip.
+     */
+    setOpen: (open: boolean) => void;
+    /**
+     * Function to reposition the popover
+     */
+    reposition: (options?: Partial<PositioningOptions>) => void;
+    getTriggerProps: () => T["button"];
+    getArrowProps: () => T["element"];
+    getArrowTipProps: () => T["element"];
+    getPositionerProps: () => T["element"];
+    getContentProps: () => T["element"];
+}
+
+export type { ElementIds, OpenChangeDetails, TooltipApi, TooltipMachine, TooltipProps, TooltipSchema, TooltipService };

package/dist/tooltip.types.js

@@ -0,0 +1,18 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/tooltip.types.ts
+var tooltip_types_exports = {};
+module.exports = __toCommonJS(tooltip_types_exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zag-js/tooltip",
-  "version": "1.34.1",
+  "version": "1.35.0",
   "description": "Core logic for the tooltip widget implemented as a state machine",
   "keywords": [
     "js",
@@ -26,18 +26,18 @@
     "url": "https://github.com/chakra-ui/zag/issues"
   },
   "dependencies": {
-    "@zag-js/anatomy": "1.34.1",
-    "@zag-js/core": "1.34.1",
-    "@zag-js/popper": "1.34.1",
-    "@zag-js/focus-visible": "1.34.1",
-    "@zag-js/dom-query": "1.34.1",
-    "@zag-js/utils": "1.34.1",
-    "@zag-js/types": "1.34.1"
+    "@zag-js/anatomy": "1.35.0",
+    "@zag-js/core": "1.35.0",
+    "@zag-js/popper": "1.35.0",
+    "@zag-js/focus-visible": "1.35.0",
+    "@zag-js/dom-query": "1.35.0",
+    "@zag-js/utils": "1.35.0",
+    "@zag-js/types": "1.35.0"
   },
   "devDependencies": {
     "clean-package": "2.2.0"
   },
-  "clean-package": "../../../clean-package.config.json",
+  "clean-package": "./clean-package.config.json",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -52,6 +52,16 @@
         "default": "./dist/index.js"
       }
     },
+    "./anatomy": {
+      "import": {
+        "types": "./dist/tooltip.anatomy.d.mts",
+        "default": "./dist/tooltip.anatomy.mjs"
+      },
+      "require": {
+        "types": "./dist/tooltip.anatomy.d.ts",
+        "default": "./dist/tooltip.anatomy.js"
+      }
+    },
     "./package.json": "./package.json"
   },
   "scripts": {