@react-md/core 1.0.0-next.12 → 1.0.0-next.14

package/dist/tooltip/Tooltip.d.ts

@@ -6,9 +6,8 @@ import { type CSSTransitionComponentProps, type TransitionActions } from "../tra
  * The base props for the `Tooltip` component. This can be extended when
  * creating custom tooltip implementations.
  *
- * @remarks
- * \@since 2.8.0 Supports the `RenderConditionalPortalProps`
- * \@since 6.0.0 No longer supports the `RenderConditionalPortalProps`.
+ * @since 2.8.0 Supports the `RenderConditionalPortalProps`
+ * @since 6.0.0 No longer supports the `RenderConditionalPortalProps`.
  */
 export interface TooltipProps extends HTMLAttributes<HTMLSpanElement>, CSSTransitionComponentProps, TransitionActions {
     visible: boolean;
@@ -50,8 +49,7 @@ export interface TooltipProps extends HTMLAttributes<HTMLSpanElement>, CSSTransi
  * will need to manually add all the event listeners and triggers to change the
  * `visible` prop.
  *
- * @example
- * Simple Usage
+ * @example Simple Usage
  * ```tsx
  * import { Button, useTooltip, Tooltip } from "@react-md/core";
  *

package/dist/tooltip/Tooltip.js

@@ -14,8 +14,7 @@ import { tooltip } from "./tooltipStyles.js";
  * will need to manually add all the event listeners and triggers to change the
  * `visible` prop.
  *
- * @example
- * Simple Usage
+ * @example Simple Usage
  * ```tsx
  * import { Button, useTooltip, Tooltip } from "@react-md/core";
  *

package/dist/tooltip/Tooltip.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/tooltip/Tooltip.tsx"],"sourcesContent":["\"use client\";\nimport { forwardRef, type HTMLAttributes } from \"react\";\nimport { type TextOverflow } from \"../cssUtils.js\";\nimport { Portal } from \"../portal/Portal.js\";\nimport { type SimplePosition } from \"../positioning/types.js\";\nimport {\n  type CSSTransitionComponentProps,\n  type TransitionActions,\n} from \"../transition/types.js\";\nimport { useCSSTransition } from \"../transition/useCSSTransition.js\";\nimport { useEnsuredId } from \"../useEnsuredId.js\";\nimport {\n  DEFAULT_TOOLTIP_CLASSNAMES,\n  DEFAULT_TOOLTIP_POSITION,\n  DEFAULT_TOOLTIP_TIMEOUT,\n} from \"./constants.js\";\nimport { tooltip } from \"./tooltipStyles.js\";\n\n/**\n * The base props for the `Tooltip` component. This can be extended when\n * creating custom tooltip implementations.\n *\n * @remarks\n * \\@since 2.8.0 Supports the `RenderConditionalPortalProps`\n * \\@since 6.0.0 No longer supports the `RenderConditionalPortalProps`.\n */\nexport interface TooltipProps\n  extends HTMLAttributes<HTMLSpanElement>,\n    CSSTransitionComponentProps,\n    TransitionActions {\n  visible: boolean;\n\n  /**\n   * @defaultValue `false`\n   */\n  dense?: boolean;\n\n  /**\n   * @defaultValue `DEFAULT_TOOLTIP_POSITION`\n   * @see {@link DEFAULT_TOOLTIP_POSITION}\n   */\n  position?: SimplePosition;\n\n  /**\n   * @see {@link CSSTransitionComponentProps.temporary}\n   * @defaultValue `true`\n   */\n  temporary?: boolean;\n\n  /**\n   * @defaultValue `false`\n   */\n  disablePortal?: boolean;\n\n  /**\n   * Set this to `\"nowrap\"` for tooltips that are positioned near the edge of\n   * the viewport that have a position of `\"above\"` or `\"below\"` so that the\n   * tooltip no longer aligns to the center of the tooltipped element.\n   *\n   * Set this to `\"ellipsis\"` if the tooltip should only show a single line of\n   * text and ellipsis once it has reached the max tooltip width.\n   *\n   * @defaultValue `\"allow\"`\n   */\n  textOverflow?: TextOverflow;\n}\n\n/**\n * **Client Component**\n *\n * This is the base tooltip component that can only be used to render a tooltip\n * with an animation when the visibility changes. If this component is used, you\n * will need to manually add all the event listeners and triggers to change the\n * `visible` prop.\n *\n * @example\n * Simple Usage\n * ```tsx\n * import { Button, useTooltip, Tooltip } from \"@react-md/core\";\n *\n * function Example() {\n *   const { elementProps, tooltipProps } = useTooltip();\n *\n *   return (\n *     <>\n *       <Button {...elementProps}>Button</Button>\n *       <Tooltip {...tooltipProps}>\n *         Tooltip Content\n *       </Tooltip>\n *     </>\n *   );\n * }\n * ```\n */\nexport const Tooltip = forwardRef<HTMLSpanElement, TooltipProps>(\n  function Tooltip(props, nodeRef) {\n    const {\n      id: propId,\n      dense,\n      visible,\n      children,\n      appear,\n      enter,\n      exit,\n      onEnter,\n      onEntering,\n      onEntered,\n      onExit,\n      onExiting,\n      onExited,\n      timeout = DEFAULT_TOOLTIP_TIMEOUT,\n      classNames = DEFAULT_TOOLTIP_CLASSNAMES,\n      className,\n      position = DEFAULT_TOOLTIP_POSITION,\n      temporary = true,\n      exitedHidden = !temporary,\n      textOverflow,\n      disablePortal: propDisablePortal,\n      ...remaining\n    } = props;\n    const id = useEnsuredId(propId, \"tooltip\");\n\n    const { rendered, elementProps, disablePortal } = useCSSTransition({\n      nodeRef,\n      appear,\n      enter,\n      exit,\n      transitionIn: visible,\n      timeout,\n      classNames,\n      className: tooltip({\n        dense,\n        position,\n        className,\n        textOverflow,\n      }),\n      onEnter,\n      onEntering,\n      onEntered,\n      onExit,\n      onExiting,\n      onExited,\n      temporary,\n      exitedHidden,\n      disablePortal: propDisablePortal,\n    });\n\n    return (\n      <Portal disabled={disablePortal}>\n        {rendered && (\n          <span {...remaining} {...elementProps} id={id} role=\"tooltip\">\n            {children}\n          </span>\n        )}\n      </Portal>\n    );\n  }\n);\n"],"names":["forwardRef","Portal","useCSSTransition","useEnsuredId","DEFAULT_TOOLTIP_CLASSNAMES","DEFAULT_TOOLTIP_POSITION","DEFAULT_TOOLTIP_TIMEOUT","tooltip","Tooltip","props","nodeRef","id","propId","dense","visible","children","appear","enter","exit","onEnter","onEntering","onEntered","onExit","onExiting","onExited","timeout","classNames","className","position","temporary","exitedHidden","textOverflow","disablePortal","propDisablePortal","remaining","rendered","elementProps","transitionIn","disabled","span","role"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;;AACA,SAASA,UAAU,QAA6B,QAAQ;AAExD,SAASC,MAAM,QAAQ,sBAAsB;AAM7C,SAASC,gBAAgB,QAAQ,oCAAoC;AACrE,SAASC,YAAY,QAAQ,qBAAqB;AAClD,SACEC,0BAA0B,EAC1BC,wBAAwB,EACxBC,uBAAuB,QAClB,iBAAiB;AACxB,SAASC,OAAO,QAAQ,qBAAqB;AAmD7C;;;;;;;;;;;;;;;;;;;;;;;;;;CA0BC,GACD,OAAO,MAAMC,wBAAUR,WACrB,SAASQ,QAAQC,KAAK,EAAEC,OAAO;IAC7B,MAAM,EACJC,IAAIC,MAAM,EACVC,KAAK,EACLC,OAAO,EACPC,QAAQ,EACRC,MAAM,EACNC,KAAK,EACLC,IAAI,EACJC,OAAO,EACPC,UAAU,EACVC,SAAS,EACTC,MAAM,EACNC,SAAS,EACTC,QAAQ,EACRC,UAAUnB,uBAAuB,EACjCoB,aAAatB,0BAA0B,EACvCuB,SAAS,EACTC,WAAWvB,wBAAwB,EACnCwB,YAAY,IAAI,EAChBC,eAAe,CAACD,SAAS,EACzBE,YAAY,EACZC,eAAeC,iBAAiB,EAChC,GAAGC,WACJ,GAAGzB;IACJ,MAAME,KAAKR,aAAaS,QAAQ;IAEhC,MAAM,EAAEuB,QAAQ,EAAEC,YAAY,EAAEJ,aAAa,EAAE,GAAG9B,iBAAiB;QACjEQ;QACAM;QACAC;QACAC;QACAmB,cAAcvB;QACdW;QACAC;QACAC,WAAWpB,QAAQ;YACjBM;YACAe;YACAD;YACAI;QACF;QACAZ;QACAC;QACAC;QACAC;QACAC;QACAC;QACAK;QACAC;QACAE,eAAeC;IACjB;IAEA,qBACE,KAAChC;QAAOqC,UAAUN;kBACfG,0BACC,KAACI;YAAM,GAAGL,SAAS;YAAG,GAAGE,YAAY;YAAEzB,IAAIA;YAAI6B,MAAK;sBACjDzB;;;AAKX,GACA"}
+{"version":3,"sources":["../../src/tooltip/Tooltip.tsx"],"sourcesContent":["\"use client\";\nimport { forwardRef, type HTMLAttributes } from \"react\";\nimport { type TextOverflow } from \"../cssUtils.js\";\nimport { Portal } from \"../portal/Portal.js\";\nimport { type SimplePosition } from \"../positioning/types.js\";\nimport {\n  type CSSTransitionComponentProps,\n  type TransitionActions,\n} from \"../transition/types.js\";\nimport { useCSSTransition } from \"../transition/useCSSTransition.js\";\nimport { useEnsuredId } from \"../useEnsuredId.js\";\nimport {\n  DEFAULT_TOOLTIP_CLASSNAMES,\n  DEFAULT_TOOLTIP_POSITION,\n  DEFAULT_TOOLTIP_TIMEOUT,\n} from \"./constants.js\";\nimport { tooltip } from \"./tooltipStyles.js\";\n\n/**\n * The base props for the `Tooltip` component. This can be extended when\n * creating custom tooltip implementations.\n *\n * @since 2.8.0 Supports the `RenderConditionalPortalProps`\n * @since 6.0.0 No longer supports the `RenderConditionalPortalProps`.\n */\nexport interface TooltipProps\n  extends HTMLAttributes<HTMLSpanElement>,\n    CSSTransitionComponentProps,\n    TransitionActions {\n  visible: boolean;\n\n  /**\n   * @defaultValue `false`\n   */\n  dense?: boolean;\n\n  /**\n   * @defaultValue `DEFAULT_TOOLTIP_POSITION`\n   * @see {@link DEFAULT_TOOLTIP_POSITION}\n   */\n  position?: SimplePosition;\n\n  /**\n   * @see {@link CSSTransitionComponentProps.temporary}\n   * @defaultValue `true`\n   */\n  temporary?: boolean;\n\n  /**\n   * @defaultValue `false`\n   */\n  disablePortal?: boolean;\n\n  /**\n   * Set this to `\"nowrap\"` for tooltips that are positioned near the edge of\n   * the viewport that have a position of `\"above\"` or `\"below\"` so that the\n   * tooltip no longer aligns to the center of the tooltipped element.\n   *\n   * Set this to `\"ellipsis\"` if the tooltip should only show a single line of\n   * text and ellipsis once it has reached the max tooltip width.\n   *\n   * @defaultValue `\"allow\"`\n   */\n  textOverflow?: TextOverflow;\n}\n\n/**\n * **Client Component**\n *\n * This is the base tooltip component that can only be used to render a tooltip\n * with an animation when the visibility changes. If this component is used, you\n * will need to manually add all the event listeners and triggers to change the\n * `visible` prop.\n *\n * @example Simple Usage\n * ```tsx\n * import { Button, useTooltip, Tooltip } from \"@react-md/core\";\n *\n * function Example() {\n *   const { elementProps, tooltipProps } = useTooltip();\n *\n *   return (\n *     <>\n *       <Button {...elementProps}>Button</Button>\n *       <Tooltip {...tooltipProps}>\n *         Tooltip Content\n *       </Tooltip>\n *     </>\n *   );\n * }\n * ```\n */\nexport const Tooltip = forwardRef<HTMLSpanElement, TooltipProps>(\n  function Tooltip(props, nodeRef) {\n    const {\n      id: propId,\n      dense,\n      visible,\n      children,\n      appear,\n      enter,\n      exit,\n      onEnter,\n      onEntering,\n      onEntered,\n      onExit,\n      onExiting,\n      onExited,\n      timeout = DEFAULT_TOOLTIP_TIMEOUT,\n      classNames = DEFAULT_TOOLTIP_CLASSNAMES,\n      className,\n      position = DEFAULT_TOOLTIP_POSITION,\n      temporary = true,\n      exitedHidden = !temporary,\n      textOverflow,\n      disablePortal: propDisablePortal,\n      ...remaining\n    } = props;\n    const id = useEnsuredId(propId, \"tooltip\");\n\n    const { rendered, elementProps, disablePortal } = useCSSTransition({\n      nodeRef,\n      appear,\n      enter,\n      exit,\n      transitionIn: visible,\n      timeout,\n      classNames,\n      className: tooltip({\n        dense,\n        position,\n        className,\n        textOverflow,\n      }),\n      onEnter,\n      onEntering,\n      onEntered,\n      onExit,\n      onExiting,\n      onExited,\n      temporary,\n      exitedHidden,\n      disablePortal: propDisablePortal,\n    });\n\n    return (\n      <Portal disabled={disablePortal}>\n        {rendered && (\n          <span {...remaining} {...elementProps} id={id} role=\"tooltip\">\n            {children}\n          </span>\n        )}\n      </Portal>\n    );\n  }\n);\n"],"names":["forwardRef","Portal","useCSSTransition","useEnsuredId","DEFAULT_TOOLTIP_CLASSNAMES","DEFAULT_TOOLTIP_POSITION","DEFAULT_TOOLTIP_TIMEOUT","tooltip","Tooltip","props","nodeRef","id","propId","dense","visible","children","appear","enter","exit","onEnter","onEntering","onEntered","onExit","onExiting","onExited","timeout","classNames","className","position","temporary","exitedHidden","textOverflow","disablePortal","propDisablePortal","remaining","rendered","elementProps","transitionIn","disabled","span","role"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;;AACA,SAASA,UAAU,QAA6B,QAAQ;AAExD,SAASC,MAAM,QAAQ,sBAAsB;AAM7C,SAASC,gBAAgB,QAAQ,oCAAoC;AACrE,SAASC,YAAY,QAAQ,qBAAqB;AAClD,SACEC,0BAA0B,EAC1BC,wBAAwB,EACxBC,uBAAuB,QAClB,iBAAiB;AACxB,SAASC,OAAO,QAAQ,qBAAqB;AAkD7C;;;;;;;;;;;;;;;;;;;;;;;;;CAyBC,GACD,OAAO,MAAMC,wBAAUR,WACrB,SAASQ,QAAQC,KAAK,EAAEC,OAAO;IAC7B,MAAM,EACJC,IAAIC,MAAM,EACVC,KAAK,EACLC,OAAO,EACPC,QAAQ,EACRC,MAAM,EACNC,KAAK,EACLC,IAAI,EACJC,OAAO,EACPC,UAAU,EACVC,SAAS,EACTC,MAAM,EACNC,SAAS,EACTC,QAAQ,EACRC,UAAUnB,uBAAuB,EACjCoB,aAAatB,0BAA0B,EACvCuB,SAAS,EACTC,WAAWvB,wBAAwB,EACnCwB,YAAY,IAAI,EAChBC,eAAe,CAACD,SAAS,EACzBE,YAAY,EACZC,eAAeC,iBAAiB,EAChC,GAAGC,WACJ,GAAGzB;IACJ,MAAME,KAAKR,aAAaS,QAAQ;IAEhC,MAAM,EAAEuB,QAAQ,EAAEC,YAAY,EAAEJ,aAAa,EAAE,GAAG9B,iBAAiB;QACjEQ;QACAM;QACAC;QACAC;QACAmB,cAAcvB;QACdW;QACAC;QACAC,WAAWpB,QAAQ;YACjBM;YACAe;YACAD;YACAI;QACF;QACAZ;QACAC;QACAC;QACAC;QACAC;QACAC;QACAK;QACAC;QACAE,eAAeC;IACjB;IAEA,qBACE,KAAChC;QAAOqC,UAAUN;kBACfG,0BACC,KAACI;YAAM,GAAGL,SAAS;YAAG,GAAGE,YAAY;YAAEzB,IAAIA;YAAI6B,MAAK;sBACjDzB;;;AAKX,GACA"}

package/dist/tooltip/TooltipHoverModeProvider.d.ts

@@ -1,14 +1,14 @@
 import { type ReactElement, type ReactNode } from "react";
 import { type HoverModeConfiguration, type HoverModeContext } from "../hoverMode/useHoverModeProvider.js";
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export type TooltipHoverModeContext = HoverModeContext;
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare function useTooltipHoverMode(): Readonly<TooltipHoverModeContext>;
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface TooltipHoverModeProviderProps extends Partial<HoverModeConfiguration> {
     children: ReactNode;
@@ -36,8 +36,7 @@ export interface TooltipHoverModeProviderProps extends Partial<HoverModeConfigur
  * You can also use this provider to configure all tooltips' visibility delay to
  * a new value.
  *
- * @example
- * Configuration Example
+ * @example Configuration Example
  * ```tsx
  * <TooltipHoverModeProvider
  *   // wait 3 seconds before displaying any tooltips
@@ -54,6 +53,6 @@ export interface TooltipHoverModeProviderProps extends Partial<HoverModeConfigur
  * </TooltipHoverModeProvider>
  * ```
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare function TooltipHoverModeProvider(props: TooltipHoverModeProviderProps): ReactElement;

package/dist/tooltip/TooltipHoverModeProvider.js

@@ -11,7 +11,7 @@ context.displayName = "TooltipHoverMode";
 const { Provider } = context;
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export function useTooltipHoverMode() {
     return useContext(context);
 }
@@ -23,8 +23,7 @@ const { Provider } = context;
  * You can also use this provider to configure all tooltips' visibility delay to
  * a new value.
  *
- * @example
- * Configuration Example
+ * @example Configuration Example
  * ```tsx
  * <TooltipHoverModeProvider
  *   // wait 3 seconds before displaying any tooltips
@@ -41,7 +40,7 @@ const { Provider } = context;
  * </TooltipHoverModeProvider>
  * ```
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export function TooltipHoverModeProvider(props) {
     const { hoverTimeout = DEFAULT_TOOLTIP_DELAY, leaveTimeout = 0, disableTimeout = DEFAULT_TOOLTIP_DELAY, defaultActiveId, children } = props;
     const context = useHoverModeProvider({

package/dist/tooltip/TooltipHoverModeProvider.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/tooltip/TooltipHoverModeProvider.tsx"],"sourcesContent":["\"use client\";\nimport {\n  createContext,\n  useContext,\n  type ReactElement,\n  type ReactNode,\n} from \"react\";\nimport {\n  createHoverModeContext,\n  useHoverModeProvider,\n  type HoverModeConfiguration,\n  type HoverModeContext,\n} from \"../hoverMode/useHoverModeProvider.js\";\nimport { DEFAULT_TOOLTIP_DELAY } from \"./constants.js\";\n\n/** @remarks \\@since 6.0.0 */\nexport type TooltipHoverModeContext = HoverModeContext;\n\nconst context = createContext<TooltipHoverModeContext>(\n  createHoverModeContext({\n    hoverTimeout: DEFAULT_TOOLTIP_DELAY,\n    leaveTimeout: 0,\n  })\n);\ncontext.displayName = \"TooltipHoverMode\";\nconst { Provider } = context;\n\n/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nexport function useTooltipHoverMode(): Readonly<TooltipHoverModeContext> {\n  return useContext(context);\n}\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport interface TooltipHoverModeProviderProps\n  extends Partial<HoverModeConfiguration> {\n  children: ReactNode;\n\n  /**\n   * @see {@link HoverModeConfiguration.hoverTimeout}\n   * @defaultValue `1000`\n   */\n  hoverTimeout?: number;\n\n  /**\n   * @see {@link HoverModeConfiguration.leaveTimeout}\n   * @defaultValue `0`\n   */\n  leaveTimeout?: number;\n\n  /**\n   * @see {@link HoverModeConfiguration.disableTimeout}\n   * @defaultValue `1000`\n   */\n  disableTimeout?: number;\n}\n\n/**\n * **Client Component**\n *\n * Updates all tooltips that are rendered as a child anywhere in the React tree\n * to immediately appear for a short duration once a tooltip has become visible.\n * You can also use this provider to configure all tooltips' visibility delay to\n * a new value.\n *\n * @example\n * Configuration Example\n * ```tsx\n * <TooltipHoverModeProvider\n *   // wait 3 seconds before displaying any tooltips\n *   hoverTimeout={3000}\n *\n *   // wait 1 second before hiding any tooltips\n *   leaveTimeout={1000}\n *\n *   // disable the hover mode functionality only if another tooltip has not\n *   // been visible for 20 seconds\n *   disableTimeout={20000}\n * >\n *   <RestOfTheApp />\n * </TooltipHoverModeProvider>\n * ```\n *\n * @remarks \\@since 6.0.0\n */\nexport function TooltipHoverModeProvider(\n  props: TooltipHoverModeProviderProps\n): ReactElement {\n  const {\n    hoverTimeout = DEFAULT_TOOLTIP_DELAY,\n    leaveTimeout = 0,\n    disableTimeout = DEFAULT_TOOLTIP_DELAY,\n    defaultActiveId,\n    children,\n  } = props;\n  const context = useHoverModeProvider({\n    hoverTimeout,\n    leaveTimeout,\n    disableTimeout,\n    defaultActiveId,\n  });\n\n  return <Provider value={context}>{children}</Provider>;\n}\n"],"names":["createContext","useContext","createHoverModeContext","useHoverModeProvider","DEFAULT_TOOLTIP_DELAY","context","hoverTimeout","leaveTimeout","displayName","Provider","useTooltipHoverMode","TooltipHoverModeProvider","props","disableTimeout","defaultActiveId","children","value"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;;AACA,SACEA,aAAa,EACbC,UAAU,QAGL,QAAQ;AACf,SACEC,sBAAsB,EACtBC,oBAAoB,QAGf,uCAAuC;AAC9C,SAASC,qBAAqB,QAAQ,iBAAiB;AAKvD,MAAMC,wBAAUL,cACdE,uBAAuB;IACrBI,cAAcF;IACdG,cAAc;AAChB;AAEFF,QAAQG,WAAW,GAAG;AACtB,MAAM,EAAEC,QAAQ,EAAE,GAAGJ;AAErB;;;CAGC,GACD,OAAO,SAASK;IACd,OAAOT,WAAWI;AACpB;AA4BA;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BC,GACD,OAAO,SAASM,yBACdC,KAAoC;IAEpC,MAAM,EACJN,eAAeF,qBAAqB,EACpCG,eAAe,CAAC,EAChBM,iBAAiBT,qBAAqB,EACtCU,eAAe,EACfC,QAAQ,EACT,GAAGH;IACJ,MAAMP,UAAUF,qBAAqB;QACnCG;QACAC;QACAM;QACAC;IACF;IAEA,qBAAO,KAACL;QAASO,OAAOX;kBAAUU;;AACpC"}
+{"version":3,"sources":["../../src/tooltip/TooltipHoverModeProvider.tsx"],"sourcesContent":["\"use client\";\nimport {\n  createContext,\n  useContext,\n  type ReactElement,\n  type ReactNode,\n} from \"react\";\nimport {\n  createHoverModeContext,\n  useHoverModeProvider,\n  type HoverModeConfiguration,\n  type HoverModeContext,\n} from \"../hoverMode/useHoverModeProvider.js\";\nimport { DEFAULT_TOOLTIP_DELAY } from \"./constants.js\";\n\n/** @since 6.0.0 */\nexport type TooltipHoverModeContext = HoverModeContext;\n\nconst context = createContext<TooltipHoverModeContext>(\n  createHoverModeContext({\n    hoverTimeout: DEFAULT_TOOLTIP_DELAY,\n    leaveTimeout: 0,\n  })\n);\ncontext.displayName = \"TooltipHoverMode\";\nconst { Provider } = context;\n\n/**\n * @internal\n * @since 6.0.0\n */\nexport function useTooltipHoverMode(): Readonly<TooltipHoverModeContext> {\n  return useContext(context);\n}\n\n/**\n * @since 6.0.0\n */\nexport interface TooltipHoverModeProviderProps\n  extends Partial<HoverModeConfiguration> {\n  children: ReactNode;\n\n  /**\n   * @see {@link HoverModeConfiguration.hoverTimeout}\n   * @defaultValue `1000`\n   */\n  hoverTimeout?: number;\n\n  /**\n   * @see {@link HoverModeConfiguration.leaveTimeout}\n   * @defaultValue `0`\n   */\n  leaveTimeout?: number;\n\n  /**\n   * @see {@link HoverModeConfiguration.disableTimeout}\n   * @defaultValue `1000`\n   */\n  disableTimeout?: number;\n}\n\n/**\n * **Client Component**\n *\n * Updates all tooltips that are rendered as a child anywhere in the React tree\n * to immediately appear for a short duration once a tooltip has become visible.\n * You can also use this provider to configure all tooltips' visibility delay to\n * a new value.\n *\n * @example Configuration Example\n * ```tsx\n * <TooltipHoverModeProvider\n *   // wait 3 seconds before displaying any tooltips\n *   hoverTimeout={3000}\n *\n *   // wait 1 second before hiding any tooltips\n *   leaveTimeout={1000}\n *\n *   // disable the hover mode functionality only if another tooltip has not\n *   // been visible for 20 seconds\n *   disableTimeout={20000}\n * >\n *   <RestOfTheApp />\n * </TooltipHoverModeProvider>\n * ```\n *\n * @since 6.0.0\n */\nexport function TooltipHoverModeProvider(\n  props: TooltipHoverModeProviderProps\n): ReactElement {\n  const {\n    hoverTimeout = DEFAULT_TOOLTIP_DELAY,\n    leaveTimeout = 0,\n    disableTimeout = DEFAULT_TOOLTIP_DELAY,\n    defaultActiveId,\n    children,\n  } = props;\n  const context = useHoverModeProvider({\n    hoverTimeout,\n    leaveTimeout,\n    disableTimeout,\n    defaultActiveId,\n  });\n\n  return <Provider value={context}>{children}</Provider>;\n}\n"],"names":["createContext","useContext","createHoverModeContext","useHoverModeProvider","DEFAULT_TOOLTIP_DELAY","context","hoverTimeout","leaveTimeout","displayName","Provider","useTooltipHoverMode","TooltipHoverModeProvider","props","disableTimeout","defaultActiveId","children","value"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;;AACA,SACEA,aAAa,EACbC,UAAU,QAGL,QAAQ;AACf,SACEC,sBAAsB,EACtBC,oBAAoB,QAGf,uCAAuC;AAC9C,SAASC,qBAAqB,QAAQ,iBAAiB;AAKvD,MAAMC,wBAAUL,cACdE,uBAAuB;IACrBI,cAAcF;IACdG,cAAc;AAChB;AAEFF,QAAQG,WAAW,GAAG;AACtB,MAAM,EAAEC,QAAQ,EAAE,GAAGJ;AAErB;;;CAGC,GACD,OAAO,SAASK;IACd,OAAOT,WAAWI;AACpB;AA4BA;;;;;;;;;;;;;;;;;;;;;;;;;;CA0BC,GACD,OAAO,SAASM,yBACdC,KAAoC;IAEpC,MAAM,EACJN,eAAeF,qBAAqB,EACpCG,eAAe,CAAC,EAChBM,iBAAiBT,qBAAqB,EACtCU,eAAe,EACfC,QAAQ,EACT,GAAGH;IACJ,MAAMP,UAAUF,qBAAqB;QACnCG;QACAC;QACAM;QACAC;IACF;IAEA,qBAAO,KAACL;QAASO,OAAOX;kBAAUU;;AACpC"}

package/dist/tooltip/constants.d.ts

@@ -1,22 +1,22 @@
 import type { CSSTransitionClassNames, TransitionTimeout } from "../transition/types.js";
-/** @remarks \@since 2.0.0 */
+/** @since 2.0.0 */
 export declare const DEFAULT_TOOLTIP_CLASSNAMES: Readonly<CSSTransitionClassNames>;
-/** @remarks \@since 2.0.0 */
+/** @since 2.0.0 */
 export declare const DEFAULT_TOOLTIP_TIMEOUT: Readonly<TransitionTimeout>;
-/** @remarks \@since 2.0.0 */
+/** @since 2.0.0 */
 export declare const DEFAULT_TOOLTIP_DELAY = 1000;
-/** @remarks \@since 2.0.0 */
+/** @since 2.0.0 */
 export declare const DEFAULT_TOOLTIP_THRESHOLD = 0.75;
-/** @remarks \@since 2.8.0 */
+/** @since 2.8.0 */
 export declare const DEFAULT_TOOLTIP_SPACING = "1.5rem";
-/** @remarks \@since 2.8.0 */
+/** @since 2.8.0 */
 export declare const DEFAULT_TOOLTIP_DENSE_SPACING = "0.875rem";
-/** @remarks \@since 2.8.0 */
+/** @since 2.8.0 */
 export declare const DEFAULT_TOOLTIP_MARGIN = 16;
-/** @remarks \@since 2.8.0 */
+/** @since 2.8.0 */
 export declare const DEFAULT_TOOLTIP_POSITION = "below";
 /**
  * @internal
- * @remarks \@since 2.8.0
+ * @since 2.8.0
  */
 export declare const TOOLTIP_SPACING_VAR = "--rmd-tooltip-spacing";

package/dist/tooltip/constants.js

@@ -1,4 +1,4 @@
-/** @remarks \@since 2.0.0 */ export const DEFAULT_TOOLTIP_CLASSNAMES = {
+/** @since 2.0.0 */ export const DEFAULT_TOOLTIP_CLASSNAMES = {
     appear: "rmd-tooltip--enter",
     appearActive: "rmd-tooltip--visible",
     enter: "rmd-tooltip--enter",
@@ -7,19 +7,19 @@
     exit: "rmd-tooltip--visible rmd-tooltip--exit",
     exitActive: "rmd-tooltip--exit-active"
 };
-/** @remarks \@since 2.0.0 */ export const DEFAULT_TOOLTIP_TIMEOUT = {
+/** @since 2.0.0 */ export const DEFAULT_TOOLTIP_TIMEOUT = {
     enter: 200,
     exit: 150
 };
-/** @remarks \@since 2.0.0 */ export const DEFAULT_TOOLTIP_DELAY = 1000;
-/** @remarks \@since 2.0.0 */ export const DEFAULT_TOOLTIP_THRESHOLD = 0.75;
-/** @remarks \@since 2.8.0 */ export const DEFAULT_TOOLTIP_SPACING = "1.5rem";
-/** @remarks \@since 2.8.0 */ export const DEFAULT_TOOLTIP_DENSE_SPACING = "0.875rem";
-/** @remarks \@since 2.8.0 */ export const DEFAULT_TOOLTIP_MARGIN = 16;
-/** @remarks \@since 2.8.0 */ export const DEFAULT_TOOLTIP_POSITION = "below";
+/** @since 2.0.0 */ export const DEFAULT_TOOLTIP_DELAY = 1000;
+/** @since 2.0.0 */ export const DEFAULT_TOOLTIP_THRESHOLD = 0.75;
+/** @since 2.8.0 */ export const DEFAULT_TOOLTIP_SPACING = "1.5rem";
+/** @since 2.8.0 */ export const DEFAULT_TOOLTIP_DENSE_SPACING = "0.875rem";
+/** @since 2.8.0 */ export const DEFAULT_TOOLTIP_MARGIN = 16;
+/** @since 2.8.0 */ export const DEFAULT_TOOLTIP_POSITION = "below";
 /**
  * @internal
- * @remarks \@since 2.8.0
+ * @since 2.8.0
  */ export const TOOLTIP_SPACING_VAR = "--rmd-tooltip-spacing";
 
 //# sourceMappingURL=constants.js.map

package/dist/tooltip/constants.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/tooltip/constants.ts"],"sourcesContent":["import type {\n  CSSTransitionClassNames,\n  TransitionTimeout,\n} from \"../transition/types.js\";\n\n/** @remarks \\@since 2.0.0 */\nexport const DEFAULT_TOOLTIP_CLASSNAMES: Readonly<CSSTransitionClassNames> = {\n  appear: \"rmd-tooltip--enter\",\n  appearActive: \"rmd-tooltip--visible\",\n  enter: \"rmd-tooltip--enter\",\n  enterActive: \"rmd-tooltip--visible\",\n  enterDone: \"rmd-tooltip--visible\",\n  exit: \"rmd-tooltip--visible rmd-tooltip--exit\",\n  exitActive: \"rmd-tooltip--exit-active\",\n};\n\n/** @remarks \\@since 2.0.0 */\nexport const DEFAULT_TOOLTIP_TIMEOUT: Readonly<TransitionTimeout> = {\n  enter: 200,\n  exit: 150,\n};\n\n/** @remarks \\@since 2.0.0 */\nexport const DEFAULT_TOOLTIP_DELAY = 1000;\n/** @remarks \\@since 2.0.0 */\nexport const DEFAULT_TOOLTIP_THRESHOLD = 0.75;\n\n/** @remarks \\@since 2.8.0 */\nexport const DEFAULT_TOOLTIP_SPACING = \"1.5rem\";\n/** @remarks \\@since 2.8.0 */\nexport const DEFAULT_TOOLTIP_DENSE_SPACING = \"0.875rem\";\n/** @remarks \\@since 2.8.0 */\nexport const DEFAULT_TOOLTIP_MARGIN = 16;\n/** @remarks \\@since 2.8.0 */\nexport const DEFAULT_TOOLTIP_POSITION = \"below\";\n\n/**\n * @internal\n * @remarks \\@since 2.8.0\n */\nexport const TOOLTIP_SPACING_VAR = \"--rmd-tooltip-spacing\";\n"],"names":["DEFAULT_TOOLTIP_CLASSNAMES","appear","appearActive","enter","enterActive","enterDone","exit","exitActive","DEFAULT_TOOLTIP_TIMEOUT","DEFAULT_TOOLTIP_DELAY","DEFAULT_TOOLTIP_THRESHOLD","DEFAULT_TOOLTIP_SPACING","DEFAULT_TOOLTIP_DENSE_SPACING","DEFAULT_TOOLTIP_MARGIN","DEFAULT_TOOLTIP_POSITION","TOOLTIP_SPACING_VAR"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;","mappings":"AAKA,2BAA2B,GAC3B,OAAO,MAAMA,6BAAgE;IAC3EC,QAAQ;IACRC,cAAc;IACdC,OAAO;IACPC,aAAa;IACbC,WAAW;IACXC,MAAM;IACNC,YAAY;AACd,EAAE;AAEF,2BAA2B,GAC3B,OAAO,MAAMC,0BAAuD;IAClEL,OAAO;IACPG,MAAM;AACR,EAAE;AAEF,2BAA2B,GAC3B,OAAO,MAAMG,wBAAwB,KAAK;AAC1C,2BAA2B,GAC3B,OAAO,MAAMC,4BAA4B,KAAK;AAE9C,2BAA2B,GAC3B,OAAO,MAAMC,0BAA0B,SAAS;AAChD,2BAA2B,GAC3B,OAAO,MAAMC,gCAAgC,WAAW;AACxD,2BAA2B,GAC3B,OAAO,MAAMC,yBAAyB,GAAG;AACzC,2BAA2B,GAC3B,OAAO,MAAMC,2BAA2B,QAAQ;AAEhD;;;CAGC,GACD,OAAO,MAAMC,sBAAsB,wBAAwB"}
+{"version":3,"sources":["../../src/tooltip/constants.ts"],"sourcesContent":["import type {\n  CSSTransitionClassNames,\n  TransitionTimeout,\n} from \"../transition/types.js\";\n\n/** @since 2.0.0 */\nexport const DEFAULT_TOOLTIP_CLASSNAMES: Readonly<CSSTransitionClassNames> = {\n  appear: \"rmd-tooltip--enter\",\n  appearActive: \"rmd-tooltip--visible\",\n  enter: \"rmd-tooltip--enter\",\n  enterActive: \"rmd-tooltip--visible\",\n  enterDone: \"rmd-tooltip--visible\",\n  exit: \"rmd-tooltip--visible rmd-tooltip--exit\",\n  exitActive: \"rmd-tooltip--exit-active\",\n};\n\n/** @since 2.0.0 */\nexport const DEFAULT_TOOLTIP_TIMEOUT: Readonly<TransitionTimeout> = {\n  enter: 200,\n  exit: 150,\n};\n\n/** @since 2.0.0 */\nexport const DEFAULT_TOOLTIP_DELAY = 1000;\n/** @since 2.0.0 */\nexport const DEFAULT_TOOLTIP_THRESHOLD = 0.75;\n\n/** @since 2.8.0 */\nexport const DEFAULT_TOOLTIP_SPACING = \"1.5rem\";\n/** @since 2.8.0 */\nexport const DEFAULT_TOOLTIP_DENSE_SPACING = \"0.875rem\";\n/** @since 2.8.0 */\nexport const DEFAULT_TOOLTIP_MARGIN = 16;\n/** @since 2.8.0 */\nexport const DEFAULT_TOOLTIP_POSITION = \"below\";\n\n/**\n * @internal\n * @since 2.8.0\n */\nexport const TOOLTIP_SPACING_VAR = \"--rmd-tooltip-spacing\";\n"],"names":["DEFAULT_TOOLTIP_CLASSNAMES","appear","appearActive","enter","enterActive","enterDone","exit","exitActive","DEFAULT_TOOLTIP_TIMEOUT","DEFAULT_TOOLTIP_DELAY","DEFAULT_TOOLTIP_THRESHOLD","DEFAULT_TOOLTIP_SPACING","DEFAULT_TOOLTIP_DENSE_SPACING","DEFAULT_TOOLTIP_MARGIN","DEFAULT_TOOLTIP_POSITION","TOOLTIP_SPACING_VAR"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;","mappings":"AAKA,iBAAiB,GACjB,OAAO,MAAMA,6BAAgE;IAC3EC,QAAQ;IACRC,cAAc;IACdC,OAAO;IACPC,aAAa;IACbC,WAAW;IACXC,MAAM;IACNC,YAAY;AACd,EAAE;AAEF,iBAAiB,GACjB,OAAO,MAAMC,0BAAuD;IAClEL,OAAO;IACPG,MAAM;AACR,EAAE;AAEF,iBAAiB,GACjB,OAAO,MAAMG,wBAAwB,KAAK;AAC1C,iBAAiB,GACjB,OAAO,MAAMC,4BAA4B,KAAK;AAE9C,iBAAiB,GACjB,OAAO,MAAMC,0BAA0B,SAAS;AAChD,iBAAiB,GACjB,OAAO,MAAMC,gCAAgC,WAAW;AACxD,iBAAiB,GACjB,OAAO,MAAMC,yBAAyB,GAAG;AACzC,iBAAiB,GACjB,OAAO,MAAMC,2BAA2B,QAAQ;AAEhD;;;CAGC,GACD,OAAO,MAAMC,sBAAsB,wBAAwB"}

package/dist/tooltip/tooltipStyles.d.ts

@@ -1,7 +1,7 @@
 import { type TextOverflow } from "../cssUtils.js";
 import type { SimplePosition } from "../positioning/types.js";
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface TooltipClassNameOptions {
     className?: string;
@@ -10,6 +10,6 @@ export interface TooltipClassNameOptions {
     textOverflow?: TextOverflow;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare function tooltip(options: TooltipClassNameOptions): string;

package/dist/tooltip/tooltipStyles.js

@@ -3,7 +3,7 @@ import { cssUtils } from "../cssUtils.js";
 import { bem } from "../utils/bem.js";
 const styles = bem("rmd-tooltip");
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export function tooltip(options) {
     const { dense, position, className, textOverflow } = options;
     return cnb(styles({

package/dist/tooltip/tooltipStyles.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/tooltip/tooltipStyles.ts"],"sourcesContent":["import { cnb } from \"cnbuilder\";\nimport { cssUtils, type TextOverflow } from \"../cssUtils.js\";\nimport type { SimplePosition } from \"../positioning/types.js\";\nimport { bem } from \"../utils/bem.js\";\n\nconst styles = bem(\"rmd-tooltip\");\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport interface TooltipClassNameOptions {\n  className?: string;\n  dense?: boolean;\n  position: SimplePosition;\n  textOverflow?: TextOverflow;\n}\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport function tooltip(options: TooltipClassNameOptions): string {\n  const { dense, position, className, textOverflow } = options;\n\n  return cnb(\n    styles({\n      dense,\n      [position]: true,\n    }),\n    cssUtils({ textOverflow }),\n    className\n  );\n}\n"],"names":["cnb","cssUtils","bem","styles","tooltip","options","dense","position","className","textOverflow"],"rangeMappings":";;;;;;;;;;;;;;","mappings":"AAAA,SAASA,GAAG,QAAQ,YAAY;AAChC,SAASC,QAAQ,QAA2B,iBAAiB;AAE7D,SAASC,GAAG,QAAQ,kBAAkB;AAEtC,MAAMC,SAASD,IAAI;AAYnB;;CAEC,GACD,OAAO,SAASE,QAAQC,OAAgC;IACtD,MAAM,EAAEC,KAAK,EAAEC,QAAQ,EAAEC,SAAS,EAAEC,YAAY,EAAE,GAAGJ;IAErD,OAAOL,IACLG,OAAO;QACLG;QACA,CAACC,SAAS,EAAE;IACd,IACAN,SAAS;QAAEQ;IAAa,IACxBD;AAEJ"}
+{"version":3,"sources":["../../src/tooltip/tooltipStyles.ts"],"sourcesContent":["import { cnb } from \"cnbuilder\";\nimport { cssUtils, type TextOverflow } from \"../cssUtils.js\";\nimport type { SimplePosition } from \"../positioning/types.js\";\nimport { bem } from \"../utils/bem.js\";\n\nconst styles = bem(\"rmd-tooltip\");\n\n/**\n * @since 6.0.0\n */\nexport interface TooltipClassNameOptions {\n  className?: string;\n  dense?: boolean;\n  position: SimplePosition;\n  textOverflow?: TextOverflow;\n}\n\n/**\n * @since 6.0.0\n */\nexport function tooltip(options: TooltipClassNameOptions): string {\n  const { dense, position, className, textOverflow } = options;\n\n  return cnb(\n    styles({\n      dense,\n      [position]: true,\n    }),\n    cssUtils({ textOverflow }),\n    className\n  );\n}\n"],"names":["cnb","cssUtils","bem","styles","tooltip","options","dense","position","className","textOverflow"],"rangeMappings":";;;;;;;;;;;;;;","mappings":"AAAA,SAASA,GAAG,QAAQ,YAAY;AAChC,SAASC,QAAQ,QAA2B,iBAAiB;AAE7D,SAASC,GAAG,QAAQ,kBAAkB;AAEtC,MAAMC,SAASD,IAAI;AAYnB;;CAEC,GACD,OAAO,SAASE,QAAQC,OAAgC;IACtD,MAAM,EAAEC,KAAK,EAAEC,QAAQ,EAAEC,SAAS,EAAEC,YAAY,EAAE,GAAGJ;IAErD,OAAOL,IACLG,OAAO;QACLG;QACA,CAACC,SAAS,EAAE;IACd,IACAN,SAAS;QAAEQ;IAAa,IACxBD;AAEJ"}

package/dist/tooltip/useTooltip.d.ts

@@ -12,7 +12,7 @@ declare module "react" {
         "--rmd-tooltip-spacing"?: string | number;
     }
 }
-/** @remarks \@since 2.8.0 */
+/** @since 2.8.0 */
 export interface TooltipPositioningOptions {
     style?: CSSProperties;
     /**
@@ -49,9 +49,8 @@ export interface TooltipPositioningOptions {
     disableAutoSpacing?: boolean;
 }
 /**
- * @remarks
- * \@since 2.8.0
- * \@since 6.0.0 Removed the `TooltipTouchEventHandlers` and
+ * @since 2.8.0
+ * @since 6.0.0 Removed the `TooltipTouchEventHandlers` and
  * `TooltipKeyboardEventHandlers` types, removed the need for the `onKeyDown`
  * event.
  */
@@ -64,15 +63,14 @@ export interface TooltippedElementEventHandlers<E extends HTMLElement = HTMLButt
     onTouchEnd?(event: TouchEvent<E>): void;
     onContextMenu?(event: MouseEvent<E>): void;
 }
-/** @remarks \@since 2.8.0 */
+/** @since 2.8.0 */
 export interface ProvidedTooltippedElementProps<E extends HTMLElement> extends Required<TooltippedElementEventHandlers<E>> {
     "aria-describedby": string | undefined;
     id: string;
 }
 /**
- * @remarks
- * \@since 2.8.0
- * \@since 6.0.0 A major API change for the hover mode behavior and no longer
+ * @since 2.8.0
+ * @since 6.0.0 A major API change for the hover mode behavior and no longer
  * requires a `baseId`/`id` for the tooltip. Also renamed from
  * `TooltipHookOptions` to `TooltipOptions` to match other hook naming
  * conventions.
@@ -95,8 +93,7 @@ export interface TooltipOptions<TooltippedElement extends HTMLElement = HTMLButt
      * should be set to `true` when your component might not have a tooltip associated
      * with it.
      *
-     * @example
-     * Real World Example
+     * @example Real World Example
      * ```tsx
      * import { Button, ButtonProps, Tooltip, useTooltip  } from "@react-md/core";
      * import type { ReactElement, ReactNode } from "react";
@@ -142,7 +139,7 @@ export interface TooltipOptions<TooltippedElement extends HTMLElement = HTMLButt
      * ```
      *
      * @defaultValue `false`
-     * @remarks \@since 5.1.0
+     * @since 5.1.0
      */
     disabled?: boolean;
     /**
@@ -170,14 +167,13 @@ export interface TooltipOptions<TooltippedElement extends HTMLElement = HTMLButt
      * `event .currentTarget` or `overflowRef` has text overflow.
      *
      * @defaultValue `false`
-     * @remarks \@since 6.0.0
+     * @since 6.0.0
      */
     overflowOnly?: boolean;
 }
 /**
- * @remarks
- * \@since 2.8.0
- * \@since 6.0.0 This was renamed from `TooltipHookProvidedTooltipProps`
+ * @since 2.8.0
+ * @since 6.0.0 This was renamed from `TooltipHookProvidedTooltipProps`
  */
 export interface ProvidedTooltipProps<E extends HTMLElement = HTMLSpanElement> extends Required<FixedPositioningTransitionCallbacks> {
     id: string;
@@ -188,9 +184,8 @@ export interface ProvidedTooltipProps<E extends HTMLElement = HTMLSpanElement> e
     position: SimplePosition;
 }
 /**
- * @remarks
- * \@since 2.8.0
- * \@since 6.0.0 No longer returns any properties from the hover mode provider
+ * @since 2.8.0
+ * @since 6.0.0 No longer returns any properties from the hover mode provider
  * because of the major API change to hover mode.. Also renamed from
  * `TooltipHookReturnValue` to `TooltipImplementation` to match other hook
  * naming conventions.
@@ -208,13 +203,12 @@ export interface TooltipImplementation<TooltippedElement extends HTMLElement = H
      */
     hideTooltip(): void;
     /**
-     * @remarks \@since 6.0.0
+     * @since 6.0.0
      */
     overflowRef: RefObject<HTMLElement>;
 }
 /**
- * @example
- * Simple Usage
+ * @example Simple Usage
  * ```tsx
  * import { Button, useTooltip, Tooltip } from "@react-md/core";
  *
@@ -232,8 +226,7 @@ export interface TooltipImplementation<TooltippedElement extends HTMLElement = H
  * }
  * ```
  *
- * @example
- * Overflow-only Tooltips
+ * @example Overflow-only Tooltips
  * ```tsx
  * import {
  *   cssUtils,
@@ -293,9 +286,8 @@ export interface TooltipImplementation<TooltippedElement extends HTMLElement = H
  * The tooltip will now remain visible allowing you to find it within the
  * "Inspector" tab in the dev tools.
  *
- * @remarks
- * \@since 2.8.0
- * \@since 6.0.0 Uses a separate `TooltipHoverModeProvider`.
+ * @since 2.8.0
+ * @since 6.0.0 Uses a separate `TooltipHoverModeProvider`.
  *
  * TODO: I need to fix the tooltip for click events and history changes since
  * the mouseleave event will not be correctly bubbled if hovering a child

package/dist/tooltip/useTooltip.js

@@ -14,8 +14,7 @@ const noop = ()=>{
 // do nothing
 };
 /**
- * @example
- * Simple Usage
+ * @example Simple Usage
  * ```tsx
  * import { Button, useTooltip, Tooltip } from "@react-md/core";
  *
@@ -33,8 +32,7 @@ const noop = ()=>{
  * }
  * ```
  *
- * @example
- * Overflow-only Tooltips
+ * @example Overflow-only Tooltips
  * ```tsx
  * import {
  *   cssUtils,
@@ -94,9 +92,8 @@ const noop = ()=>{
  * The tooltip will now remain visible allowing you to find it within the
  * "Inspector" tab in the dev tools.
  *
- * @remarks
- * \@since 2.8.0
- * \@since 6.0.0 Uses a separate `TooltipHoverModeProvider`.
+ * @since 2.8.0
+ * @since 6.0.0 Uses a separate `TooltipHoverModeProvider`.
  *
  * TODO: I need to fix the tooltip for click events and history changes since
  * the mouseleave event will not be correctly bubbled if hovering a child

package/dist/tooltip/useTooltip.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/tooltip/useTooltip.ts"],"sourcesContent":["\"use client\";\nimport { cnb } from \"cnbuilder\";\nimport type {\n  CSSProperties,\n  FocusEvent,\n  MouseEvent,\n  MutableRefObject,\n  Ref,\n  RefObject,\n  TouchEvent,\n} from \"react\";\nimport { useCallback, useEffect, useId, useRef } from \"react\";\nimport {\n  useHoverMode,\n  type ControlledHoverModeImplementation,\n} from \"../hoverMode/useHoverMode.js\";\nimport type { UserInteractionMode } from \"../interaction/UserInteractionModeProvider.js\";\nimport { useUserInteractionMode } from \"../interaction/UserInteractionModeProvider.js\";\nimport type { SimplePosition } from \"../positioning/types.js\";\nimport type { FixedPositioningTransitionCallbacks } from \"../positioning/useFixedPositioning.js\";\nimport { useFixedPositioning } from \"../positioning/useFixedPositioning.js\";\nimport type { UseStateSetter } from \"../types.js\";\nimport { usePageInactive } from \"../usePageInactive.js\";\nimport { parseCssLengthUnit } from \"../utils/parseCssLengthUnit.js\";\nimport { useTooltipHoverMode } from \"./TooltipHoverModeProvider.js\";\nimport {\n  DEFAULT_TOOLTIP_DENSE_SPACING,\n  DEFAULT_TOOLTIP_MARGIN,\n  DEFAULT_TOOLTIP_POSITION,\n  DEFAULT_TOOLTIP_SPACING,\n  DEFAULT_TOOLTIP_THRESHOLD,\n  TOOLTIP_SPACING_VAR,\n} from \"./constants.js\";\nimport type { TooltipPositionHookOptions } from \"./useTooltipPosition.js\";\nimport { useTooltipPosition } from \"./useTooltipPosition.js\";\nimport { getAnchor } from \"./utils.js\";\n\ndeclare module \"react\" {\n  interface CSSProperties {\n    \"--rmd-tooltip-background-color\"?: string;\n    \"--rmd-tooltip-color\"?: string;\n    \"--rmd-tooltip-spacing\"?: string | number;\n  }\n}\n\nconst noop = (): void => {\n  // do nothing\n};\n\n/** @remarks \\@since 2.8.0 */\nexport interface TooltipPositioningOptions {\n  style?: CSSProperties;\n\n  /**\n   * @defaultValue `DEFAULT_TOOLTIP_MARGIN`\n   * @see {@link DEFAULT_TOOLTIP_MARGIN}\n   */\n  vwMargin?: number;\n\n  /**\n   * @defaultValue `DEFAULT_TOOLTIP_MARGIN`\n   * @see {@link DEFAULT_TOOLTIP_MARGIN}\n   */\n  vhMargin?: number;\n\n  /**\n   * @defaultValue `false`\n   */\n  dense?: boolean;\n\n  /**\n   * @defaultValue `DEFAULT_TOOLTIP_SPACING`\n   * @see {@link DEFAULT_TOOLTIP_SPACING}\n   */\n  spacing?: number | string;\n\n  /**\n   * @defaultValue `DEFAULT_TOOLTIP_DENSE_SPACING`\n   * @see {@link DEFAULT_TOOLTIP_DENSE_SPACING}\n   */\n  denseSpacing?: number | string;\n\n  /**\n   * @defaultValue `false`\n   */\n  disableSwapping?: boolean;\n\n  /**\n   * @defaultValue `false`\n   */\n  disableAutoSpacing?: boolean;\n}\n\n/**\n * @remarks\n * \\@since 2.8.0\n * \\@since 6.0.0 Removed the `TooltipTouchEventHandlers` and\n * `TooltipKeyboardEventHandlers` types, removed the need for the `onKeyDown`\n * event.\n */\nexport interface TooltippedElementEventHandlers<\n  E extends HTMLElement = HTMLButtonElement,\n> {\n  onBlur?(event: FocusEvent<E>): void;\n  onFocus?(event: FocusEvent<E>): void;\n  onMouseEnter?(event: MouseEvent<E>): void;\n  onMouseLeave?(event: MouseEvent<E>): void;\n  onTouchStart?(event: TouchEvent<E>): void;\n  onTouchEnd?(event: TouchEvent<E>): void;\n  onContextMenu?(event: MouseEvent<E>): void;\n}\n\n/** @remarks \\@since 2.8.0 */\nexport interface ProvidedTooltippedElementProps<E extends HTMLElement>\n  extends Required<TooltippedElementEventHandlers<E>> {\n  \"aria-describedby\": string | undefined;\n  id: string;\n}\n\n/**\n * @remarks\n * \\@since 2.8.0\n * \\@since 6.0.0 A major API change for the hover mode behavior and no longer\n * requires a `baseId`/`id` for the tooltip. Also renamed from\n * `TooltipHookOptions` to `TooltipOptions` to match other hook naming\n * conventions.\n */\nexport interface TooltipOptions<\n  TooltippedElement extends HTMLElement = HTMLButtonElement,\n> extends FixedPositioningTransitionCallbacks,\n    TooltippedElementEventHandlers<TooltippedElement>,\n    TooltipPositioningOptions,\n    TooltipPositionHookOptions {\n  /**\n   * @defaultValue `\"tooltip-\" + useId()`\n   */\n  id?: string;\n\n  /**\n   * An optional override for the `aria-describedby`\n   */\n  describedBy?: string;\n\n  /**\n   * Any styles to be merged with the fixed positioning styles for the tooltip.\n   */\n  style?: CSSProperties;\n\n  /**\n   * Boolean if the event handlers should no longer attempt to show a tooltip. This\n   * should be set to `true` when your component might not have a tooltip associated\n   * with it.\n   *\n   * @example\n   * Real World Example\n   * ```tsx\n   * import { Button, ButtonProps, Tooltip, useTooltip  } from \"@react-md/core\";\n   * import type { ReactElement, ReactNode } from \"react\";\n   *\n   * export interface TooltippedButtonProps extends ButtonProps {\n   *   tooltip?: ReactNode;\n   * }\n   *\n   * export function TooltippedButton({\n   *   id,\n   *   tooltip,\n   *   children,\n   *   onBlur,\n   *   onFocus,\n   *   onMouseEnter,\n   *   onMouseLeave,\n   *   onTouchStart,\n   *   onTouchEnd,\n   *   onContextMenu,\n   *   ...props\n   * }: TooltippedButtonProps): ReactElement {\n   *   const { elementProps, tooltipProps } = useTooltip({\n   *     id,\n   *     disabled: !tooltip,\n   *     onBlur,\n   *     onFocus,\n   *     onMouseEnter,\n   *     onMouseLeave,\n   *     onTouchStart,\n   *     onTouchEnd,\n   *     onContextMenu,\n   *   });\n   *\n   *   return (\n   *     <>\n   *       <Button {...props} {...elementProps}>\n   *         {children}\n   *       </Button>\n   *       <Tooltip {...tooltipProps}>{tooltip}</Tooltip>\n   *     </>\n   *   );\n   * }\n   * ```\n   *\n   * @defaultValue `false`\n   * @remarks \\@since 5.1.0\n   */\n  disabled?: boolean;\n\n  /**\n   * The amount of time (in ms) to hover an element before the tooltip becomes\n   * visible.\n   *\n   * The default value is really the current hover timeout from the\n   * `TooltipHoverModeProvider`.\n   *\n   * @defaultValue `DEFAULT_TOOLTIP_DELAY`\n   */\n  hoverTimeout?: number;\n\n  /**\n   * The amount of time to wait before triggering the exit animation for the\n   * tooltip.\n   *\n   * The default value is really the current leaveTimeout timeout from the\n   * `TooltipHoverModeProvider`.\n   *\n   * @defaultValue `0`\n   */\n  leaveTimeout?: number;\n\n  /**\n   * Set this to `true` to only allow the tooltip to become visible when the\n   * `event .currentTarget` or `overflowRef` has text overflow.\n   *\n   * @defaultValue `false`\n   * @remarks \\@since 6.0.0\n   */\n  overflowOnly?: boolean;\n}\n\n/**\n * @remarks\n * \\@since 2.8.0\n * \\@since 6.0.0 This was renamed from `TooltipHookProvidedTooltipProps`\n */\nexport interface ProvidedTooltipProps<E extends HTMLElement = HTMLSpanElement>\n  extends Required<FixedPositioningTransitionCallbacks> {\n  id: string;\n  ref: Ref<E>;\n  dense: boolean;\n  style: CSSProperties;\n  visible: boolean;\n  position: SimplePosition;\n}\n\n/**\n * @remarks\n * \\@since 2.8.0\n * \\@since 6.0.0 No longer returns any properties from the hover mode provider\n * because of the major API change to hover mode.. Also renamed from\n * `TooltipHookReturnValue` to `TooltipImplementation` to match other hook\n * naming conventions.\n */\nexport interface TooltipImplementation<\n  TooltippedElement extends HTMLElement = HTMLButtonElement,\n  TooltipElement extends HTMLElement = HTMLSpanElement,\n> extends ControlledHoverModeImplementation {\n  visible: boolean;\n  setVisible: UseStateSetter<boolean>;\n  animatedOnce: boolean;\n  initiatedBy: MutableRefObject<UserInteractionMode | null>;\n  elementProps: ProvidedTooltippedElementProps<TooltippedElement>;\n  tooltipProps: ProvidedTooltipProps<TooltipElement>;\n\n  /**\n   * This is a wrapper around the {@link setVisible} behavior that will also\n   * clear any pending timeouts.\n   */\n  hideTooltip(): void;\n\n  /**\n   * @remarks \\@since 6.0.0\n   */\n  overflowRef: RefObject<HTMLElement>;\n}\n\n/**\n * @example\n * Simple Usage\n * ```tsx\n * import { Button, useTooltip, Tooltip } from \"@react-md/core\";\n *\n * function Example() {\n *   const { elementProps, tooltipProps } = useTooltip();\n *\n *   return (\n *     <>\n *       <Button {...elementProps}>Button</Button>\n *       <Tooltip {...tooltipProps}>\n *         Tooltip Content\n *       </Tooltip>\n *     </>\n *   );\n * }\n * ```\n *\n * @example\n * Overflow-only Tooltips\n * ```tsx\n * import {\n *   cssUtils,\n *   Link,\n *   Tooltip,\n *   useTooltip,\n *   type LinkProps,\n * } from \"@react-md/core\";\n * import { type ReactElement } from \"react\";\n *\n * function NavigationLink(props: LinkProps): ReactElement {\n *   const { children, ...remaining } = props;\n *\n *   // using the `overflowRef` is optional and will default to the\n *   // `event.currentTarget` when `null`\n *   const { overflowRef, elementProps, tooltipProps } = useOverflowTooltip({\n *     // just to pass any event handlers\n *     ...remaining,\n *     overflowOnly: true,\n *   });\n *\n *   return (\n *     <Link {...remaining} {...elementProps} style={{ width: \"100%\" }}>\n *       <span ref={overflowRef} className={cssUtils({ textOverflow: \"ellipsis\" })}>\n *         {children}\n *       </span>\n *       <Tooltip {...tooltipProps}>\n *         {children}\n *       </Tooltip>\n *     </Link>\n *   );\n * }\n *\n * function Example(): ReactElement {\n *   return (\n *     <div style={{ width: \"10rem\", overflow: \"auto\" }}>\n *       <NavigationLink href=\"/\">Home</NavigationLink>\n *       <NavigationLink href=\"/some-path\">\n *         Super long text that will be truncated with ellipsis and\n *         have a tooltip appear\n *       </NavigationLink>\n *     </div>\n *   );\n * }\n * ```\n *\n * ## Inspecting Tooltip Styles\n *\n * Since tooltips will disappear on blur, mouseleave, etc, it is a bit hard to\n * inspect the tooltip styles. In dev mode, you can manually set the visibility\n * to `true` through the dev tools.\n * - find your tooltip implementation\n * - expand the Tooltip hook\n * - expand the HoverMode hook\n * - set the first boolean state to `true`\n *\n * The tooltip will now remain visible allowing you to find it within the\n * \"Inspector\" tab in the dev tools.\n *\n * @remarks\n * \\@since 2.8.0\n * \\@since 6.0.0 Uses a separate `TooltipHoverModeProvider`.\n *\n * TODO: I need to fix the tooltip for click events and history changes since\n * the mouseleave event will not be correctly bubbled if hovering a child\n * element when the click or history update happens. this causes the tooltip to\n * stay visible\n */\nexport function useTooltip<\n  TooltippedElement extends HTMLElement = HTMLButtonElement,\n  TooltipElement extends HTMLElement = HTMLSpanElement,\n>(\n  options: TooltipOptions<TooltippedElement> = {}\n): TooltipImplementation<TooltippedElement, TooltipElement> {\n  const {\n    id: propId,\n    style: propStyle,\n    disabled = false,\n    describedBy,\n    dense = false,\n    hoverTimeout,\n    leaveTimeout,\n    vwMargin = DEFAULT_TOOLTIP_MARGIN,\n    vhMargin = DEFAULT_TOOLTIP_MARGIN,\n    spacing = DEFAULT_TOOLTIP_SPACING,\n    denseSpacing = DEFAULT_TOOLTIP_DENSE_SPACING,\n    disableSwapping,\n    disableAutoSpacing,\n    position: determinedPosition,\n    defaultPosition = DEFAULT_TOOLTIP_POSITION,\n    threshold = DEFAULT_TOOLTIP_THRESHOLD,\n    onBlur = noop,\n    onFocus = noop,\n    onMouseEnter = noop,\n    onMouseLeave = noop,\n    onTouchStart = noop,\n    onTouchEnd = noop,\n    onContextMenu = noop,\n    onEnter = noop,\n    onEntering,\n    onEntered = noop,\n    onExited,\n    overflowOnly,\n  } = options;\n\n  const fallbackId = useId();\n  const id = propId || fallbackId;\n  const tooltipId = `${id}-tooltip`;\n  const {\n    animatedOnceRef,\n    hoverTimeoutRef,\n    leaveTimeoutRef,\n    enableHoverMode,\n    disableHoverMode,\n    startDisableTimer,\n    clearDisableTimer,\n  } = useTooltipHoverMode();\n  const {\n    visible,\n    setVisible,\n    startShowFlow,\n    startHideFlow,\n    clearVisibilityTimeout,\n  } = useHoverMode({\n    hoverTimeout,\n    hoverTimeoutRef,\n    leaveTimeout,\n    leaveTimeoutRef,\n    enableHoverMode,\n    disableHoverMode,\n    startDisableTimer,\n    clearDisableTimer,\n  });\n  const [position, updatePosition] = useTooltipPosition({\n    position: determinedPosition,\n    defaultPosition,\n    threshold,\n  });\n\n  const mode = useUserInteractionMode();\n  const elementRef = useRef<HTMLElement | null>(null);\n  const tooltipRef = useRef<TooltipElement>(null);\n  const overflowRef = useRef<HTMLElement>(null);\n  const initiatedBy = useRef<UserInteractionMode | null>(null);\n  const { ref, style, callbacks } = useFixedPositioning({\n    nodeRef: tooltipRef,\n    style: propStyle,\n    fixedTo: elementRef,\n    anchor: getAnchor(position),\n    disableSwapping: disableSwapping ?? !!determinedPosition,\n    getFixedPositionOptions() {\n      let tooltipSpacing = dense ? denseSpacing : spacing;\n      const tooltip = tooltipRef.current;\n      if (!disableAutoSpacing && tooltip) {\n        tooltipSpacing =\n          window\n            .getComputedStyle(tooltip)\n            .getPropertyValue(TOOLTIP_SPACING_VAR) || spacing;\n      }\n\n      const currentSpacing = parseCssLengthUnit({\n        value: tooltipSpacing,\n      });\n      const horizontal = position === \"left\" || position === \"right\";\n\n      return {\n        vwMargin,\n        vhMargin,\n        xMargin: horizontal ? currentSpacing : undefined,\n        yMargin: horizontal ? undefined : currentSpacing,\n      };\n    },\n    onEnter(appearing) {\n      onEnter(appearing);\n\n      // This allows you to inspect the tooltip styles through the element\n      // inspector without first hovering or focusing the tooltipped element\n      // beforehand by setting the `HoverMode` hook to `true`\n      if (process.env.NODE_ENV !== \"production\" && !elementRef.current) {\n        elementRef.current = document.getElementById(id);\n      }\n    },\n    onEntering,\n    onEntered(appearing) {\n      onEntered(appearing);\n\n      animatedOnceRef.current = true;\n    },\n    onExited,\n  });\n\n  const hideTooltip = useCallback(() => {\n    initiatedBy.current = null;\n    disableHoverMode();\n    clearVisibilityTimeout();\n    setVisible(false);\n  }, [clearVisibilityTimeout, disableHoverMode, setVisible]);\n\n  useEffect(() => {\n    if (!visible) {\n      return;\n    }\n\n    const handleKeyDown = (event: KeyboardEvent): void => {\n      if (event.key === \"Escape\") {\n        hideTooltip();\n      }\n    };\n\n    window.addEventListener(\"keydown\", handleKeyDown);\n    window.addEventListener(\"scroll\", hideTooltip, true);\n    window.addEventListener(\"touchend\", hideTooltip, true);\n    return () => {\n      window.removeEventListener(\"keydown\", handleKeyDown);\n      window.removeEventListener(\"scroll\", hideTooltip, true);\n      window.removeEventListener(\"touchend\", hideTooltip, true);\n    };\n  }, [hideTooltip, visible]);\n\n  const refocusFrame = useRef(0);\n  const pageInactive = useRef(false);\n  usePageInactive({\n    disabled,\n    onDisabledCleanup: hideTooltip,\n    onChange(active) {\n      if (active) {\n        refocusFrame.current = window.requestAnimationFrame(() => {\n          pageInactive.current = false;\n        });\n        return;\n      }\n\n      pageInactive.current = true;\n      hideTooltip();\n    },\n  });\n\n  const isNotOverflown = (currentTarget: HTMLElement): boolean => {\n    if (!overflowOnly) {\n      return false;\n    }\n\n    const element = overflowRef.current || currentTarget;\n    return !element || element.offsetWidth >= element.scrollWidth;\n  };\n\n  return {\n    visible,\n    setVisible,\n    hideTooltip,\n    animatedOnce: animatedOnceRef.current,\n    initiatedBy,\n    overflowRef,\n    startShowFlow,\n    startHideFlow,\n    clearVisibilityTimeout,\n    tooltipProps: {\n      id: tooltipId,\n      ref,\n      dense,\n      style,\n      visible,\n      position,\n      ...callbacks,\n    },\n    elementProps: {\n      \"aria-describedby\": cnb(visible && tooltipId, describedBy) || undefined,\n      id,\n      onMouseEnter(event) {\n        onMouseEnter(event);\n        if (\n          disabled ||\n          mode === \"touch\" ||\n          initiatedBy.current !== null ||\n          isNotOverflown(event.currentTarget)\n        ) {\n          return;\n        }\n\n        initiatedBy.current = \"mouse\";\n        elementRef.current = event.currentTarget;\n        updatePosition(event.currentTarget);\n        startShowFlow(id);\n      },\n      onMouseLeave(event) {\n        onMouseLeave(event);\n        if (disabled || initiatedBy.current !== \"mouse\") {\n          return;\n        }\n\n        startHideFlow();\n        initiatedBy.current = null;\n      },\n      onBlur(event) {\n        onBlur(event);\n        if (disabled) {\n          return;\n        }\n\n        initiatedBy.current = null;\n        startHideFlow();\n      },\n      onFocus(event) {\n        onFocus(event);\n        // skip the focus events when the browser is re-focused if the user\n        // pressed alt-tab, minimized the browser, etc\n        if (\n          disabled ||\n          mode !== \"keyboard\" ||\n          initiatedBy.current !== null ||\n          pageInactive.current ||\n          isNotOverflown(event.currentTarget)\n        ) {\n          pageInactive.current = false;\n          return;\n        }\n\n        initiatedBy.current = \"keyboard\";\n        elementRef.current = event.currentTarget;\n        updatePosition(event.currentTarget);\n        startShowFlow(id);\n      },\n      onTouchStart(event) {\n        onTouchStart(event);\n        if (\n          disabled ||\n          initiatedBy.current !== null ||\n          isNotOverflown(event.currentTarget)\n        ) {\n          return;\n        }\n\n        initiatedBy.current = \"touch\";\n        elementRef.current = event.currentTarget;\n        updatePosition(event.currentTarget);\n        startShowFlow(id);\n      },\n      onTouchEnd(event) {\n        onTouchEnd(event);\n        if (disabled) {\n          return;\n        }\n\n        initiatedBy.current = null;\n        startHideFlow();\n      },\n      onContextMenu(event) {\n        onContextMenu(event);\n        if (\n          disabled ||\n          initiatedBy.current !== \"touch\" ||\n          isNotOverflown(event.currentTarget)\n        ) {\n          return;\n        }\n\n        event.preventDefault();\n        const selection = window.getSelection();\n        const node = selection?.anchorNode?.parentElement;\n        if (node && event.currentTarget.contains(node)) {\n          selection.empty();\n        }\n      },\n    },\n  };\n}\n"],"names":["cnb","useCallback","useEffect","useId","useRef","useHoverMode","useUserInteractionMode","useFixedPositioning","usePageInactive","parseCssLengthUnit","useTooltipHoverMode","DEFAULT_TOOLTIP_DENSE_SPACING","DEFAULT_TOOLTIP_MARGIN","DEFAULT_TOOLTIP_POSITION","DEFAULT_TOOLTIP_SPACING","DEFAULT_TOOLTIP_THRESHOLD","TOOLTIP_SPACING_VAR","useTooltipPosition","getAnchor","noop","useTooltip","options","id","propId","style","propStyle","disabled","describedBy","dense","hoverTimeout","leaveTimeout","vwMargin","vhMargin","spacing","denseSpacing","disableSwapping","disableAutoSpacing","position","determinedPosition","defaultPosition","threshold","onBlur","onFocus","onMouseEnter","onMouseLeave","onTouchStart","onTouchEnd","onContextMenu","onEnter","onEntering","onEntered","onExited","overflowOnly","fallbackId","tooltipId","animatedOnceRef","hoverTimeoutRef","leaveTimeoutRef","enableHoverMode","disableHoverMode","startDisableTimer","clearDisableTimer","visible","setVisible","startShowFlow","startHideFlow","clearVisibilityTimeout","updatePosition","mode","elementRef","tooltipRef","overflowRef","initiatedBy","ref","callbacks","nodeRef","fixedTo","anchor","getFixedPositionOptions","tooltipSpacing","tooltip","current","window","getComputedStyle","getPropertyValue","currentSpacing","value","horizontal","xMargin","undefined","yMargin","appearing","process","env","NODE_ENV","document","getElementById","hideTooltip","handleKeyDown","event","key","addEventListener","removeEventListener","refocusFrame","pageInactive","onDisabledCleanup","onChange","active","requestAnimationFrame","isNotOverflown","currentTarget","element","offsetWidth","scrollWidth","animatedOnce","tooltipProps","elementProps","preventDefault","selection","getSelection","node","anchorNode","parentElement","contains","empty"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;AACA,SAASA,GAAG,QAAQ,YAAY;AAUhC,SAASC,WAAW,EAAEC,SAAS,EAAEC,KAAK,EAAEC,MAAM,QAAQ,QAAQ;AAC9D,SACEC,YAAY,QAEP,+BAA+B;AAEtC,SAASC,sBAAsB,QAAQ,gDAAgD;AAGvF,SAASC,mBAAmB,QAAQ,wCAAwC;AAE5E,SAASC,eAAe,QAAQ,wBAAwB;AACxD,SAASC,kBAAkB,QAAQ,iCAAiC;AACpE,SAASC,mBAAmB,QAAQ,gCAAgC;AACpE,SACEC,6BAA6B,EAC7BC,sBAAsB,EACtBC,wBAAwB,EACxBC,uBAAuB,EACvBC,yBAAyB,EACzBC,mBAAmB,QACd,iBAAiB;AAExB,SAASC,kBAAkB,QAAQ,0BAA0B;AAC7D,SAASC,SAAS,QAAQ,aAAa;AAUvC,MAAMC,OAAO;AACX,aAAa;AACf;AA2OA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyFC,GACD,OAAO,SAASC,WAIdC,UAA6C,CAAC,CAAC;IAE/C,MAAM,EACJC,IAAIC,MAAM,EACVC,OAAOC,SAAS,EAChBC,WAAW,KAAK,EAChBC,WAAW,EACXC,QAAQ,KAAK,EACbC,YAAY,EACZC,YAAY,EACZC,WAAWnB,sBAAsB,EACjCoB,WAAWpB,sBAAsB,EACjCqB,UAAUnB,uBAAuB,EACjCoB,eAAevB,6BAA6B,EAC5CwB,eAAe,EACfC,kBAAkB,EAClBC,UAAUC,kBAAkB,EAC5BC,kBAAkB1B,wBAAwB,EAC1C2B,YAAYzB,yBAAyB,EACrC0B,SAAStB,IAAI,EACbuB,UAAUvB,IAAI,EACdwB,eAAexB,IAAI,EACnByB,eAAezB,IAAI,EACnB0B,eAAe1B,IAAI,EACnB2B,aAAa3B,IAAI,EACjB4B,gBAAgB5B,IAAI,EACpB6B,UAAU7B,IAAI,EACd8B,UAAU,EACVC,YAAY/B,IAAI,EAChBgC,QAAQ,EACRC,YAAY,EACb,GAAG/B;IAEJ,MAAMgC,aAAalD;IACnB,MAAMmB,KAAKC,UAAU8B;IACrB,MAAMC,YAAY,CAAC,EAAEhC,GAAG,QAAQ,CAAC;IACjC,MAAM,EACJiC,eAAe,EACfC,eAAe,EACfC,eAAe,EACfC,eAAe,EACfC,gBAAgB,EAChBC,iBAAiB,EACjBC,iBAAiB,EAClB,GAAGnD;IACJ,MAAM,EACJoD,OAAO,EACPC,UAAU,EACVC,aAAa,EACbC,aAAa,EACbC,sBAAsB,EACvB,GAAG7D,aAAa;QACfwB;QACA2B;QACA1B;QACA2B;QACAC;QACAC;QACAC;QACAC;IACF;IACA,MAAM,CAACxB,UAAU8B,eAAe,GAAGlD,mBAAmB;QACpDoB,UAAUC;QACVC;QACAC;IACF;IAEA,MAAM4B,OAAO9D;IACb,MAAM+D,aAAajE,OAA2B;IAC9C,MAAMkE,aAAalE,OAAuB;IAC1C,MAAMmE,cAAcnE,OAAoB;IACxC,MAAMoE,cAAcpE,OAAmC;IACvD,MAAM,EAAEqE,GAAG,EAAEjD,KAAK,EAAEkD,SAAS,EAAE,GAAGnE,oBAAoB;QACpDoE,SAASL;QACT9C,OAAOC;QACPmD,SAASP;QACTQ,QAAQ3D,UAAUmB;QAClBF,iBAAiBA,mBAAmB,CAAC,CAACG;QACtCwC;YACE,IAAIC,iBAAiBnD,QAAQM,eAAeD;YAC5C,MAAM+C,UAAUV,WAAWW,OAAO;YAClC,IAAI,CAAC7C,sBAAsB4C,SAAS;gBAClCD,iBACEG,OACGC,gBAAgB,CAACH,SACjBI,gBAAgB,CAACpE,wBAAwBiB;YAChD;YAEA,MAAMoD,iBAAiB5E,mBAAmB;gBACxC6E,OAAOP;YACT;YACA,MAAMQ,aAAalD,aAAa,UAAUA,aAAa;YAEvD,OAAO;gBACLN;gBACAC;gBACAwD,SAASD,aAAaF,iBAAiBI;gBACvCC,SAASH,aAAaE,YAAYJ;YACpC;QACF;QACArC,SAAQ2C,SAAS;YACf3C,QAAQ2C;YAER,oEAAoE;YACpE,sEAAsE;YACtE,uDAAuD;YACvD,IAAIC,QAAQC,GAAG,CAACC,QAAQ,KAAK,gBAAgB,CAACzB,WAAWY,OAAO,EAAE;gBAChEZ,WAAWY,OAAO,GAAGc,SAASC,cAAc,CAAC1E;YAC/C;QACF;QACA2B;QACAC,WAAUyC,SAAS;YACjBzC,UAAUyC;YAEVpC,gBAAgB0B,OAAO,GAAG;QAC5B;QACA9B;IACF;IAEA,MAAM8C,cAAchG,YAAY;QAC9BuE,YAAYS,OAAO,GAAG;QACtBtB;QACAO;QACAH,WAAW;IACb,GAAG;QAACG;QAAwBP;QAAkBI;KAAW;IAEzD7D,UAAU;QACR,IAAI,CAAC4D,SAAS;YACZ;QACF;QAEA,MAAMoC,gBAAgB,CAACC;YACrB,IAAIA,MAAMC,GAAG,KAAK,UAAU;gBAC1BH;YACF;QACF;QAEAf,OAAOmB,gBAAgB,CAAC,WAAWH;QACnChB,OAAOmB,gBAAgB,CAAC,UAAUJ,aAAa;QAC/Cf,OAAOmB,gBAAgB,CAAC,YAAYJ,aAAa;QACjD,OAAO;YACLf,OAAOoB,mBAAmB,CAAC,WAAWJ;YACtChB,OAAOoB,mBAAmB,CAAC,UAAUL,aAAa;YAClDf,OAAOoB,mBAAmB,CAAC,YAAYL,aAAa;QACtD;IACF,GAAG;QAACA;QAAanC;KAAQ;IAEzB,MAAMyC,eAAenG,OAAO;IAC5B,MAAMoG,eAAepG,OAAO;IAC5BI,gBAAgB;QACdkB;QACA+E,mBAAmBR;QACnBS,UAASC,MAAM;YACb,IAAIA,QAAQ;gBACVJ,aAAatB,OAAO,GAAGC,OAAO0B,qBAAqB,CAAC;oBAClDJ,aAAavB,OAAO,GAAG;gBACzB;gBACA;YACF;YAEAuB,aAAavB,OAAO,GAAG;YACvBgB;QACF;IACF;IAEA,MAAMY,iBAAiB,CAACC;QACtB,IAAI,CAAC1D,cAAc;YACjB,OAAO;QACT;QAEA,MAAM2D,UAAUxC,YAAYU,OAAO,IAAI6B;QACvC,OAAO,CAACC,WAAWA,QAAQC,WAAW,IAAID,QAAQE,WAAW;IAC/D;IAEA,OAAO;QACLnD;QACAC;QACAkC;QACAiB,cAAc3D,gBAAgB0B,OAAO;QACrCT;QACAD;QACAP;QACAC;QACAC;QACAiD,cAAc;YACZ7F,IAAIgC;YACJmB;YACA7C;YACAJ;YACAsC;YACAzB;YACA,GAAGqC,SAAS;QACd;QACA0C,cAAc;YACZ,oBAAoBpH,IAAI8D,WAAWR,WAAW3B,gBAAgB8D;YAC9DnE;YACAqB,cAAawD,KAAK;gBAChBxD,aAAawD;gBACb,IACEzE,YACA0C,SAAS,WACTI,YAAYS,OAAO,KAAK,QACxB4B,eAAeV,MAAMW,aAAa,GAClC;oBACA;gBACF;gBAEAtC,YAAYS,OAAO,GAAG;gBACtBZ,WAAWY,OAAO,GAAGkB,MAAMW,aAAa;gBACxC3C,eAAegC,MAAMW,aAAa;gBAClC9C,cAAc1C;YAChB;YACAsB,cAAauD,KAAK;gBAChBvD,aAAauD;gBACb,IAAIzE,YAAY8C,YAAYS,OAAO,KAAK,SAAS;oBAC/C;gBACF;gBAEAhB;gBACAO,YAAYS,OAAO,GAAG;YACxB;YACAxC,QAAO0D,KAAK;gBACV1D,OAAO0D;gBACP,IAAIzE,UAAU;oBACZ;gBACF;gBAEA8C,YAAYS,OAAO,GAAG;gBACtBhB;YACF;YACAvB,SAAQyD,KAAK;gBACXzD,QAAQyD;gBACR,mEAAmE;gBACnE,8CAA8C;gBAC9C,IACEzE,YACA0C,SAAS,cACTI,YAAYS,OAAO,KAAK,QACxBuB,aAAavB,OAAO,IACpB4B,eAAeV,MAAMW,aAAa,GAClC;oBACAN,aAAavB,OAAO,GAAG;oBACvB;gBACF;gBAEAT,YAAYS,OAAO,GAAG;gBACtBZ,WAAWY,OAAO,GAAGkB,MAAMW,aAAa;gBACxC3C,eAAegC,MAAMW,aAAa;gBAClC9C,cAAc1C;YAChB;YACAuB,cAAasD,KAAK;gBAChBtD,aAAasD;gBACb,IACEzE,YACA8C,YAAYS,OAAO,KAAK,QACxB4B,eAAeV,MAAMW,aAAa,GAClC;oBACA;gBACF;gBAEAtC,YAAYS,OAAO,GAAG;gBACtBZ,WAAWY,OAAO,GAAGkB,MAAMW,aAAa;gBACxC3C,eAAegC,MAAMW,aAAa;gBAClC9C,cAAc1C;YAChB;YACAwB,YAAWqD,KAAK;gBACdrD,WAAWqD;gBACX,IAAIzE,UAAU;oBACZ;gBACF;gBAEA8C,YAAYS,OAAO,GAAG;gBACtBhB;YACF;YACAlB,eAAcoD,KAAK;gBACjBpD,cAAcoD;gBACd,IACEzE,YACA8C,YAAYS,OAAO,KAAK,WACxB4B,eAAeV,MAAMW,aAAa,GAClC;oBACA;gBACF;gBAEAX,MAAMkB,cAAc;gBACpB,MAAMC,YAAYpC,OAAOqC,YAAY;gBACrC,MAAMC,OAAOF,WAAWG,YAAYC;gBACpC,IAAIF,QAAQrB,MAAMW,aAAa,CAACa,QAAQ,CAACH,OAAO;oBAC9CF,UAAUM,KAAK;gBACjB;YACF;QACF;IACF;AACF"}
+{"version":3,"sources":["../../src/tooltip/useTooltip.ts"],"sourcesContent":["\"use client\";\nimport { cnb } from \"cnbuilder\";\nimport type {\n  CSSProperties,\n  FocusEvent,\n  MouseEvent,\n  MutableRefObject,\n  Ref,\n  RefObject,\n  TouchEvent,\n} from \"react\";\nimport { useCallback, useEffect, useId, useRef } from \"react\";\nimport {\n  useHoverMode,\n  type ControlledHoverModeImplementation,\n} from \"../hoverMode/useHoverMode.js\";\nimport type { UserInteractionMode } from \"../interaction/UserInteractionModeProvider.js\";\nimport { useUserInteractionMode } from \"../interaction/UserInteractionModeProvider.js\";\nimport type { SimplePosition } from \"../positioning/types.js\";\nimport type { FixedPositioningTransitionCallbacks } from \"../positioning/useFixedPositioning.js\";\nimport { useFixedPositioning } from \"../positioning/useFixedPositioning.js\";\nimport type { UseStateSetter } from \"../types.js\";\nimport { usePageInactive } from \"../usePageInactive.js\";\nimport { parseCssLengthUnit } from \"../utils/parseCssLengthUnit.js\";\nimport { useTooltipHoverMode } from \"./TooltipHoverModeProvider.js\";\nimport {\n  DEFAULT_TOOLTIP_DENSE_SPACING,\n  DEFAULT_TOOLTIP_MARGIN,\n  DEFAULT_TOOLTIP_POSITION,\n  DEFAULT_TOOLTIP_SPACING,\n  DEFAULT_TOOLTIP_THRESHOLD,\n  TOOLTIP_SPACING_VAR,\n} from \"./constants.js\";\nimport type { TooltipPositionHookOptions } from \"./useTooltipPosition.js\";\nimport { useTooltipPosition } from \"./useTooltipPosition.js\";\nimport { getAnchor } from \"./utils.js\";\n\ndeclare module \"react\" {\n  interface CSSProperties {\n    \"--rmd-tooltip-background-color\"?: string;\n    \"--rmd-tooltip-color\"?: string;\n    \"--rmd-tooltip-spacing\"?: string | number;\n  }\n}\n\nconst noop = (): void => {\n  // do nothing\n};\n\n/** @since 2.8.0 */\nexport interface TooltipPositioningOptions {\n  style?: CSSProperties;\n\n  /**\n   * @defaultValue `DEFAULT_TOOLTIP_MARGIN`\n   * @see {@link DEFAULT_TOOLTIP_MARGIN}\n   */\n  vwMargin?: number;\n\n  /**\n   * @defaultValue `DEFAULT_TOOLTIP_MARGIN`\n   * @see {@link DEFAULT_TOOLTIP_MARGIN}\n   */\n  vhMargin?: number;\n\n  /**\n   * @defaultValue `false`\n   */\n  dense?: boolean;\n\n  /**\n   * @defaultValue `DEFAULT_TOOLTIP_SPACING`\n   * @see {@link DEFAULT_TOOLTIP_SPACING}\n   */\n  spacing?: number | string;\n\n  /**\n   * @defaultValue `DEFAULT_TOOLTIP_DENSE_SPACING`\n   * @see {@link DEFAULT_TOOLTIP_DENSE_SPACING}\n   */\n  denseSpacing?: number | string;\n\n  /**\n   * @defaultValue `false`\n   */\n  disableSwapping?: boolean;\n\n  /**\n   * @defaultValue `false`\n   */\n  disableAutoSpacing?: boolean;\n}\n\n/**\n * @since 2.8.0\n * @since 6.0.0 Removed the `TooltipTouchEventHandlers` and\n * `TooltipKeyboardEventHandlers` types, removed the need for the `onKeyDown`\n * event.\n */\nexport interface TooltippedElementEventHandlers<\n  E extends HTMLElement = HTMLButtonElement,\n> {\n  onBlur?(event: FocusEvent<E>): void;\n  onFocus?(event: FocusEvent<E>): void;\n  onMouseEnter?(event: MouseEvent<E>): void;\n  onMouseLeave?(event: MouseEvent<E>): void;\n  onTouchStart?(event: TouchEvent<E>): void;\n  onTouchEnd?(event: TouchEvent<E>): void;\n  onContextMenu?(event: MouseEvent<E>): void;\n}\n\n/** @since 2.8.0 */\nexport interface ProvidedTooltippedElementProps<E extends HTMLElement>\n  extends Required<TooltippedElementEventHandlers<E>> {\n  \"aria-describedby\": string | undefined;\n  id: string;\n}\n\n/**\n * @since 2.8.0\n * @since 6.0.0 A major API change for the hover mode behavior and no longer\n * requires a `baseId`/`id` for the tooltip. Also renamed from\n * `TooltipHookOptions` to `TooltipOptions` to match other hook naming\n * conventions.\n */\nexport interface TooltipOptions<\n  TooltippedElement extends HTMLElement = HTMLButtonElement,\n> extends FixedPositioningTransitionCallbacks,\n    TooltippedElementEventHandlers<TooltippedElement>,\n    TooltipPositioningOptions,\n    TooltipPositionHookOptions {\n  /**\n   * @defaultValue `\"tooltip-\" + useId()`\n   */\n  id?: string;\n\n  /**\n   * An optional override for the `aria-describedby`\n   */\n  describedBy?: string;\n\n  /**\n   * Any styles to be merged with the fixed positioning styles for the tooltip.\n   */\n  style?: CSSProperties;\n\n  /**\n   * Boolean if the event handlers should no longer attempt to show a tooltip. This\n   * should be set to `true` when your component might not have a tooltip associated\n   * with it.\n   *\n   * @example Real World Example\n   * ```tsx\n   * import { Button, ButtonProps, Tooltip, useTooltip  } from \"@react-md/core\";\n   * import type { ReactElement, ReactNode } from \"react\";\n   *\n   * export interface TooltippedButtonProps extends ButtonProps {\n   *   tooltip?: ReactNode;\n   * }\n   *\n   * export function TooltippedButton({\n   *   id,\n   *   tooltip,\n   *   children,\n   *   onBlur,\n   *   onFocus,\n   *   onMouseEnter,\n   *   onMouseLeave,\n   *   onTouchStart,\n   *   onTouchEnd,\n   *   onContextMenu,\n   *   ...props\n   * }: TooltippedButtonProps): ReactElement {\n   *   const { elementProps, tooltipProps } = useTooltip({\n   *     id,\n   *     disabled: !tooltip,\n   *     onBlur,\n   *     onFocus,\n   *     onMouseEnter,\n   *     onMouseLeave,\n   *     onTouchStart,\n   *     onTouchEnd,\n   *     onContextMenu,\n   *   });\n   *\n   *   return (\n   *     <>\n   *       <Button {...props} {...elementProps}>\n   *         {children}\n   *       </Button>\n   *       <Tooltip {...tooltipProps}>{tooltip}</Tooltip>\n   *     </>\n   *   );\n   * }\n   * ```\n   *\n   * @defaultValue `false`\n   * @since 5.1.0\n   */\n  disabled?: boolean;\n\n  /**\n   * The amount of time (in ms) to hover an element before the tooltip becomes\n   * visible.\n   *\n   * The default value is really the current hover timeout from the\n   * `TooltipHoverModeProvider`.\n   *\n   * @defaultValue `DEFAULT_TOOLTIP_DELAY`\n   */\n  hoverTimeout?: number;\n\n  /**\n   * The amount of time to wait before triggering the exit animation for the\n   * tooltip.\n   *\n   * The default value is really the current leaveTimeout timeout from the\n   * `TooltipHoverModeProvider`.\n   *\n   * @defaultValue `0`\n   */\n  leaveTimeout?: number;\n\n  /**\n   * Set this to `true` to only allow the tooltip to become visible when the\n   * `event .currentTarget` or `overflowRef` has text overflow.\n   *\n   * @defaultValue `false`\n   * @since 6.0.0\n   */\n  overflowOnly?: boolean;\n}\n\n/**\n * @since 2.8.0\n * @since 6.0.0 This was renamed from `TooltipHookProvidedTooltipProps`\n */\nexport interface ProvidedTooltipProps<E extends HTMLElement = HTMLSpanElement>\n  extends Required<FixedPositioningTransitionCallbacks> {\n  id: string;\n  ref: Ref<E>;\n  dense: boolean;\n  style: CSSProperties;\n  visible: boolean;\n  position: SimplePosition;\n}\n\n/**\n * @since 2.8.0\n * @since 6.0.0 No longer returns any properties from the hover mode provider\n * because of the major API change to hover mode.. Also renamed from\n * `TooltipHookReturnValue` to `TooltipImplementation` to match other hook\n * naming conventions.\n */\nexport interface TooltipImplementation<\n  TooltippedElement extends HTMLElement = HTMLButtonElement,\n  TooltipElement extends HTMLElement = HTMLSpanElement,\n> extends ControlledHoverModeImplementation {\n  visible: boolean;\n  setVisible: UseStateSetter<boolean>;\n  animatedOnce: boolean;\n  initiatedBy: MutableRefObject<UserInteractionMode | null>;\n  elementProps: ProvidedTooltippedElementProps<TooltippedElement>;\n  tooltipProps: ProvidedTooltipProps<TooltipElement>;\n\n  /**\n   * This is a wrapper around the {@link setVisible} behavior that will also\n   * clear any pending timeouts.\n   */\n  hideTooltip(): void;\n\n  /**\n   * @since 6.0.0\n   */\n  overflowRef: RefObject<HTMLElement>;\n}\n\n/**\n * @example Simple Usage\n * ```tsx\n * import { Button, useTooltip, Tooltip } from \"@react-md/core\";\n *\n * function Example() {\n *   const { elementProps, tooltipProps } = useTooltip();\n *\n *   return (\n *     <>\n *       <Button {...elementProps}>Button</Button>\n *       <Tooltip {...tooltipProps}>\n *         Tooltip Content\n *       </Tooltip>\n *     </>\n *   );\n * }\n * ```\n *\n * @example Overflow-only Tooltips\n * ```tsx\n * import {\n *   cssUtils,\n *   Link,\n *   Tooltip,\n *   useTooltip,\n *   type LinkProps,\n * } from \"@react-md/core\";\n * import { type ReactElement } from \"react\";\n *\n * function NavigationLink(props: LinkProps): ReactElement {\n *   const { children, ...remaining } = props;\n *\n *   // using the `overflowRef` is optional and will default to the\n *   // `event.currentTarget` when `null`\n *   const { overflowRef, elementProps, tooltipProps } = useOverflowTooltip({\n *     // just to pass any event handlers\n *     ...remaining,\n *     overflowOnly: true,\n *   });\n *\n *   return (\n *     <Link {...remaining} {...elementProps} style={{ width: \"100%\" }}>\n *       <span ref={overflowRef} className={cssUtils({ textOverflow: \"ellipsis\" })}>\n *         {children}\n *       </span>\n *       <Tooltip {...tooltipProps}>\n *         {children}\n *       </Tooltip>\n *     </Link>\n *   );\n * }\n *\n * function Example(): ReactElement {\n *   return (\n *     <div style={{ width: \"10rem\", overflow: \"auto\" }}>\n *       <NavigationLink href=\"/\">Home</NavigationLink>\n *       <NavigationLink href=\"/some-path\">\n *         Super long text that will be truncated with ellipsis and\n *         have a tooltip appear\n *       </NavigationLink>\n *     </div>\n *   );\n * }\n * ```\n *\n * ## Inspecting Tooltip Styles\n *\n * Since tooltips will disappear on blur, mouseleave, etc, it is a bit hard to\n * inspect the tooltip styles. In dev mode, you can manually set the visibility\n * to `true` through the dev tools.\n * - find your tooltip implementation\n * - expand the Tooltip hook\n * - expand the HoverMode hook\n * - set the first boolean state to `true`\n *\n * The tooltip will now remain visible allowing you to find it within the\n * \"Inspector\" tab in the dev tools.\n *\n * @since 2.8.0\n * @since 6.0.0 Uses a separate `TooltipHoverModeProvider`.\n *\n * TODO: I need to fix the tooltip for click events and history changes since\n * the mouseleave event will not be correctly bubbled if hovering a child\n * element when the click or history update happens. this causes the tooltip to\n * stay visible\n */\nexport function useTooltip<\n  TooltippedElement extends HTMLElement = HTMLButtonElement,\n  TooltipElement extends HTMLElement = HTMLSpanElement,\n>(\n  options: TooltipOptions<TooltippedElement> = {}\n): TooltipImplementation<TooltippedElement, TooltipElement> {\n  const {\n    id: propId,\n    style: propStyle,\n    disabled = false,\n    describedBy,\n    dense = false,\n    hoverTimeout,\n    leaveTimeout,\n    vwMargin = DEFAULT_TOOLTIP_MARGIN,\n    vhMargin = DEFAULT_TOOLTIP_MARGIN,\n    spacing = DEFAULT_TOOLTIP_SPACING,\n    denseSpacing = DEFAULT_TOOLTIP_DENSE_SPACING,\n    disableSwapping,\n    disableAutoSpacing,\n    position: determinedPosition,\n    defaultPosition = DEFAULT_TOOLTIP_POSITION,\n    threshold = DEFAULT_TOOLTIP_THRESHOLD,\n    onBlur = noop,\n    onFocus = noop,\n    onMouseEnter = noop,\n    onMouseLeave = noop,\n    onTouchStart = noop,\n    onTouchEnd = noop,\n    onContextMenu = noop,\n    onEnter = noop,\n    onEntering,\n    onEntered = noop,\n    onExited,\n    overflowOnly,\n  } = options;\n\n  const fallbackId = useId();\n  const id = propId || fallbackId;\n  const tooltipId = `${id}-tooltip`;\n  const {\n    animatedOnceRef,\n    hoverTimeoutRef,\n    leaveTimeoutRef,\n    enableHoverMode,\n    disableHoverMode,\n    startDisableTimer,\n    clearDisableTimer,\n  } = useTooltipHoverMode();\n  const {\n    visible,\n    setVisible,\n    startShowFlow,\n    startHideFlow,\n    clearVisibilityTimeout,\n  } = useHoverMode({\n    hoverTimeout,\n    hoverTimeoutRef,\n    leaveTimeout,\n    leaveTimeoutRef,\n    enableHoverMode,\n    disableHoverMode,\n    startDisableTimer,\n    clearDisableTimer,\n  });\n  const [position, updatePosition] = useTooltipPosition({\n    position: determinedPosition,\n    defaultPosition,\n    threshold,\n  });\n\n  const mode = useUserInteractionMode();\n  const elementRef = useRef<HTMLElement | null>(null);\n  const tooltipRef = useRef<TooltipElement>(null);\n  const overflowRef = useRef<HTMLElement>(null);\n  const initiatedBy = useRef<UserInteractionMode | null>(null);\n  const { ref, style, callbacks } = useFixedPositioning({\n    nodeRef: tooltipRef,\n    style: propStyle,\n    fixedTo: elementRef,\n    anchor: getAnchor(position),\n    disableSwapping: disableSwapping ?? !!determinedPosition,\n    getFixedPositionOptions() {\n      let tooltipSpacing = dense ? denseSpacing : spacing;\n      const tooltip = tooltipRef.current;\n      if (!disableAutoSpacing && tooltip) {\n        tooltipSpacing =\n          window\n            .getComputedStyle(tooltip)\n            .getPropertyValue(TOOLTIP_SPACING_VAR) || spacing;\n      }\n\n      const currentSpacing = parseCssLengthUnit({\n        value: tooltipSpacing,\n      });\n      const horizontal = position === \"left\" || position === \"right\";\n\n      return {\n        vwMargin,\n        vhMargin,\n        xMargin: horizontal ? currentSpacing : undefined,\n        yMargin: horizontal ? undefined : currentSpacing,\n      };\n    },\n    onEnter(appearing) {\n      onEnter(appearing);\n\n      // This allows you to inspect the tooltip styles through the element\n      // inspector without first hovering or focusing the tooltipped element\n      // beforehand by setting the `HoverMode` hook to `true`\n      if (process.env.NODE_ENV !== \"production\" && !elementRef.current) {\n        elementRef.current = document.getElementById(id);\n      }\n    },\n    onEntering,\n    onEntered(appearing) {\n      onEntered(appearing);\n\n      animatedOnceRef.current = true;\n    },\n    onExited,\n  });\n\n  const hideTooltip = useCallback(() => {\n    initiatedBy.current = null;\n    disableHoverMode();\n    clearVisibilityTimeout();\n    setVisible(false);\n  }, [clearVisibilityTimeout, disableHoverMode, setVisible]);\n\n  useEffect(() => {\n    if (!visible) {\n      return;\n    }\n\n    const handleKeyDown = (event: KeyboardEvent): void => {\n      if (event.key === \"Escape\") {\n        hideTooltip();\n      }\n    };\n\n    window.addEventListener(\"keydown\", handleKeyDown);\n    window.addEventListener(\"scroll\", hideTooltip, true);\n    window.addEventListener(\"touchend\", hideTooltip, true);\n    return () => {\n      window.removeEventListener(\"keydown\", handleKeyDown);\n      window.removeEventListener(\"scroll\", hideTooltip, true);\n      window.removeEventListener(\"touchend\", hideTooltip, true);\n    };\n  }, [hideTooltip, visible]);\n\n  const refocusFrame = useRef(0);\n  const pageInactive = useRef(false);\n  usePageInactive({\n    disabled,\n    onDisabledCleanup: hideTooltip,\n    onChange(active) {\n      if (active) {\n        refocusFrame.current = window.requestAnimationFrame(() => {\n          pageInactive.current = false;\n        });\n        return;\n      }\n\n      pageInactive.current = true;\n      hideTooltip();\n    },\n  });\n\n  const isNotOverflown = (currentTarget: HTMLElement): boolean => {\n    if (!overflowOnly) {\n      return false;\n    }\n\n    const element = overflowRef.current || currentTarget;\n    return !element || element.offsetWidth >= element.scrollWidth;\n  };\n\n  return {\n    visible,\n    setVisible,\n    hideTooltip,\n    animatedOnce: animatedOnceRef.current,\n    initiatedBy,\n    overflowRef,\n    startShowFlow,\n    startHideFlow,\n    clearVisibilityTimeout,\n    tooltipProps: {\n      id: tooltipId,\n      ref,\n      dense,\n      style,\n      visible,\n      position,\n      ...callbacks,\n    },\n    elementProps: {\n      \"aria-describedby\": cnb(visible && tooltipId, describedBy) || undefined,\n      id,\n      onMouseEnter(event) {\n        onMouseEnter(event);\n        if (\n          disabled ||\n          mode === \"touch\" ||\n          initiatedBy.current !== null ||\n          isNotOverflown(event.currentTarget)\n        ) {\n          return;\n        }\n\n        initiatedBy.current = \"mouse\";\n        elementRef.current = event.currentTarget;\n        updatePosition(event.currentTarget);\n        startShowFlow(id);\n      },\n      onMouseLeave(event) {\n        onMouseLeave(event);\n        if (disabled || initiatedBy.current !== \"mouse\") {\n          return;\n        }\n\n        startHideFlow();\n        initiatedBy.current = null;\n      },\n      onBlur(event) {\n        onBlur(event);\n        if (disabled) {\n          return;\n        }\n\n        initiatedBy.current = null;\n        startHideFlow();\n      },\n      onFocus(event) {\n        onFocus(event);\n        // skip the focus events when the browser is re-focused if the user\n        // pressed alt-tab, minimized the browser, etc\n        if (\n          disabled ||\n          mode !== \"keyboard\" ||\n          initiatedBy.current !== null ||\n          pageInactive.current ||\n          isNotOverflown(event.currentTarget)\n        ) {\n          pageInactive.current = false;\n          return;\n        }\n\n        initiatedBy.current = \"keyboard\";\n        elementRef.current = event.currentTarget;\n        updatePosition(event.currentTarget);\n        startShowFlow(id);\n      },\n      onTouchStart(event) {\n        onTouchStart(event);\n        if (\n          disabled ||\n          initiatedBy.current !== null ||\n          isNotOverflown(event.currentTarget)\n        ) {\n          return;\n        }\n\n        initiatedBy.current = \"touch\";\n        elementRef.current = event.currentTarget;\n        updatePosition(event.currentTarget);\n        startShowFlow(id);\n      },\n      onTouchEnd(event) {\n        onTouchEnd(event);\n        if (disabled) {\n          return;\n        }\n\n        initiatedBy.current = null;\n        startHideFlow();\n      },\n      onContextMenu(event) {\n        onContextMenu(event);\n        if (\n          disabled ||\n          initiatedBy.current !== \"touch\" ||\n          isNotOverflown(event.currentTarget)\n        ) {\n          return;\n        }\n\n        event.preventDefault();\n        const selection = window.getSelection();\n        const node = selection?.anchorNode?.parentElement;\n        if (node && event.currentTarget.contains(node)) {\n          selection.empty();\n        }\n      },\n    },\n  };\n}\n"],"names":["cnb","useCallback","useEffect","useId","useRef","useHoverMode","useUserInteractionMode","useFixedPositioning","usePageInactive","parseCssLengthUnit","useTooltipHoverMode","DEFAULT_TOOLTIP_DENSE_SPACING","DEFAULT_TOOLTIP_MARGIN","DEFAULT_TOOLTIP_POSITION","DEFAULT_TOOLTIP_SPACING","DEFAULT_TOOLTIP_THRESHOLD","TOOLTIP_SPACING_VAR","useTooltipPosition","getAnchor","noop","useTooltip","options","id","propId","style","propStyle","disabled","describedBy","dense","hoverTimeout","leaveTimeout","vwMargin","vhMargin","spacing","denseSpacing","disableSwapping","disableAutoSpacing","position","determinedPosition","defaultPosition","threshold","onBlur","onFocus","onMouseEnter","onMouseLeave","onTouchStart","onTouchEnd","onContextMenu","onEnter","onEntering","onEntered","onExited","overflowOnly","fallbackId","tooltipId","animatedOnceRef","hoverTimeoutRef","leaveTimeoutRef","enableHoverMode","disableHoverMode","startDisableTimer","clearDisableTimer","visible","setVisible","startShowFlow","startHideFlow","clearVisibilityTimeout","updatePosition","mode","elementRef","tooltipRef","overflowRef","initiatedBy","ref","callbacks","nodeRef","fixedTo","anchor","getFixedPositionOptions","tooltipSpacing","tooltip","current","window","getComputedStyle","getPropertyValue","currentSpacing","value","horizontal","xMargin","undefined","yMargin","appearing","process","env","NODE_ENV","document","getElementById","hideTooltip","handleKeyDown","event","key","addEventListener","removeEventListener","refocusFrame","pageInactive","onDisabledCleanup","onChange","active","requestAnimationFrame","isNotOverflown","currentTarget","element","offsetWidth","scrollWidth","animatedOnce","tooltipProps","elementProps","preventDefault","selection","getSelection","node","anchorNode","parentElement","contains","empty"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;AACA,SAASA,GAAG,QAAQ,YAAY;AAUhC,SAASC,WAAW,EAAEC,SAAS,EAAEC,KAAK,EAAEC,MAAM,QAAQ,QAAQ;AAC9D,SACEC,YAAY,QAEP,+BAA+B;AAEtC,SAASC,sBAAsB,QAAQ,gDAAgD;AAGvF,SAASC,mBAAmB,QAAQ,wCAAwC;AAE5E,SAASC,eAAe,QAAQ,wBAAwB;AACxD,SAASC,kBAAkB,QAAQ,iCAAiC;AACpE,SAASC,mBAAmB,QAAQ,gCAAgC;AACpE,SACEC,6BAA6B,EAC7BC,sBAAsB,EACtBC,wBAAwB,EACxBC,uBAAuB,EACvBC,yBAAyB,EACzBC,mBAAmB,QACd,iBAAiB;AAExB,SAASC,kBAAkB,QAAQ,0BAA0B;AAC7D,SAASC,SAAS,QAAQ,aAAa;AAUvC,MAAMC,OAAO;AACX,aAAa;AACf;AAsOA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsFC,GACD,OAAO,SAASC,WAIdC,UAA6C,CAAC,CAAC;IAE/C,MAAM,EACJC,IAAIC,MAAM,EACVC,OAAOC,SAAS,EAChBC,WAAW,KAAK,EAChBC,WAAW,EACXC,QAAQ,KAAK,EACbC,YAAY,EACZC,YAAY,EACZC,WAAWnB,sBAAsB,EACjCoB,WAAWpB,sBAAsB,EACjCqB,UAAUnB,uBAAuB,EACjCoB,eAAevB,6BAA6B,EAC5CwB,eAAe,EACfC,kBAAkB,EAClBC,UAAUC,kBAAkB,EAC5BC,kBAAkB1B,wBAAwB,EAC1C2B,YAAYzB,yBAAyB,EACrC0B,SAAStB,IAAI,EACbuB,UAAUvB,IAAI,EACdwB,eAAexB,IAAI,EACnByB,eAAezB,IAAI,EACnB0B,eAAe1B,IAAI,EACnB2B,aAAa3B,IAAI,EACjB4B,gBAAgB5B,IAAI,EACpB6B,UAAU7B,IAAI,EACd8B,UAAU,EACVC,YAAY/B,IAAI,EAChBgC,QAAQ,EACRC,YAAY,EACb,GAAG/B;IAEJ,MAAMgC,aAAalD;IACnB,MAAMmB,KAAKC,UAAU8B;IACrB,MAAMC,YAAY,CAAC,EAAEhC,GAAG,QAAQ,CAAC;IACjC,MAAM,EACJiC,eAAe,EACfC,eAAe,EACfC,eAAe,EACfC,eAAe,EACfC,gBAAgB,EAChBC,iBAAiB,EACjBC,iBAAiB,EAClB,GAAGnD;IACJ,MAAM,EACJoD,OAAO,EACPC,UAAU,EACVC,aAAa,EACbC,aAAa,EACbC,sBAAsB,EACvB,GAAG7D,aAAa;QACfwB;QACA2B;QACA1B;QACA2B;QACAC;QACAC;QACAC;QACAC;IACF;IACA,MAAM,CAACxB,UAAU8B,eAAe,GAAGlD,mBAAmB;QACpDoB,UAAUC;QACVC;QACAC;IACF;IAEA,MAAM4B,OAAO9D;IACb,MAAM+D,aAAajE,OAA2B;IAC9C,MAAMkE,aAAalE,OAAuB;IAC1C,MAAMmE,cAAcnE,OAAoB;IACxC,MAAMoE,cAAcpE,OAAmC;IACvD,MAAM,EAAEqE,GAAG,EAAEjD,KAAK,EAAEkD,SAAS,EAAE,GAAGnE,oBAAoB;QACpDoE,SAASL;QACT9C,OAAOC;QACPmD,SAASP;QACTQ,QAAQ3D,UAAUmB;QAClBF,iBAAiBA,mBAAmB,CAAC,CAACG;QACtCwC;YACE,IAAIC,iBAAiBnD,QAAQM,eAAeD;YAC5C,MAAM+C,UAAUV,WAAWW,OAAO;YAClC,IAAI,CAAC7C,sBAAsB4C,SAAS;gBAClCD,iBACEG,OACGC,gBAAgB,CAACH,SACjBI,gBAAgB,CAACpE,wBAAwBiB;YAChD;YAEA,MAAMoD,iBAAiB5E,mBAAmB;gBACxC6E,OAAOP;YACT;YACA,MAAMQ,aAAalD,aAAa,UAAUA,aAAa;YAEvD,OAAO;gBACLN;gBACAC;gBACAwD,SAASD,aAAaF,iBAAiBI;gBACvCC,SAASH,aAAaE,YAAYJ;YACpC;QACF;QACArC,SAAQ2C,SAAS;YACf3C,QAAQ2C;YAER,oEAAoE;YACpE,sEAAsE;YACtE,uDAAuD;YACvD,IAAIC,QAAQC,GAAG,CAACC,QAAQ,KAAK,gBAAgB,CAACzB,WAAWY,OAAO,EAAE;gBAChEZ,WAAWY,OAAO,GAAGc,SAASC,cAAc,CAAC1E;YAC/C;QACF;QACA2B;QACAC,WAAUyC,SAAS;YACjBzC,UAAUyC;YAEVpC,gBAAgB0B,OAAO,GAAG;QAC5B;QACA9B;IACF;IAEA,MAAM8C,cAAchG,YAAY;QAC9BuE,YAAYS,OAAO,GAAG;QACtBtB;QACAO;QACAH,WAAW;IACb,GAAG;QAACG;QAAwBP;QAAkBI;KAAW;IAEzD7D,UAAU;QACR,IAAI,CAAC4D,SAAS;YACZ;QACF;QAEA,MAAMoC,gBAAgB,CAACC;YACrB,IAAIA,MAAMC,GAAG,KAAK,UAAU;gBAC1BH;YACF;QACF;QAEAf,OAAOmB,gBAAgB,CAAC,WAAWH;QACnChB,OAAOmB,gBAAgB,CAAC,UAAUJ,aAAa;QAC/Cf,OAAOmB,gBAAgB,CAAC,YAAYJ,aAAa;QACjD,OAAO;YACLf,OAAOoB,mBAAmB,CAAC,WAAWJ;YACtChB,OAAOoB,mBAAmB,CAAC,UAAUL,aAAa;YAClDf,OAAOoB,mBAAmB,CAAC,YAAYL,aAAa;QACtD;IACF,GAAG;QAACA;QAAanC;KAAQ;IAEzB,MAAMyC,eAAenG,OAAO;IAC5B,MAAMoG,eAAepG,OAAO;IAC5BI,gBAAgB;QACdkB;QACA+E,mBAAmBR;QACnBS,UAASC,MAAM;YACb,IAAIA,QAAQ;gBACVJ,aAAatB,OAAO,GAAGC,OAAO0B,qBAAqB,CAAC;oBAClDJ,aAAavB,OAAO,GAAG;gBACzB;gBACA;YACF;YAEAuB,aAAavB,OAAO,GAAG;YACvBgB;QACF;IACF;IAEA,MAAMY,iBAAiB,CAACC;QACtB,IAAI,CAAC1D,cAAc;YACjB,OAAO;QACT;QAEA,MAAM2D,UAAUxC,YAAYU,OAAO,IAAI6B;QACvC,OAAO,CAACC,WAAWA,QAAQC,WAAW,IAAID,QAAQE,WAAW;IAC/D;IAEA,OAAO;QACLnD;QACAC;QACAkC;QACAiB,cAAc3D,gBAAgB0B,OAAO;QACrCT;QACAD;QACAP;QACAC;QACAC;QACAiD,cAAc;YACZ7F,IAAIgC;YACJmB;YACA7C;YACAJ;YACAsC;YACAzB;YACA,GAAGqC,SAAS;QACd;QACA0C,cAAc;YACZ,oBAAoBpH,IAAI8D,WAAWR,WAAW3B,gBAAgB8D;YAC9DnE;YACAqB,cAAawD,KAAK;gBAChBxD,aAAawD;gBACb,IACEzE,YACA0C,SAAS,WACTI,YAAYS,OAAO,KAAK,QACxB4B,eAAeV,MAAMW,aAAa,GAClC;oBACA;gBACF;gBAEAtC,YAAYS,OAAO,GAAG;gBACtBZ,WAAWY,OAAO,GAAGkB,MAAMW,aAAa;gBACxC3C,eAAegC,MAAMW,aAAa;gBAClC9C,cAAc1C;YAChB;YACAsB,cAAauD,KAAK;gBAChBvD,aAAauD;gBACb,IAAIzE,YAAY8C,YAAYS,OAAO,KAAK,SAAS;oBAC/C;gBACF;gBAEAhB;gBACAO,YAAYS,OAAO,GAAG;YACxB;YACAxC,QAAO0D,KAAK;gBACV1D,OAAO0D;gBACP,IAAIzE,UAAU;oBACZ;gBACF;gBAEA8C,YAAYS,OAAO,GAAG;gBACtBhB;YACF;YACAvB,SAAQyD,KAAK;gBACXzD,QAAQyD;gBACR,mEAAmE;gBACnE,8CAA8C;gBAC9C,IACEzE,YACA0C,SAAS,cACTI,YAAYS,OAAO,KAAK,QACxBuB,aAAavB,OAAO,IACpB4B,eAAeV,MAAMW,aAAa,GAClC;oBACAN,aAAavB,OAAO,GAAG;oBACvB;gBACF;gBAEAT,YAAYS,OAAO,GAAG;gBACtBZ,WAAWY,OAAO,GAAGkB,MAAMW,aAAa;gBACxC3C,eAAegC,MAAMW,aAAa;gBAClC9C,cAAc1C;YAChB;YACAuB,cAAasD,KAAK;gBAChBtD,aAAasD;gBACb,IACEzE,YACA8C,YAAYS,OAAO,KAAK,QACxB4B,eAAeV,MAAMW,aAAa,GAClC;oBACA;gBACF;gBAEAtC,YAAYS,OAAO,GAAG;gBACtBZ,WAAWY,OAAO,GAAGkB,MAAMW,aAAa;gBACxC3C,eAAegC,MAAMW,aAAa;gBAClC9C,cAAc1C;YAChB;YACAwB,YAAWqD,KAAK;gBACdrD,WAAWqD;gBACX,IAAIzE,UAAU;oBACZ;gBACF;gBAEA8C,YAAYS,OAAO,GAAG;gBACtBhB;YACF;YACAlB,eAAcoD,KAAK;gBACjBpD,cAAcoD;gBACd,IACEzE,YACA8C,YAAYS,OAAO,KAAK,WACxB4B,eAAeV,MAAMW,aAAa,GAClC;oBACA;gBACF;gBAEAX,MAAMkB,cAAc;gBACpB,MAAMC,YAAYpC,OAAOqC,YAAY;gBACrC,MAAMC,OAAOF,WAAWG,YAAYC;gBACpC,IAAIF,QAAQrB,MAAMW,aAAa,CAACa,QAAQ,CAACH,OAAO;oBAC9CF,UAAUM,KAAK;gBACjB;YACF;QACF;IACF;AACF"}

package/dist/tooltip/useTooltipPosition.d.ts

@@ -1,6 +1,6 @@
 import type { SimplePosition } from "../positioning/types.js";
 /**
- * @remarks \@since 2.8.0
+ * @since 2.8.0
  */
 export interface TooltipPositionHookOptions {
     /**
@@ -34,12 +34,12 @@ export interface TooltipPositionHookOptions {
 }
 /**
  * @internal
- * @remarks \@since 2.8.0
+ * @since 2.8.0
  */
 export type UpdateTooltipPosition = (container: HTMLElement) => void;
 /**
  * @internal
- * @remarks \@since 2.8.0
+ * @since 2.8.0
  */
 export type TooltipPositionHookReturnValue = [
     SimplePosition,
@@ -50,6 +50,6 @@ export type TooltipPositionHookReturnValue = [
  * within the viewport.
  *
  * @internal
- * @remarks \@since 2.8.0
+ * @since 2.8.0
  */
 export declare function useTooltipPosition(options: TooltipPositionHookOptions): TooltipPositionHookReturnValue;

package/dist/tooltip/useTooltipPosition.js

@@ -10,7 +10,7 @@ import { getPosition } from "./utils.js";
  * within the viewport.
  *
  * @internal
- * @remarks \@since 2.8.0
+ * @since 2.8.0
  */ export function useTooltipPosition(options) {
     const { position: determinedPosition, threshold = DEFAULT_TOOLTIP_THRESHOLD, defaultPosition = DEFAULT_TOOLTIP_POSITION } = options;
     const [position, setPosition] = useState(defaultPosition);

package/dist/tooltip/useTooltipPosition.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/tooltip/useTooltipPosition.ts"],"sourcesContent":["\"use client\";\nimport { useCallback, useState } from \"react\";\nimport type { SimplePosition } from \"../positioning/types.js\";\nimport {\n  DEFAULT_TOOLTIP_POSITION,\n  DEFAULT_TOOLTIP_THRESHOLD,\n} from \"./constants.js\";\nimport { getPosition } from \"./utils.js\";\n\n/** @internal */\nconst noop = (): void => {\n  // do nothing\n};\n\n/**\n * @remarks \\@since 2.8.0\n */\nexport interface TooltipPositionHookOptions {\n  /**\n   * An optional controlled position to use that will disable the functionality\n   * to determine the \"best\" position to render the tooltip within the viewport.\n   */\n  position?: SimplePosition;\n\n  /**\n   * An optional position to use before the positioning calculation has\n   * occurred. This is also used to determine if the position should be\n   * horizontal vs vertical.\n   *\n   * Vertical - `\"below\"` or `\"above\"`\n   * Horizontal - `\"left\"` or `\"right\"`\n   *\n   * @defaultValue `DEFAULT_TOOLTIP_POSITION`\n   * @see {@link DEFAULT_TOOLTIP_POSITION}\n   */\n  defaultPosition?: SimplePosition;\n\n  /**\n   * This value should be between 0 and 1 and will be multiplied by either the\n   * viewport height or viewport width to determine the best position to render\n   * the tooltip based on available space within the viewport.\n   *\n   * You _probably_ won't ever really need to update this value.\n   *\n   * @defaultValue `DEFAULT_TOOLTIP_THRESHOLD`\n   * @see {@link DEFAULT_TOOLTIP_THRESHOLD}\n   */\n  threshold?: number;\n}\n\n/**\n * @internal\n * @remarks \\@since 2.8.0\n */\nexport type UpdateTooltipPosition = (container: HTMLElement) => void;\n\n/**\n * @internal\n * @remarks \\@since 2.8.0\n */\nexport type TooltipPositionHookReturnValue = [\n  SimplePosition,\n  UpdateTooltipPosition,\n];\n\n/**\n * A hook that's used to determine the \"best\" position to render the tooltip\n * within the viewport.\n *\n * @internal\n * @remarks \\@since 2.8.0\n */\nexport function useTooltipPosition(\n  options: TooltipPositionHookOptions\n): TooltipPositionHookReturnValue {\n  const {\n    position: determinedPosition,\n    threshold = DEFAULT_TOOLTIP_THRESHOLD,\n    defaultPosition = DEFAULT_TOOLTIP_POSITION,\n  } = options;\n\n  const [position, setPosition] = useState(defaultPosition);\n  const updatePosition = useCallback<UpdateTooltipPosition>(\n    (container) => {\n      setPosition(\n        getPosition({\n          container,\n          threshold,\n          defaultPosition,\n        })\n      );\n    },\n    [defaultPosition, threshold]\n  );\n\n  if (typeof determinedPosition !== \"undefined\") {\n    return [determinedPosition, noop];\n  }\n\n  return [position, updatePosition];\n}\n"],"names":["useCallback","useState","DEFAULT_TOOLTIP_POSITION","DEFAULT_TOOLTIP_THRESHOLD","getPosition","noop","useTooltipPosition","options","position","determinedPosition","threshold","defaultPosition","setPosition","updatePosition","container"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;AACA,SAASA,WAAW,EAAEC,QAAQ,QAAQ,QAAQ;AAE9C,SACEC,wBAAwB,EACxBC,yBAAyB,QACpB,iBAAiB;AACxB,SAASC,WAAW,QAAQ,aAAa;AAEzC,cAAc,GACd,MAAMC,OAAO;AACX,aAAa;AACf;AAqDA;;;;;;CAMC,GACD,OAAO,SAASC,mBACdC,OAAmC;IAEnC,MAAM,EACJC,UAAUC,kBAAkB,EAC5BC,YAAYP,yBAAyB,EACrCQ,kBAAkBT,wBAAwB,EAC3C,GAAGK;IAEJ,MAAM,CAACC,UAAUI,YAAY,GAAGX,SAASU;IACzC,MAAME,iBAAiBb,YACrB,CAACc;QACCF,YACER,YAAY;YACVU;YACAJ;YACAC;QACF;IAEJ,GACA;QAACA;QAAiBD;KAAU;IAG9B,IAAI,OAAOD,uBAAuB,aAAa;QAC7C,OAAO;YAACA;YAAoBJ;SAAK;IACnC;IAEA,OAAO;QAACG;QAAUK;KAAe;AACnC"}
+{"version":3,"sources":["../../src/tooltip/useTooltipPosition.ts"],"sourcesContent":["\"use client\";\nimport { useCallback, useState } from \"react\";\nimport type { SimplePosition } from \"../positioning/types.js\";\nimport {\n  DEFAULT_TOOLTIP_POSITION,\n  DEFAULT_TOOLTIP_THRESHOLD,\n} from \"./constants.js\";\nimport { getPosition } from \"./utils.js\";\n\n/** @internal */\nconst noop = (): void => {\n  // do nothing\n};\n\n/**\n * @since 2.8.0\n */\nexport interface TooltipPositionHookOptions {\n  /**\n   * An optional controlled position to use that will disable the functionality\n   * to determine the \"best\" position to render the tooltip within the viewport.\n   */\n  position?: SimplePosition;\n\n  /**\n   * An optional position to use before the positioning calculation has\n   * occurred. This is also used to determine if the position should be\n   * horizontal vs vertical.\n   *\n   * Vertical - `\"below\"` or `\"above\"`\n   * Horizontal - `\"left\"` or `\"right\"`\n   *\n   * @defaultValue `DEFAULT_TOOLTIP_POSITION`\n   * @see {@link DEFAULT_TOOLTIP_POSITION}\n   */\n  defaultPosition?: SimplePosition;\n\n  /**\n   * This value should be between 0 and 1 and will be multiplied by either the\n   * viewport height or viewport width to determine the best position to render\n   * the tooltip based on available space within the viewport.\n   *\n   * You _probably_ won't ever really need to update this value.\n   *\n   * @defaultValue `DEFAULT_TOOLTIP_THRESHOLD`\n   * @see {@link DEFAULT_TOOLTIP_THRESHOLD}\n   */\n  threshold?: number;\n}\n\n/**\n * @internal\n * @since 2.8.0\n */\nexport type UpdateTooltipPosition = (container: HTMLElement) => void;\n\n/**\n * @internal\n * @since 2.8.0\n */\nexport type TooltipPositionHookReturnValue = [\n  SimplePosition,\n  UpdateTooltipPosition,\n];\n\n/**\n * A hook that's used to determine the \"best\" position to render the tooltip\n * within the viewport.\n *\n * @internal\n * @since 2.8.0\n */\nexport function useTooltipPosition(\n  options: TooltipPositionHookOptions\n): TooltipPositionHookReturnValue {\n  const {\n    position: determinedPosition,\n    threshold = DEFAULT_TOOLTIP_THRESHOLD,\n    defaultPosition = DEFAULT_TOOLTIP_POSITION,\n  } = options;\n\n  const [position, setPosition] = useState(defaultPosition);\n  const updatePosition = useCallback<UpdateTooltipPosition>(\n    (container) => {\n      setPosition(\n        getPosition({\n          container,\n          threshold,\n          defaultPosition,\n        })\n      );\n    },\n    [defaultPosition, threshold]\n  );\n\n  if (typeof determinedPosition !== \"undefined\") {\n    return [determinedPosition, noop];\n  }\n\n  return [position, updatePosition];\n}\n"],"names":["useCallback","useState","DEFAULT_TOOLTIP_POSITION","DEFAULT_TOOLTIP_THRESHOLD","getPosition","noop","useTooltipPosition","options","position","determinedPosition","threshold","defaultPosition","setPosition","updatePosition","container"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;AACA,SAASA,WAAW,EAAEC,QAAQ,QAAQ,QAAQ;AAE9C,SACEC,wBAAwB,EACxBC,yBAAyB,QACpB,iBAAiB;AACxB,SAASC,WAAW,QAAQ,aAAa;AAEzC,cAAc,GACd,MAAMC,OAAO;AACX,aAAa;AACf;AAqDA;;;;;;CAMC,GACD,OAAO,SAASC,mBACdC,OAAmC;IAEnC,MAAM,EACJC,UAAUC,kBAAkB,EAC5BC,YAAYP,yBAAyB,EACrCQ,kBAAkBT,wBAAwB,EAC3C,GAAGK;IAEJ,MAAM,CAACC,UAAUI,YAAY,GAAGX,SAASU;IACzC,MAAME,iBAAiBb,YACrB,CAACc;QACCF,YACER,YAAY;YACVU;YACAJ;YACAC;QACF;IAEJ,GACA;QAACA;QAAiBD;KAAU;IAG9B,IAAI,OAAOD,uBAAuB,aAAa;QAC7C,OAAO;YAACA;YAAoBJ;SAAK;IACnC;IAEA,OAAO;QAACG;QAAUK;KAAe;AACnC"}