@react-md/core 1.0.0-next.15 → 1.0.0-next.17

package/dist/theme/useCSSVariables.d.ts

@@ -1,22 +1,5 @@
-import type { RefObject } from "react";
-import type { CSSVariableName, DefinedCSSVariableName } from "./types.js";
-/**
- * @since 6.0.0
- */
-export interface CSSVariable<Name extends CSSVariableName = DefinedCSSVariableName> {
-    name: Name;
-    value: string | number;
-}
-/**
- * @since 6.0.0
- */
-export type CSSVariablesProperties<Name extends CSSVariableName = DefinedCSSVariableName> = {
-    [key in Name]?: string | number;
-};
-/**
- * @since 6.0.0
- */
-export type ReadonlyCSSVariableList<Name extends CSSVariableName = DefinedCSSVariableName> = readonly Readonly<CSSVariable<Name>>[];
+import { type RefObject } from "react";
+import { type CSSVariableName, type CSSVariablesProperties, type ReadonlyCSSVariableList } from "./types.js";
 /**
  * @example Applying Variables the root html element
  * ```ts

package/dist/theme/useCSSVariables.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/theme/useCSSVariables.ts"],"sourcesContent":["\"use client\";\nimport type { RefObject } from \"react\";\nimport { useEffect, useMemo } from \"react\";\nimport type { CSSVariableName, DefinedCSSVariableName } from \"./types.js\";\n\n/**\n * @since 6.0.0\n */\nexport interface CSSVariable<\n  Name extends CSSVariableName = DefinedCSSVariableName,\n> {\n  name: Name;\n  value: string | number;\n}\n\n/**\n * @since 6.0.0\n */\nexport type CSSVariablesProperties<\n  Name extends CSSVariableName = DefinedCSSVariableName,\n> = {\n  [key in Name]?: string | number;\n};\n\n/**\n * @since 6.0.0\n */\nexport type ReadonlyCSSVariableList<\n  Name extends CSSVariableName = DefinedCSSVariableName,\n> = readonly Readonly<CSSVariable<Name>>[];\n\n/**\n * @example Applying Variables the root html element\n * ```ts\n * import {\n *   contrastColor,\n *   pinkAccent200,\n *   purple500,\n *   useCSSVariables,\n *  } from \"@react-md/core\";\n * import { useMemo } from \"react\";\n *\n * function Example(): null {\n *   // Note: You should use `useMemo` so that the custom variables are not\n *   // added and removed during each render.\n *   useCSSVariables(useMemo(() => {\n *     return [\n *       {\n *         name: \"--rmd-primary-color\",\n *         value: purple500,\n *       },\n *       {\n *         name: \"--rmd-on-primary-color\",\n *         value: contrastColor(purple500),\n *       },\n *     ];\n *   }, []));\n *\n *   return null;\n * }\n * ```\n *\n * @since 6.0.0\n */\nexport function useCSSVariables<Name extends CSSVariableName>(\n  variables: ReadonlyCSSVariableList<Name>,\n  rootNode?: RefObject<HTMLElement> | HTMLElement\n): void;\n/**\n * @example Applying variables through inline styles\n * ```tsx\n * import {\n *   contrastColor,\n *   ReadonlyCSSVariableList,\n *   pinkAccent200,\n *   purple500,\n *   useCSSVariables,\n *  } from \"@react-md/core\";\n * import { useMemo } from \"react\";\n * import type { ReactElement, ReactNode } from \"react\";\n *\n * function Example({ children }: { children: ReactNode }): ReactElement {\n *   const customVariables = useMemo<ReadonlyCSSVariableList>(() => {\n *     return [\n *       {\n *         name: \"--rmd-primary-color\",\n *         value: purple500,\n *       },\n *       {\n *         name: \"--rmd-on-primary-color\",\n *         value: contrastColor(purple500),\n *       },\n *     ];\n *   }, []);\n *   const style = useCSSVariables(customVariables, true);\n *\n *   return <div style={style}>{children}</div>;\n * }\n * ```\n *\n * @since 6.0.0\n */\nexport function useCSSVariables<Name extends CSSVariableName>(\n  variables: ReadonlyCSSVariableList<Name>,\n  inlineStyle: true\n): CSSVariablesProperties<Name>;\n/**\n * @since 6.0.0\n */\nexport function useCSSVariables<Name extends CSSVariableName>(\n  variables: ReadonlyCSSVariableList<Name>,\n  rootNodeOrInlineStyle?: RefObject<HTMLElement> | HTMLElement | boolean\n): CSSVariablesProperties<Name> | void {\n  useEffect(() => {\n    if (rootNodeOrInlineStyle === true || !variables.length) {\n      return;\n    }\n\n    // use an iife so that hoisting doesn't cause a possible \"null\" issue for\n    // the root\n    const root = (() => {\n      if (!rootNodeOrInlineStyle) {\n        return document.documentElement;\n      }\n\n      if (\"current\" in rootNodeOrInlineStyle) {\n        return rootNodeOrInlineStyle.current;\n      }\n\n      return rootNodeOrInlineStyle;\n    })();\n\n    if (!root) {\n      return;\n    }\n\n    // const root = document.documentElement;\n    variables.forEach(({ name, value }) => {\n      if (\n        process.env.NODE_ENV !== \"production\" &&\n        root.style.getPropertyValue(name)\n      ) {\n        const currentValue = root.style.getPropertyValue(name);\n        const overwritten =\n          currentValue !== value\n            ? ` and will be overwritten to \"${value}\"`\n            : \"\";\n        // eslint-disable-next-line no-console\n        console.warn(\n          `The \"${name}\" css variable has already been set to \"${currentValue}\" ` +\n            `on the root element${overwritten}. There might be conflicting overrides.`\n        );\n      }\n\n      root.style.setProperty(name, `${value}`);\n    });\n    return () => {\n      variables.forEach(({ name }) => {\n        root.style.removeProperty(name);\n      });\n    };\n  }, [variables, rootNodeOrInlineStyle]);\n\n  return useMemo(() => {\n    if (rootNodeOrInlineStyle !== true) {\n      return;\n    }\n\n    return variables.reduce<CSSVariablesProperties<Name>>(\n      (style, { name, value }) => {\n        style[name] = value;\n        return style;\n      },\n      {}\n    );\n  }, [rootNodeOrInlineStyle, variables]);\n}\n"],"names":["useEffect","useMemo","useCSSVariables","variables","rootNodeOrInlineStyle","length","root","document","documentElement","current","forEach","name","value","process","env","NODE_ENV","style","getPropertyValue","currentValue","overwritten","console","warn","setProperty","removeProperty","reduce"],"mappings":"AAAA;AAEA,SAASA,SAAS,EAAEC,OAAO,QAAQ,QAAQ;AAwG3C;;CAEC,GACD,OAAO,SAASC,gBACdC,SAAwC,EACxCC,qBAAsE;IAEtEJ,UAAU;QACR,IAAII,0BAA0B,QAAQ,CAACD,UAAUE,MAAM,EAAE;YACvD;QACF;QAEA,yEAAyE;QACzE,WAAW;QACX,MAAMC,OAAO,AAAC,CAAA;YACZ,IAAI,CAACF,uBAAuB;gBAC1B,OAAOG,SAASC,eAAe;YACjC;YAEA,IAAI,aAAaJ,uBAAuB;gBACtC,OAAOA,sBAAsBK,OAAO;YACtC;YAEA,OAAOL;QACT,CAAA;QAEA,IAAI,CAACE,MAAM;YACT;QACF;QAEA,yCAAyC;QACzCH,UAAUO,OAAO,CAAC,CAAC,EAAEC,IAAI,EAAEC,KAAK,EAAE;YAChC,IACEC,QAAQC,GAAG,CAACC,QAAQ,KAAK,gBACzBT,KAAKU,KAAK,CAACC,gBAAgB,CAACN,OAC5B;gBACA,MAAMO,eAAeZ,KAAKU,KAAK,CAACC,gBAAgB,CAACN;gBACjD,MAAMQ,cACJD,iBAAiBN,QACb,CAAC,6BAA6B,EAAEA,MAAM,CAAC,CAAC,GACxC;gBACN,sCAAsC;gBACtCQ,QAAQC,IAAI,CACV,CAAC,KAAK,EAAEV,KAAK,wCAAwC,EAAEO,aAAa,EAAE,CAAC,GACrE,CAAC,mBAAmB,EAAEC,YAAY,uCAAuC,CAAC;YAEhF;YAEAb,KAAKU,KAAK,CAACM,WAAW,CAACX,MAAM,CAAC,EAAEC,MAAM,CAAC;QACzC;QACA,OAAO;YACLT,UAAUO,OAAO,CAAC,CAAC,EAAEC,IAAI,EAAE;gBACzBL,KAAKU,KAAK,CAACO,cAAc,CAACZ;YAC5B;QACF;IACF,GAAG;QAACR;QAAWC;KAAsB;IAErC,OAAOH,QAAQ;QACb,IAAIG,0BAA0B,MAAM;YAClC;QACF;QAEA,OAAOD,UAAUqB,MAAM,CACrB,CAACR,OAAO,EAAEL,IAAI,EAAEC,KAAK,EAAE;YACrBI,KAAK,CAACL,KAAK,GAAGC;YACd,OAAOI;QACT,GACA,CAAC;IAEL,GAAG;QAACZ;QAAuBD;KAAU;AACvC"}
+{"version":3,"sources":["../../src/theme/useCSSVariables.ts"],"sourcesContent":["\"use client\";\nimport { type RefObject, useEffect, useMemo } from \"react\";\nimport {\n  type CSSVariableName,\n  type CSSVariablesProperties,\n  type ReadonlyCSSVariableList,\n} from \"./types.js\";\n\n/**\n * @example Applying Variables the root html element\n * ```ts\n * import {\n *   contrastColor,\n *   pinkAccent200,\n *   purple500,\n *   useCSSVariables,\n *  } from \"@react-md/core\";\n * import { useMemo } from \"react\";\n *\n * function Example(): null {\n *   // Note: You should use `useMemo` so that the custom variables are not\n *   // added and removed during each render.\n *   useCSSVariables(useMemo(() => {\n *     return [\n *       {\n *         name: \"--rmd-primary-color\",\n *         value: purple500,\n *       },\n *       {\n *         name: \"--rmd-on-primary-color\",\n *         value: contrastColor(purple500),\n *       },\n *     ];\n *   }, []));\n *\n *   return null;\n * }\n * ```\n *\n * @since 6.0.0\n */\nexport function useCSSVariables<Name extends CSSVariableName>(\n  variables: ReadonlyCSSVariableList<Name>,\n  rootNode?: RefObject<HTMLElement> | HTMLElement\n): void;\n/**\n * @example Applying variables through inline styles\n * ```tsx\n * import {\n *   contrastColor,\n *   ReadonlyCSSVariableList,\n *   pinkAccent200,\n *   purple500,\n *   useCSSVariables,\n *  } from \"@react-md/core\";\n * import { useMemo } from \"react\";\n * import type { ReactElement, ReactNode } from \"react\";\n *\n * function Example({ children }: { children: ReactNode }): ReactElement {\n *   const customVariables = useMemo<ReadonlyCSSVariableList>(() => {\n *     return [\n *       {\n *         name: \"--rmd-primary-color\",\n *         value: purple500,\n *       },\n *       {\n *         name: \"--rmd-on-primary-color\",\n *         value: contrastColor(purple500),\n *       },\n *     ];\n *   }, []);\n *   const style = useCSSVariables(customVariables, true);\n *\n *   return <div style={style}>{children}</div>;\n * }\n * ```\n *\n * @since 6.0.0\n */\nexport function useCSSVariables<Name extends CSSVariableName>(\n  variables: ReadonlyCSSVariableList<Name>,\n  inlineStyle: true\n): CSSVariablesProperties<Name>;\n/**\n * @since 6.0.0\n */\nexport function useCSSVariables<Name extends CSSVariableName>(\n  variables: ReadonlyCSSVariableList<Name>,\n  rootNodeOrInlineStyle?: RefObject<HTMLElement> | HTMLElement | boolean\n): CSSVariablesProperties<Name> | undefined {\n  useEffect(() => {\n    if (rootNodeOrInlineStyle === true || !variables.length) {\n      return;\n    }\n\n    // use an iife so that hoisting doesn't cause a possible \"null\" issue for\n    // the root\n    const root = (() => {\n      if (!rootNodeOrInlineStyle) {\n        return document.documentElement;\n      }\n\n      if (\"current\" in rootNodeOrInlineStyle) {\n        return rootNodeOrInlineStyle.current;\n      }\n\n      return rootNodeOrInlineStyle;\n    })();\n\n    if (!root) {\n      return;\n    }\n\n    // const root = document.documentElement;\n    variables.forEach(({ name, value }) => {\n      if (\n        process.env.NODE_ENV !== \"production\" &&\n        root.style.getPropertyValue(name)\n      ) {\n        const currentValue = root.style.getPropertyValue(name);\n        const overwritten =\n          currentValue !== value\n            ? ` and will be overwritten to \"${value}\"`\n            : \"\";\n        // eslint-disable-next-line no-console\n        console.warn(\n          `The \"${name}\" css variable has already been set to \"${currentValue}\" ` +\n            `on the root element${overwritten}. There might be conflicting overrides.`\n        );\n      }\n\n      root.style.setProperty(name, `${value}`);\n    });\n    return () => {\n      variables.forEach(({ name }) => {\n        root.style.removeProperty(name);\n      });\n    };\n  }, [variables, rootNodeOrInlineStyle]);\n\n  return useMemo(() => {\n    if (rootNodeOrInlineStyle !== true) {\n      return;\n    }\n\n    return variables.reduce<CSSVariablesProperties<Name>>(\n      (style, { name, value }) => {\n        style[name] = value;\n        return style;\n      },\n      {}\n    );\n  }, [rootNodeOrInlineStyle, variables]);\n}\n"],"names":["useEffect","useMemo","useCSSVariables","variables","rootNodeOrInlineStyle","length","root","document","documentElement","current","forEach","name","value","process","env","NODE_ENV","style","getPropertyValue","currentValue","overwritten","console","warn","setProperty","removeProperty","reduce"],"mappings":"AAAA;AACA,SAAyBA,SAAS,EAAEC,OAAO,QAAQ,QAAQ;AAkF3D;;CAEC,GACD,OAAO,SAASC,gBACdC,SAAwC,EACxCC,qBAAsE;IAEtEJ,UAAU;QACR,IAAII,0BAA0B,QAAQ,CAACD,UAAUE,MAAM,EAAE;YACvD;QACF;QAEA,yEAAyE;QACzE,WAAW;QACX,MAAMC,OAAO,AAAC,CAAA;YACZ,IAAI,CAACF,uBAAuB;gBAC1B,OAAOG,SAASC,eAAe;YACjC;YAEA,IAAI,aAAaJ,uBAAuB;gBACtC,OAAOA,sBAAsBK,OAAO;YACtC;YAEA,OAAOL;QACT,CAAA;QAEA,IAAI,CAACE,MAAM;YACT;QACF;QAEA,yCAAyC;QACzCH,UAAUO,OAAO,CAAC,CAAC,EAAEC,IAAI,EAAEC,KAAK,EAAE;YAChC,IACEC,QAAQC,GAAG,CAACC,QAAQ,KAAK,gBACzBT,KAAKU,KAAK,CAACC,gBAAgB,CAACN,OAC5B;gBACA,MAAMO,eAAeZ,KAAKU,KAAK,CAACC,gBAAgB,CAACN;gBACjD,MAAMQ,cACJD,iBAAiBN,QACb,CAAC,6BAA6B,EAAEA,MAAM,CAAC,CAAC,GACxC;gBACN,sCAAsC;gBACtCQ,QAAQC,IAAI,CACV,CAAC,KAAK,EAAEV,KAAK,wCAAwC,EAAEO,aAAa,EAAE,CAAC,GACrE,CAAC,mBAAmB,EAAEC,YAAY,uCAAuC,CAAC;YAEhF;YAEAb,KAAKU,KAAK,CAACM,WAAW,CAACX,MAAM,GAAGC,OAAO;QACzC;QACA,OAAO;YACLT,UAAUO,OAAO,CAAC,CAAC,EAAEC,IAAI,EAAE;gBACzBL,KAAKU,KAAK,CAACO,cAAc,CAACZ;YAC5B;QACF;IACF,GAAG;QAACR;QAAWC;KAAsB;IAErC,OAAOH,QAAQ;QACb,IAAIG,0BAA0B,MAAM;YAClC;QACF;QAEA,OAAOD,UAAUqB,MAAM,CACrB,CAACR,OAAO,EAAEL,IAAI,EAAEC,KAAK,EAAE;YACrBI,KAAK,CAACL,KAAK,GAAGC;YACd,OAAOI;QACT,GACA,CAAC;IAEL,GAAG;QAACZ;QAAuBD;KAAU;AACvC"}

package/dist/theme/useColorScheme.d.ts

@@ -1,39 +1,4 @@
-/// <reference types="react" />
-import type { UseStateSetter } from "../types.js";
-/** @since 6.0.0 */
-export type ColorScheme = "light" | "dark";
-/** @since 6.0.0 */
-export type ColorSchemeMode = ColorScheme | "system";
-/**
- * @since 6.0.0
- */
-export interface ColorSchemeModeBehavior {
-    /**
-     * The current color scheme mode that is being used by your app that should
-     * default to the `$color-scheme` SCSS variable. If the
-     * {@link setColorSchemeMode} is called, this will update to that new value.
-     *
-     * TODO: Figure out how to document this
-     *
-     * - `colorScheme` - only `light` or `dark` -- only useful when the `colorSchemeMode` is set to `system`
-     * - `colorSchemeMode` - current **user** defined color scheme behavior? should default to `$color-scheme`, but will change based on `setColorSchemeMode`
-     */
-    colorSchemeMode: ColorSchemeMode;
-    /**
-     * A function to update the color scheme.
-     *
-     * @see {@link useColorScheme} for an example usage
-     */
-    setColorSchemeMode: UseStateSetter<ColorSchemeMode>;
-}
-/** @since 6.0.0 */
-export interface ColorSchemeContext extends ColorSchemeModeBehavior {
-    /**
-     * The current color scheme that is being used. This is only useful when the
-     * {@link colorSchemeMode} is set to `"system"`.
-     */
-    colorScheme: ColorScheme;
-}
+import { type ColorSchemeContext } from "./types.js";
 export declare const ColorSchemeProvider: import("react").Provider<ColorSchemeContext>;
 /**
  * @example Lazy Load Configurable Themes

package/dist/theme/useColorScheme.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/theme/useColorScheme.ts"],"sourcesContent":["\"use client\";\nimport { createContext, useContext } from \"react\";\nimport type { UseStateSetter } from \"../types.js\";\n\n/** @since 6.0.0 */\nexport type ColorScheme = \"light\" | \"dark\";\n\n/** @since 6.0.0 */\nexport type ColorSchemeMode = ColorScheme | \"system\";\n\n/**\n * @since 6.0.0\n */\nexport interface ColorSchemeModeBehavior {\n  /**\n   * The current color scheme mode that is being used by your app that should\n   * default to the `$color-scheme` SCSS variable. If the\n   * {@link setColorSchemeMode} is called, this will update to that new value.\n   *\n   * TODO: Figure out how to document this\n   *\n   * - `colorScheme` - only `light` or `dark` -- only useful when the `colorSchemeMode` is set to `system`\n   * - `colorSchemeMode` - current **user** defined color scheme behavior? should default to `$color-scheme`, but will change based on `setColorSchemeMode`\n   */\n  colorSchemeMode: ColorSchemeMode;\n\n  /**\n   * A function to update the color scheme.\n   *\n   * @see {@link useColorScheme} for an example usage\n   */\n  setColorSchemeMode: UseStateSetter<ColorSchemeMode>;\n}\n\n/** @since 6.0.0 */\nexport interface ColorSchemeContext extends ColorSchemeModeBehavior {\n  /**\n   * The current color scheme that is being used. This is only useful when the\n   * {@link colorSchemeMode} is set to `\"system\"`.\n   */\n  colorScheme: ColorScheme;\n}\n\nconst context = createContext<ColorSchemeContext>({\n  colorScheme: \"light\",\n  colorSchemeMode: \"light\",\n  setColorSchemeMode() {\n    if (process.env.NODE_ENV !== \"production\") {\n      throw new Error(\"The `ColorSchemeProvider` has not been initialized.\");\n    }\n  },\n});\ncontext.displayName = \"ColorScheme\";\nexport const { Provider: ColorSchemeProvider } = context;\n\n/**\n * @example Lazy Load Configurable Themes\n * ```tsx\n * import type { ChangeEvent, ReactElement } from \"react\";\n * import { lazy } from \"react\";\n * import { createRoot } from \"react-doc/client\";\n * import { Checkbox, ColorSchemeProvider, useColorScheme } from \"@react-md/core\";\n *\n * const DarkTheme = lazy(() => import(\"./DarkTheme\"));\n * const SystemTheme = lazy(() => import(\"./SystemTheme\"));\n *\n * function App(): ReactElement {\n *   const { colorScheme, colorSchemeMode, setColorSchemeMode } =\n *     useColorScheme();\n *\n *   const onChange = (event: ChangeEvent<HTMLInputElement>): void => {\n *     const { value } = event.currentTarget;\n *     if (value === \"light\" || value === \"dark\" || value === \"system\") {\n *       setColorSchemeMode(value);\n *     }\n *   };\n *\n *   return (\n *     <>\n *       {colorSchemeMode === \"dark\" && <DarkTheme />}\n *       {colorSchemeMode === \"system\" && <SystemTheme />}\n *       <Checkbox\n *         label=\"Light\"\n *         value=\"light\"\n *         checked={colorSchemeMode === \"light\"}\n *         onChange={onChange}\n *       />\n *       <Checkbox\n *         label=\"Dark\"\n *         value=\"dark\"\n *         checked={colorSchemeMode === \"dark\"}\n *         onChange={onChange}\n *       />\n *       <Checkbox\n *         label=\"System\"\n *         value=\"system\"\n *         checked={colorSchemeMode === \"system\"}\n *         onChange={onChange}\n *       />\n *     </>\n *   );\n * }\n *\n *\n * const root = createRoot(document.getElementById(\"root\"));\n * root.render(\n *   <ColorSchemeProvider>\n *     <App />\n *   </ColorSchemeProvider>\n * );\n *\n * // DarkTheme.tsx\n * import { useHtmlClassName } from \"@react-md/core\";\n *\n * import styles from \"./DarkTheme.module.scss\";\n *\n * export default function DarkTheme(): null {\n *   useHtmlClassName(styles.theme);\n *   return null\n * }\n *\n * // DarkTheme.module.scss\n * @use \"@react-md/core\";\n *\n * .theme {\n *   @include core.use-dark-theme;\n * }\n * ```\n *\n * @since 6.0.0\n */\nexport function useColorScheme(): Readonly<ColorSchemeContext> {\n  return useContext(context);\n}\n"],"names":["createContext","useContext","context","colorScheme","colorSchemeMode","setColorSchemeMode","process","env","NODE_ENV","Error","displayName","Provider","ColorSchemeProvider","useColorScheme"],"mappings":"AAAA;AACA,SAASA,aAAa,EAAEC,UAAU,QAAQ,QAAQ;AA0ClD,MAAMC,UAAUF,cAAkC;IAChDG,aAAa;IACbC,iBAAiB;IACjBC;QACE,IAAIC,QAAQC,GAAG,CAACC,QAAQ,KAAK,cAAc;YACzC,MAAM,IAAIC,MAAM;QAClB;IACF;AACF;AACAP,QAAQQ,WAAW,GAAG;AACtB,OAAO,MAAM,EAAEC,UAAUC,mBAAmB,EAAE,GAAGV,QAAQ;AAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2EC,GACD,OAAO,SAASW;IACd,OAAOZ,WAAWC;AACpB"}
+{"version":3,"sources":["../../src/theme/useColorScheme.ts"],"sourcesContent":["\"use client\";\nimport { createContext, useContext } from \"react\";\nimport { type ColorSchemeContext } from \"./types.js\";\n\nconst context = createContext<ColorSchemeContext>({\n  colorScheme: \"light\",\n  colorSchemeMode: \"light\",\n  setColorSchemeMode() {\n    if (process.env.NODE_ENV !== \"production\") {\n      throw new Error(\"The `ColorSchemeProvider` has not been initialized.\");\n    }\n  },\n});\ncontext.displayName = \"ColorScheme\";\nexport const { Provider: ColorSchemeProvider } = context;\n\n/**\n * @example Lazy Load Configurable Themes\n * ```tsx\n * import type { ChangeEvent, ReactElement } from \"react\";\n * import { lazy } from \"react\";\n * import { createRoot } from \"react-doc/client\";\n * import { Checkbox, ColorSchemeProvider, useColorScheme } from \"@react-md/core\";\n *\n * const DarkTheme = lazy(() => import(\"./DarkTheme\"));\n * const SystemTheme = lazy(() => import(\"./SystemTheme\"));\n *\n * function App(): ReactElement {\n *   const { colorScheme, colorSchemeMode, setColorSchemeMode } =\n *     useColorScheme();\n *\n *   const onChange = (event: ChangeEvent<HTMLInputElement>): void => {\n *     const { value } = event.currentTarget;\n *     if (value === \"light\" || value === \"dark\" || value === \"system\") {\n *       setColorSchemeMode(value);\n *     }\n *   };\n *\n *   return (\n *     <>\n *       {colorSchemeMode === \"dark\" && <DarkTheme />}\n *       {colorSchemeMode === \"system\" && <SystemTheme />}\n *       <Checkbox\n *         label=\"Light\"\n *         value=\"light\"\n *         checked={colorSchemeMode === \"light\"}\n *         onChange={onChange}\n *       />\n *       <Checkbox\n *         label=\"Dark\"\n *         value=\"dark\"\n *         checked={colorSchemeMode === \"dark\"}\n *         onChange={onChange}\n *       />\n *       <Checkbox\n *         label=\"System\"\n *         value=\"system\"\n *         checked={colorSchemeMode === \"system\"}\n *         onChange={onChange}\n *       />\n *     </>\n *   );\n * }\n *\n *\n * const root = createRoot(document.getElementById(\"root\"));\n * root.render(\n *   <ColorSchemeProvider>\n *     <App />\n *   </ColorSchemeProvider>\n * );\n *\n * // DarkTheme.tsx\n * import { useHtmlClassName } from \"@react-md/core\";\n *\n * import styles from \"./DarkTheme.module.scss\";\n *\n * export default function DarkTheme(): null {\n *   useHtmlClassName(styles.theme);\n *   return null\n * }\n *\n * // DarkTheme.module.scss\n * @use \"@react-md/core\";\n *\n * .theme {\n *   @include core.use-dark-theme;\n * }\n * ```\n *\n * @since 6.0.0\n */\nexport function useColorScheme(): Readonly<ColorSchemeContext> {\n  return useContext(context);\n}\n"],"names":["createContext","useContext","context","colorScheme","colorSchemeMode","setColorSchemeMode","process","env","NODE_ENV","Error","displayName","Provider","ColorSchemeProvider","useColorScheme"],"mappings":"AAAA;AACA,SAASA,aAAa,EAAEC,UAAU,QAAQ,QAAQ;AAGlD,MAAMC,UAAUF,cAAkC;IAChDG,aAAa;IACbC,iBAAiB;IACjBC;QACE,IAAIC,QAAQC,GAAG,CAACC,QAAQ,KAAK,cAAc;YACzC,MAAM,IAAIC,MAAM;QAClB;IACF;AACF;AACAP,QAAQQ,WAAW,GAAG;AACtB,OAAO,MAAM,EAAEC,UAAUC,mBAAmB,EAAE,GAAGV,QAAQ;AAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2EC,GACD,OAAO,SAASW;IACd,OAAOZ,WAAWC;AACpB"}

package/dist/theme/useColorSchemeMetaTag.d.ts

@@ -1,4 +1,4 @@
-import { type ColorScheme } from "./useColorScheme.js";
+import { type ColorScheme } from "./types.js";
 /**
  * @since 6.0.0
  */

package/dist/theme/useColorSchemeMetaTag.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/theme/useColorSchemeMetaTag.ts"],"sourcesContent":["\"use client\";\nimport { useEffect } from \"react\";\nimport { type ColorScheme } from \"./useColorScheme.js\";\n\n/**\n * @since 6.0.0\n */\nexport interface ColorSchemeMetaTagOptions {\n  /**\n   * @defaultValue `\"false\"`\n   */\n  disabled?: boolean;\n  colorScheme: ColorScheme;\n}\n\n/**\n * Adds a `<meta name=\"color-scheme\" content=\"light\">` or\n * `<meta name=\"color-scheme\" content=\"dark\">` into the head element. This\n * should not be used if you are using the `useColorSchemeProvider` since it is\n * already built in.\n *\n * @since 6.0.0\n */\nexport function useColorSchemeMetaTag(\n  options: ColorSchemeMetaTagOptions\n): void {\n  const { disabled, colorScheme } = options;\n\n  useEffect(() => {\n    if (disabled || document.querySelector('meta[name=\"color-scheme\"]')) {\n      return;\n    }\n\n    // Adding the meta tag allows the default browser styles for form inputs to\n    // be updated as well.\n    //\n    // Chrome and Firefox:\n    // - the input type=\"number\"'s spinner color will update from grey to white\n    // - native `<select>` background color updates from grey/white to a dark color\n    //\n    // Chrome:\n    // - the date/time/datetime icons will change from black to white\n    // - the date/time/datetime pickers will use a darker theme instead of white\n    const meta = document.createElement(\"meta\");\n    meta.name = \"color-scheme\";\n    meta.content = colorScheme;\n    document.head.appendChild(meta);\n\n    return () => {\n      document.head.removeChild(meta);\n    };\n  }, [disabled, colorScheme]);\n}\n"],"names":["useEffect","useColorSchemeMetaTag","options","disabled","colorScheme","document","querySelector","meta","createElement","name","content","head","appendChild","removeChild"],"mappings":"AAAA;AACA,SAASA,SAAS,QAAQ,QAAQ;AAclC;;;;;;;CAOC,GACD,OAAO,SAASC,sBACdC,OAAkC;IAElC,MAAM,EAAEC,QAAQ,EAAEC,WAAW,EAAE,GAAGF;IAElCF,UAAU;QACR,IAAIG,YAAYE,SAASC,aAAa,CAAC,8BAA8B;YACnE;QACF;QAEA,2EAA2E;QAC3E,sBAAsB;QACtB,EAAE;QACF,sBAAsB;QACtB,2EAA2E;QAC3E,+EAA+E;QAC/E,EAAE;QACF,UAAU;QACV,iEAAiE;QACjE,4EAA4E;QAC5E,MAAMC,OAAOF,SAASG,aAAa,CAAC;QACpCD,KAAKE,IAAI,GAAG;QACZF,KAAKG,OAAO,GAAGN;QACfC,SAASM,IAAI,CAACC,WAAW,CAACL;QAE1B,OAAO;YACLF,SAASM,IAAI,CAACE,WAAW,CAACN;QAC5B;IACF,GAAG;QAACJ;QAAUC;KAAY;AAC5B"}
+{"version":3,"sources":["../../src/theme/useColorSchemeMetaTag.ts"],"sourcesContent":["\"use client\";\nimport { useEffect } from \"react\";\nimport { type ColorScheme } from \"./types.js\";\n\n/**\n * @since 6.0.0\n */\nexport interface ColorSchemeMetaTagOptions {\n  /**\n   * @defaultValue `\"false\"`\n   */\n  disabled?: boolean;\n  colorScheme: ColorScheme;\n}\n\n/**\n * Adds a `<meta name=\"color-scheme\" content=\"light\">` or\n * `<meta name=\"color-scheme\" content=\"dark\">` into the head element. This\n * should not be used if you are using the `useColorSchemeProvider` since it is\n * already built in.\n *\n * @since 6.0.0\n */\nexport function useColorSchemeMetaTag(\n  options: ColorSchemeMetaTagOptions\n): void {\n  const { disabled, colorScheme } = options;\n\n  useEffect(() => {\n    if (disabled || document.querySelector('meta[name=\"color-scheme\"]')) {\n      return;\n    }\n\n    // Adding the meta tag allows the default browser styles for form inputs to\n    // be updated as well.\n    //\n    // Chrome and Firefox:\n    // - the input type=\"number\"'s spinner color will update from grey to white\n    // - native `<select>` background color updates from grey/white to a dark color\n    //\n    // Chrome:\n    // - the date/time/datetime icons will change from black to white\n    // - the date/time/datetime pickers will use a darker theme instead of white\n    const meta = document.createElement(\"meta\");\n    meta.name = \"color-scheme\";\n    meta.content = colorScheme;\n    document.head.appendChild(meta);\n\n    return () => {\n      document.head.removeChild(meta);\n    };\n  }, [disabled, colorScheme]);\n}\n"],"names":["useEffect","useColorSchemeMetaTag","options","disabled","colorScheme","document","querySelector","meta","createElement","name","content","head","appendChild","removeChild"],"mappings":"AAAA;AACA,SAASA,SAAS,QAAQ,QAAQ;AAclC;;;;;;;CAOC,GACD,OAAO,SAASC,sBACdC,OAAkC;IAElC,MAAM,EAAEC,QAAQ,EAAEC,WAAW,EAAE,GAAGF;IAElCF,UAAU;QACR,IAAIG,YAAYE,SAASC,aAAa,CAAC,8BAA8B;YACnE;QACF;QAEA,2EAA2E;QAC3E,sBAAsB;QACtB,EAAE;QACF,sBAAsB;QACtB,2EAA2E;QAC3E,+EAA+E;QAC/E,EAAE;QACF,UAAU;QACV,iEAAiE;QACjE,4EAA4E;QAC5E,MAAMC,OAAOF,SAASG,aAAa,CAAC;QACpCD,KAAKE,IAAI,GAAG;QACZF,KAAKG,OAAO,GAAGN;QACfC,SAASM,IAAI,CAACC,WAAW,CAACL;QAE1B,OAAO;YACLF,SAASM,IAAI,CAACE,WAAW,CAACN;QAC5B;IACF,GAAG;QAACJ;QAAUC;KAAY;AAC5B"}

package/dist/theme/useColorSchemeProvider.d.ts

@@ -1,5 +1,5 @@
 import { type UseStateInitializer } from "../types.js";
-import { type ColorSchemeContext, type ColorSchemeMode, type ColorSchemeModeBehavior } from "./useColorScheme.js";
+import { type ColorSchemeContext, type ColorSchemeMode, type ColorSchemeModeBehavior } from "./types.js";
 /**
  * @since 6.0.0
  */

package/dist/theme/useColorSchemeProvider.js

@@ -2,7 +2,7 @@
 import { useMemo } from "react";
 import { useEnsuredState } from "../useEnsuredState.js";
 import { useColorSchemeMetaTag } from "./useColorSchemeMetaTag.js";
-import { usePrefersDarkTheme } from "./usePrefersColorScheme.js";
+import { usePrefersDarkTheme } from "./usePrefersDarkScheme.js";
 export function useColorSchemeProvider(options = {}) {
     const { disableMetaTag, colorSchemeMode: value, setColorSchemeMode: setValue, defaultColorSchemeMode } = options;
     const [colorSchemeMode, setColorSchemeMode] = useEnsuredState({

package/dist/theme/useColorSchemeProvider.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/theme/useColorSchemeProvider.ts"],"sourcesContent":["\"use client\";\nimport { useMemo } from \"react\";\nimport { type UseStateInitializer } from \"../types.js\";\nimport { useEnsuredState } from \"../useEnsuredState.js\";\nimport {\n  type ColorSchemeContext,\n  type ColorSchemeMode,\n  type ColorSchemeModeBehavior,\n} from \"./useColorScheme.js\";\nimport { useColorSchemeMetaTag } from \"./useColorSchemeMetaTag.js\";\nimport { usePrefersDarkTheme } from \"./usePrefersColorScheme.js\";\n\n/**\n * @since 6.0.0\n */\nexport interface ColorSchemeProviderOptions\n  extends Partial<ColorSchemeModeBehavior> {\n  /**\n   * Set this to `true` to prevent a `<meta name=\"color-scheme\" content=\"{COLOR_SCHEME}\">`\n   * from being added to the `document.head`.\n   *\n   * @defaultValue `false`\n   */\n  disableMetaTag?: boolean;\n\n  /**\n   * The current color scheme mode that is being used by your app. This should\n   * match the `$color-scheme` SCSS variable.\n   *\n   * @defaultValue `\"light\"`\n   */\n  defaultColorSchemeMode?: UseStateInitializer<ColorSchemeMode>;\n}\n\n/**\n * @example\n * ```tsx\n * import {\n *   ColorSchemeProvider,\n *   useColorSchemeProvider,\n *   type ColorSchemeMode,\n * } from \"@react-md/core\";\n * import { type PropsWithChildren, type ReactElement } from \"react\";\n * import Cookies from \"js-cookie\";\n *\n * function MyColorSchemeProvider(props: PropsWithChildren): ReactElement {\n *   const { children } = props;\n *\n *   const [colorSchemeMode, setColorSchemeMode] = useState<ColorSchemeMode>(\n *     () => Cookies.get(\"colorSchemeMode\") || \"system\"\n *   );\n *   const value = useColorSchemeProvider({\n *     colorSchemeMode,\n *     setColorSchemeMode(nextValue) {\n *       setColorSchemeMode((prevValue) => {\n *         const value = typeof nextValue === \"function\"\n *           ? nextValue(prevValue)\n *           : nextValue;\n *\n *         Cookies.set(\"colorSchemeMode\", value);\n *         return value;\n *       });\n *     }\n *   });\n *\n *   return <ColorSchemeProvider value={value}>{children}</ColorSchemeProvider>\n * }\n * ```\n * @since 6.0.0\n */\nexport function useColorSchemeProvider(\n  options?: { [key in keyof ColorSchemeModeBehavior]?: never } & {\n    disableMetaTag?: boolean;\n    defaultColorSchemeMode?: UseStateInitializer<ColorSchemeMode>;\n  }\n): ColorSchemeContext;\nexport function useColorSchemeProvider(\n  options: ColorSchemeModeBehavior & {\n    disableMetaTag?: boolean;\n    defaultColorSchemeMode?: never;\n  }\n): ColorSchemeContext;\nexport function useColorSchemeProvider(\n  options: ColorSchemeProviderOptions = {}\n): ColorSchemeContext {\n  const {\n    disableMetaTag,\n    colorSchemeMode: value,\n    setColorSchemeMode: setValue,\n    defaultColorSchemeMode,\n  } = options;\n\n  const [colorSchemeMode, setColorSchemeMode] = useEnsuredState({\n    value,\n    setValue,\n    defaultValue: defaultColorSchemeMode,\n  });\n  const prefersDarkTheme = usePrefersDarkTheme(colorSchemeMode !== \"system\");\n  const derivedColorScheme = prefersDarkTheme ? \"dark\" : \"light\";\n  const colorScheme =\n    colorSchemeMode === \"system\" ? derivedColorScheme : colorSchemeMode;\n\n  useColorSchemeMetaTag({\n    disabled: disableMetaTag,\n    colorScheme,\n  });\n\n  return useMemo<ColorSchemeContext>(\n    () => ({\n      colorScheme,\n      colorSchemeMode,\n      setColorSchemeMode,\n    }),\n    [colorScheme, colorSchemeMode, setColorSchemeMode]\n  );\n}\n"],"names":["useMemo","useEnsuredState","useColorSchemeMetaTag","usePrefersDarkTheme","useColorSchemeProvider","options","disableMetaTag","colorSchemeMode","value","setColorSchemeMode","setValue","defaultColorSchemeMode","defaultValue","prefersDarkTheme","derivedColorScheme","colorScheme","disabled"],"mappings":"AAAA;AACA,SAASA,OAAO,QAAQ,QAAQ;AAEhC,SAASC,eAAe,QAAQ,wBAAwB;AAMxD,SAASC,qBAAqB,QAAQ,6BAA6B;AACnE,SAASC,mBAAmB,QAAQ,6BAA6B;AAwEjE,OAAO,SAASC,uBACdC,UAAsC,CAAC,CAAC;IAExC,MAAM,EACJC,cAAc,EACdC,iBAAiBC,KAAK,EACtBC,oBAAoBC,QAAQ,EAC5BC,sBAAsB,EACvB,GAAGN;IAEJ,MAAM,CAACE,iBAAiBE,mBAAmB,GAAGR,gBAAgB;QAC5DO;QACAE;QACAE,cAAcD;IAChB;IACA,MAAME,mBAAmBV,oBAAoBI,oBAAoB;IACjE,MAAMO,qBAAqBD,mBAAmB,SAAS;IACvD,MAAME,cACJR,oBAAoB,WAAWO,qBAAqBP;IAEtDL,sBAAsB;QACpBc,UAAUV;QACVS;IACF;IAEA,OAAOf,QACL,IAAO,CAAA;YACLe;YACAR;YACAE;QACF,CAAA,GACA;QAACM;QAAaR;QAAiBE;KAAmB;AAEtD"}
+{"version":3,"sources":["../../src/theme/useColorSchemeProvider.ts"],"sourcesContent":["\"use client\";\nimport { useMemo } from \"react\";\nimport { type UseStateInitializer } from \"../types.js\";\nimport { useEnsuredState } from \"../useEnsuredState.js\";\nimport {\n  type ColorSchemeContext,\n  type ColorSchemeMode,\n  type ColorSchemeModeBehavior,\n} from \"./types.js\";\nimport { useColorSchemeMetaTag } from \"./useColorSchemeMetaTag.js\";\nimport { usePrefersDarkTheme } from \"./usePrefersDarkScheme.js\";\n\n/**\n * @since 6.0.0\n */\nexport interface ColorSchemeProviderOptions\n  extends Partial<ColorSchemeModeBehavior> {\n  /**\n   * Set this to `true` to prevent a `<meta name=\"color-scheme\" content=\"{COLOR_SCHEME}\">`\n   * from being added to the `document.head`.\n   *\n   * @defaultValue `false`\n   */\n  disableMetaTag?: boolean;\n\n  /**\n   * The current color scheme mode that is being used by your app. This should\n   * match the `$color-scheme` SCSS variable.\n   *\n   * @defaultValue `\"light\"`\n   */\n  defaultColorSchemeMode?: UseStateInitializer<ColorSchemeMode>;\n}\n\n/**\n * @example\n * ```tsx\n * import {\n *   ColorSchemeProvider,\n *   useColorSchemeProvider,\n *   type ColorSchemeMode,\n * } from \"@react-md/core\";\n * import { type PropsWithChildren, type ReactElement } from \"react\";\n * import Cookies from \"js-cookie\";\n *\n * function MyColorSchemeProvider(props: PropsWithChildren): ReactElement {\n *   const { children } = props;\n *\n *   const [colorSchemeMode, setColorSchemeMode] = useState<ColorSchemeMode>(\n *     () => Cookies.get(\"colorSchemeMode\") || \"system\"\n *   );\n *   const value = useColorSchemeProvider({\n *     colorSchemeMode,\n *     setColorSchemeMode(nextValue) {\n *       setColorSchemeMode((prevValue) => {\n *         const value = typeof nextValue === \"function\"\n *           ? nextValue(prevValue)\n *           : nextValue;\n *\n *         Cookies.set(\"colorSchemeMode\", value);\n *         return value;\n *       });\n *     }\n *   });\n *\n *   return <ColorSchemeProvider value={value}>{children}</ColorSchemeProvider>\n * }\n * ```\n * @since 6.0.0\n */\nexport function useColorSchemeProvider(\n  options?: { [key in keyof ColorSchemeModeBehavior]?: never } & {\n    disableMetaTag?: boolean;\n    defaultColorSchemeMode?: UseStateInitializer<ColorSchemeMode>;\n  }\n): ColorSchemeContext;\nexport function useColorSchemeProvider(\n  options: ColorSchemeModeBehavior & {\n    disableMetaTag?: boolean;\n    defaultColorSchemeMode?: never;\n  }\n): ColorSchemeContext;\nexport function useColorSchemeProvider(\n  options: ColorSchemeProviderOptions = {}\n): ColorSchemeContext {\n  const {\n    disableMetaTag,\n    colorSchemeMode: value,\n    setColorSchemeMode: setValue,\n    defaultColorSchemeMode,\n  } = options;\n\n  const [colorSchemeMode, setColorSchemeMode] = useEnsuredState({\n    value,\n    setValue,\n    defaultValue: defaultColorSchemeMode,\n  });\n  const prefersDarkTheme = usePrefersDarkTheme(colorSchemeMode !== \"system\");\n  const derivedColorScheme = prefersDarkTheme ? \"dark\" : \"light\";\n  const colorScheme =\n    colorSchemeMode === \"system\" ? derivedColorScheme : colorSchemeMode;\n\n  useColorSchemeMetaTag({\n    disabled: disableMetaTag,\n    colorScheme,\n  });\n\n  return useMemo<ColorSchemeContext>(\n    () => ({\n      colorScheme,\n      colorSchemeMode,\n      setColorSchemeMode,\n    }),\n    [colorScheme, colorSchemeMode, setColorSchemeMode]\n  );\n}\n"],"names":["useMemo","useEnsuredState","useColorSchemeMetaTag","usePrefersDarkTheme","useColorSchemeProvider","options","disableMetaTag","colorSchemeMode","value","setColorSchemeMode","setValue","defaultColorSchemeMode","defaultValue","prefersDarkTheme","derivedColorScheme","colorScheme","disabled"],"mappings":"AAAA;AACA,SAASA,OAAO,QAAQ,QAAQ;AAEhC,SAASC,eAAe,QAAQ,wBAAwB;AAMxD,SAASC,qBAAqB,QAAQ,6BAA6B;AACnE,SAASC,mBAAmB,QAAQ,4BAA4B;AAwEhE,OAAO,SAASC,uBACdC,UAAsC,CAAC,CAAC;IAExC,MAAM,EACJC,cAAc,EACdC,iBAAiBC,KAAK,EACtBC,oBAAoBC,QAAQ,EAC5BC,sBAAsB,EACvB,GAAGN;IAEJ,MAAM,CAACE,iBAAiBE,mBAAmB,GAAGR,gBAAgB;QAC5DO;QACAE;QACAE,cAAcD;IAChB;IACA,MAAME,mBAAmBV,oBAAoBI,oBAAoB;IACjE,MAAMO,qBAAqBD,mBAAmB,SAAS;IACvD,MAAME,cACJR,oBAAoB,WAAWO,qBAAqBP;IAEtDL,sBAAsB;QACpBc,UAAUV;QACVS;IACF;IAEA,OAAOf,QACL,IAAO,CAAA;YACLe;YACAR;YACAE;QACF,CAAA,GACA;QAACM;QAAaR;QAAiBE;KAAmB;AAEtD"}

package/dist/theme/{usePrefersColorScheme.js → usePrefersDarkScheme.js}

@@ -9,4 +9,4 @@ import { useMediaQuery } from "../media-queries/useMediaQuery.js";
     return useMediaQuery("(prefers-color-scheme: dark)", disabled);
 }
 
-//# sourceMappingURL=usePrefersColorScheme.js.map
+//# sourceMappingURL=usePrefersDarkScheme.js.map

package/dist/theme/usePrefersDarkScheme.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/theme/usePrefersDarkScheme.ts"],"sourcesContent":["\"use client\";\nimport { useMediaQuery } from \"../media-queries/useMediaQuery.js\";\n\n/**\n * A simple wrapper around the {@link useMediaQuery} hook with:\n * `\"(prefers-color-scheme: dark)\"`.\n *\n * @since 6.0.0\n */\nexport function usePrefersDarkTheme(disabled = false): boolean {\n  return useMediaQuery(\"(prefers-color-scheme: dark)\", disabled);\n}\n"],"names":["useMediaQuery","usePrefersDarkTheme","disabled"],"mappings":"AAAA;AACA,SAASA,aAAa,QAAQ,oCAAoC;AAElE;;;;;CAKC,GACD,OAAO,SAASC,oBAAoBC,WAAW,KAAK;IAClD,OAAOF,cAAc,gCAAgCE;AACvD"}

package/dist/theme/utils.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/theme/utils.ts"],"sourcesContent":["import { black, white } from \"./colors.js\";\n\nconst RGB_REGEX = /^rgb\\(((\\b([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\b),?){3}\\)$/;\nconst SHORTHAND_REGEX = /^#?([a-f\\d])([a-f\\d])([a-f\\d])$/i;\nconst VERBOSE_REGEX = /^#?([a-f\\d]{2})([a-f\\d]{2})([a-f\\d]{2})$/i;\n\nexport type RGB = readonly [red: number, green: number, blue: number];\n\n/**\n * Converts a hex string into an rgb value. This is useful for detecting color\n * contrast ratios and other stuff.\n *\n * @param hex - The hex string to convert\n * @returns an object containing the r, g, b values for the color.\n */\nexport function hexToRGB(hex: string): RGB {\n  if (\n    process.env.NODE_ENV !== \"production\" &&\n    !SHORTHAND_REGEX.test(hex) &&\n    !VERBOSE_REGEX.test(hex)\n  ) {\n    throw new TypeError(\"Invalid color string.\");\n  }\n\n  hex = hex.replace(\n    SHORTHAND_REGEX,\n    (_m, r, g, b) => `${r}${r}${g}${g}${b}${b}`\n  );\n\n  const result = hex.match(VERBOSE_REGEX) || [];\n  const r = parseInt(result[1] || \"\", 16) || 0;\n  const g = parseInt(result[2] || \"\", 16) || 0;\n  const b = parseInt(result[3] || \"\", 16) || 0;\n\n  return [r, g, b];\n}\n\nexport function getRGB(color: string): RGB {\n  // chrome 102.0.50005.63 apparently has whitespace when calling `window.getComputedStyle(element)`\n  // remove whitepsace to make it easy for supporting rgb or hex\n  color = color.replace(/\\s/g, \"\");\n  const rgbMatches = color.match(RGB_REGEX);\n  if (rgbMatches) {\n    const r = parseInt(rgbMatches[1] || \"\", 16) || 0;\n    const g = parseInt(rgbMatches[2] || \"\", 16) || 0;\n    const b = parseInt(rgbMatches[3] || \"\", 16) || 0;\n\n    return [r, g, b];\n  }\n\n  return hexToRGB(color);\n}\n\nconst RED_MULTIPLIER = 0.2126;\nconst GREEN_MULTIPLIER = 0.7152;\nconst BLUE_MULTIPLIER = 0.0722;\n\n/**\n * I really couldn't figure out how to name these \"magic\" numbers since the\n * formula doesn't really describe it much:\n *\n * @see https://www.w3.org/TR/WCAG20-TECHS/G17.html#G17-tests\n * @internal\n */\nfunction get8BitColor(color: number): number {\n  color /= 255;\n\n  if (color <= 0.03928) {\n    return color / 12.92;\n  }\n\n  return ((color + 0.055) / 1.055) ** 2.4;\n}\n\n/**\n * A number closest to 0 should be closest to black while a number closest to 1\n * should be closest to white.\n *\n * @see https://www.w3.org/TR/WCAG20-TECHS/G17.html#G17-tests\n * @internal\n */\nexport function getLuminance(color: string): number {\n  const [r, g, b] = getRGB(color);\n\n  const red = get8BitColor(r) * RED_MULTIPLIER;\n  const green = get8BitColor(g) * GREEN_MULTIPLIER;\n  const blue = get8BitColor(b) * BLUE_MULTIPLIER;\n\n  return red + green + blue;\n}\n\n/**\n * Gets the contrast ratio between a background color and a foreground color.\n *\n * @see https://www.w3.org/TR/WCAG20-TECHS/G17.html#G17-tests\n *\n * @param background - The background color\n * @param foreground - The foreground color. This is normally the `color` css\n * value.\n * @returns the contrast ratio between the background and foreground colors.\n */\nexport function getContrastRatio(\n  background: string,\n  foreground: string\n): number {\n  const backgroundLuminance = getLuminance(background) + 0.05;\n  const foregroundLuminance = getLuminance(foreground) + 0.05;\n\n  return (\n    Math.max(backgroundLuminance, foregroundLuminance) /\n    Math.min(backgroundLuminance, foregroundLuminance)\n  );\n}\n\n/**\n * The type of contrast ratio compliance to confirm to. The ratios in order are:\n * - 3:1 for large text (18pt normal or 14pt bold)\n * - 4.5:1 for normal text\n * - 7:1 for Level AAA requirements.\n *\n * @see https://www.w3.org/TR/WCAG20/#visual-audio-contrast\n * @see https://www.w3.org/TR/WCAG20/#larger-scaledef\n */\nexport type ContrastRatioCompliance = \"large\" | \"normal\" | \"AAA\";\n\n/**\n * The contrast ratio that can be used for large text where large text is\n * considered 18pt or 14pt bold.\n */\nexport const LARGE_TEXT_CONTRAST_RATIO = 3;\n\n/**\n * The contrast ratio that can be used for normal text.\n */\nexport const NORMAL_TEXT_CONTRAST_RATIO = 4.5;\n\n/**\n * The AAA contrast ratio for passing WGAC 2.0 color contrast ratios.\n */\nexport const AAA_CONTRAST_RATIO = 7;\n\n/**\n * Checks if there is an acceptable contrast ratio between the background and\n * foreground colors based on the provided compliance level.\n *\n * @param background - The background color to check against\n * @param foreground - The foreground color to check against\n * @param compliance - The compliance level to use or a custom number as a\n * ratio.\n * @returns true if there is enough contrast between the foreground and\n * background colors for the provided compliance level.\n */\nexport function isContrastCompliant(\n  background: string,\n  foreground: string,\n  compliance: ContrastRatioCompliance | number = \"normal\"\n): boolean {\n  let ratio: number;\n  switch (compliance) {\n    case \"large\":\n      ratio = LARGE_TEXT_CONTRAST_RATIO;\n      break;\n    case \"normal\":\n      ratio = NORMAL_TEXT_CONTRAST_RATIO;\n      break;\n    case \"AAA\":\n      ratio = AAA_CONTRAST_RATIO;\n      break;\n    default:\n      ratio = compliance;\n  }\n\n  return getContrastRatio(background, foreground) >= ratio;\n}\n\n/**\n * Returns the highest contrast color to the provided `backgroundColor`. This is\n * normally used to ensure that a new background color can use an accessible text\n * color of either `#000` or `#fff`.\n *\n * This is pretty much a javascript implementation as the `contrast-color` Sass\n * function.\n *\n * @since 6.0.0\n */\nexport function contrastColor(\n  backgroundColor: string,\n  lightColor = white,\n  darkColor = black\n): string {\n  const lightContrast = getContrastRatio(backgroundColor, lightColor);\n  const darkContrast = getContrastRatio(backgroundColor, darkColor);\n\n  return lightContrast > darkContrast ? lightColor : darkColor;\n}\n"],"names":["black","white","RGB_REGEX","SHORTHAND_REGEX","VERBOSE_REGEX","hexToRGB","hex","process","env","NODE_ENV","test","TypeError","replace","_m","r","g","b","result","match","parseInt","getRGB","color","rgbMatches","RED_MULTIPLIER","GREEN_MULTIPLIER","BLUE_MULTIPLIER","get8BitColor","getLuminance","red","green","blue","getContrastRatio","background","foreground","backgroundLuminance","foregroundLuminance","Math","max","min","LARGE_TEXT_CONTRAST_RATIO","NORMAL_TEXT_CONTRAST_RATIO","AAA_CONTRAST_RATIO","isContrastCompliant","compliance","ratio","contrastColor","backgroundColor","lightColor","darkColor","lightContrast","darkContrast"],"mappings":"AAAA,SAASA,KAAK,EAAEC,KAAK,QAAQ,cAAc;AAE3C,MAAMC,YAAY;AAClB,MAAMC,kBAAkB;AACxB,MAAMC,gBAAgB;AAItB;;;;;;CAMC,GACD,OAAO,SAASC,SAASC,GAAW;IAClC,IACEC,QAAQC,GAAG,CAACC,QAAQ,KAAK,gBACzB,CAACN,gBAAgBO,IAAI,CAACJ,QACtB,CAACF,cAAcM,IAAI,CAACJ,MACpB;QACA,MAAM,IAAIK,UAAU;IACtB;IAEAL,MAAMA,IAAIM,OAAO,CACfT,iBACA,CAACU,IAAIC,GAAGC,GAAGC,IAAM,CAAC,EAAEF,EAAE,EAAEA,EAAE,EAAEC,EAAE,EAAEA,EAAE,EAAEC,EAAE,EAAEA,EAAE,CAAC;IAG7C,MAAMC,SAASX,IAAIY,KAAK,CAACd,kBAAkB,EAAE;IAC7C,MAAMU,IAAIK,SAASF,MAAM,CAAC,EAAE,IAAI,IAAI,OAAO;IAC3C,MAAMF,IAAII,SAASF,MAAM,CAAC,EAAE,IAAI,IAAI,OAAO;IAC3C,MAAMD,IAAIG,SAASF,MAAM,CAAC,EAAE,IAAI,IAAI,OAAO;IAE3C,OAAO;QAACH;QAAGC;QAAGC;KAAE;AAClB;AAEA,OAAO,SAASI,OAAOC,KAAa;IAClC,kGAAkG;IAClG,8DAA8D;IAC9DA,QAAQA,MAAMT,OAAO,CAAC,OAAO;IAC7B,MAAMU,aAAaD,MAAMH,KAAK,CAAChB;IAC/B,IAAIoB,YAAY;QACd,MAAMR,IAAIK,SAASG,UAAU,CAAC,EAAE,IAAI,IAAI,OAAO;QAC/C,MAAMP,IAAII,SAASG,UAAU,CAAC,EAAE,IAAI,IAAI,OAAO;QAC/C,MAAMN,IAAIG,SAASG,UAAU,CAAC,EAAE,IAAI,IAAI,OAAO;QAE/C,OAAO;YAACR;YAAGC;YAAGC;SAAE;IAClB;IAEA,OAAOX,SAASgB;AAClB;AAEA,MAAME,iBAAiB;AACvB,MAAMC,mBAAmB;AACzB,MAAMC,kBAAkB;AAExB;;;;;;CAMC,GACD,SAASC,aAAaL,KAAa;IACjCA,SAAS;IAET,IAAIA,SAAS,SAAS;QACpB,OAAOA,QAAQ;IACjB;IAEA,OAAO,AAAC,CAAA,AAACA,CAAAA,QAAQ,KAAI,IAAK,KAAI,KAAM;AACtC;AAEA;;;;;;CAMC,GACD,OAAO,SAASM,aAAaN,KAAa;IACxC,MAAM,CAACP,GAAGC,GAAGC,EAAE,GAAGI,OAAOC;IAEzB,MAAMO,MAAMF,aAAaZ,KAAKS;IAC9B,MAAMM,QAAQH,aAAaX,KAAKS;IAChC,MAAMM,OAAOJ,aAAaV,KAAKS;IAE/B,OAAOG,MAAMC,QAAQC;AACvB;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASC,iBACdC,UAAkB,EAClBC,UAAkB;IAElB,MAAMC,sBAAsBP,aAAaK,cAAc;IACvD,MAAMG,sBAAsBR,aAAaM,cAAc;IAEvD,OACEG,KAAKC,GAAG,CAACH,qBAAqBC,uBAC9BC,KAAKE,GAAG,CAACJ,qBAAqBC;AAElC;AAaA;;;CAGC,GACD,OAAO,MAAMI,4BAA4B,EAAE;AAE3C;;CAEC,GACD,OAAO,MAAMC,6BAA6B,IAAI;AAE9C;;CAEC,GACD,OAAO,MAAMC,qBAAqB,EAAE;AAEpC;;;;;;;;;;CAUC,GACD,OAAO,SAASC,oBACdV,UAAkB,EAClBC,UAAkB,EAClBU,aAA+C,QAAQ;IAEvD,IAAIC;IACJ,OAAQD;QACN,KAAK;YACHC,QAAQL;YACR;QACF,KAAK;YACHK,QAAQJ;YACR;QACF,KAAK;YACHI,QAAQH;YACR;QACF;YACEG,QAAQD;IACZ;IAEA,OAAOZ,iBAAiBC,YAAYC,eAAeW;AACrD;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASC,cACdC,eAAuB,EACvBC,aAAa9C,KAAK,EAClB+C,YAAYhD,KAAK;IAEjB,MAAMiD,gBAAgBlB,iBAAiBe,iBAAiBC;IACxD,MAAMG,eAAenB,iBAAiBe,iBAAiBE;IAEvD,OAAOC,gBAAgBC,eAAeH,aAAaC;AACrD"}
+{"version":3,"sources":["../../src/theme/utils.ts"],"sourcesContent":["import { black, white } from \"./colors.js\";\n\nconst RGB_REGEX = /^rgb\\(((\\b([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\b),?){3}\\)$/;\nconst SHORTHAND_REGEX = /^#?([a-f\\d])([a-f\\d])([a-f\\d])$/i;\nconst VERBOSE_REGEX = /^#?([a-f\\d]{2})([a-f\\d]{2})([a-f\\d]{2})$/i;\n\nexport type RGB = readonly [red: number, green: number, blue: number];\n\n/**\n * Converts a hex string into an rgb value. This is useful for detecting color\n * contrast ratios and other stuff.\n *\n * @param hex - The hex string to convert\n * @returns an object containing the r, g, b values for the color.\n */\nexport function hexToRGB(hex: string): RGB {\n  if (\n    process.env.NODE_ENV !== \"production\" &&\n    !SHORTHAND_REGEX.test(hex) &&\n    !VERBOSE_REGEX.test(hex)\n  ) {\n    throw new TypeError(\"Invalid color string.\");\n  }\n\n  hex = hex.replace(\n    SHORTHAND_REGEX,\n    (_m, r, g, b) => `${r}${r}${g}${g}${b}${b}`\n  );\n\n  const result = hex.match(VERBOSE_REGEX) || [];\n  const r = parseInt(result[1] || \"\", 16) || 0;\n  const g = parseInt(result[2] || \"\", 16) || 0;\n  const b = parseInt(result[3] || \"\", 16) || 0;\n\n  return [r, g, b];\n}\n\nexport function getRGB(color: string): RGB {\n  // chrome 102.0.50005.63 apparently has whitespace when calling `window.getComputedStyle(element)`\n  // remove whitepsace to make it easy for supporting rgb or hex\n  color = color.replace(/\\s/g, \"\");\n  const rgbMatches = color.match(RGB_REGEX);\n  if (rgbMatches) {\n    const r = parseInt(rgbMatches[1] || \"\", 16) || 0;\n    const g = parseInt(rgbMatches[2] || \"\", 16) || 0;\n    const b = parseInt(rgbMatches[3] || \"\", 16) || 0;\n\n    return [r, g, b];\n  }\n\n  return hexToRGB(color);\n}\n\nconst RED_MULTIPLIER = 0.2126;\nconst GREEN_MULTIPLIER = 0.7152;\nconst BLUE_MULTIPLIER = 0.0722;\n\n/**\n * I really couldn't figure out how to name these \"magic\" numbers since the\n * formula doesn't really describe it much:\n *\n * @see https://www.w3.org/TR/WCAG20-TECHS/G17.html#G17-tests\n * @internal\n */\nfunction get8BitColor(color: number): number {\n  color /= 255;\n\n  if (color <= 0.03928) {\n    return color / 12.92;\n  }\n\n  return ((color + 0.055) / 1.055) ** 2.4;\n}\n\n/**\n * A number closest to 0 should be closest to black while a number closest to 1\n * should be closest to white.\n *\n * @see https://www.w3.org/TR/WCAG20-TECHS/G17.html#G17-tests\n * @internal\n */\nexport function getLuminance(color: string): number {\n  const [r, g, b] = getRGB(color);\n\n  const red = get8BitColor(r) * RED_MULTIPLIER;\n  const green = get8BitColor(g) * GREEN_MULTIPLIER;\n  const blue = get8BitColor(b) * BLUE_MULTIPLIER;\n\n  return red + green + blue;\n}\n\n/**\n * Gets the contrast ratio between a background color and a foreground color.\n *\n * @see https://www.w3.org/TR/WCAG20-TECHS/G17.html#G17-tests\n *\n * @param background - The background color\n * @param foreground - The foreground color. This is normally the `color` css\n * value.\n * @returns the contrast ratio between the background and foreground colors.\n */\nexport function getContrastRatio(\n  background: string,\n  foreground: string\n): number {\n  const backgroundLuminance = getLuminance(background) + 0.05;\n  const foregroundLuminance = getLuminance(foreground) + 0.05;\n\n  return (\n    Math.max(backgroundLuminance, foregroundLuminance) /\n    Math.min(backgroundLuminance, foregroundLuminance)\n  );\n}\n\n/**\n * The type of contrast ratio compliance to confirm to. The ratios in order are:\n * - 3:1 for large text (18pt normal or 14pt bold)\n * - 4.5:1 for normal text\n * - 7:1 for Level AAA requirements.\n *\n * @see https://www.w3.org/TR/WCAG20/#visual-audio-contrast\n * @see https://www.w3.org/TR/WCAG20/#larger-scaledef\n */\nexport type ContrastRatioCompliance = \"large\" | \"normal\" | \"AAA\";\n\n/**\n * The contrast ratio that can be used for large text where large text is\n * considered 18pt or 14pt bold.\n */\nexport const LARGE_TEXT_CONTRAST_RATIO = 3;\n\n/**\n * The contrast ratio that can be used for normal text.\n */\nexport const NORMAL_TEXT_CONTRAST_RATIO = 4.5;\n\n/**\n * The AAA contrast ratio for passing WGAC 2.0 color contrast ratios.\n */\nexport const AAA_CONTRAST_RATIO = 7;\n\n/**\n * Checks if there is an acceptable contrast ratio between the background and\n * foreground colors based on the provided compliance level.\n *\n * @param background - The background color to check against\n * @param foreground - The foreground color to check against\n * @param compliance - The compliance level to use or a custom number as a\n * ratio.\n * @returns true if there is enough contrast between the foreground and\n * background colors for the provided compliance level.\n */\nexport function isContrastCompliant(\n  background: string,\n  foreground: string,\n  compliance: ContrastRatioCompliance | number = \"normal\"\n): boolean {\n  let ratio: number;\n  switch (compliance) {\n    case \"large\":\n      ratio = LARGE_TEXT_CONTRAST_RATIO;\n      break;\n    case \"normal\":\n      ratio = NORMAL_TEXT_CONTRAST_RATIO;\n      break;\n    case \"AAA\":\n      ratio = AAA_CONTRAST_RATIO;\n      break;\n    default:\n      ratio = compliance;\n  }\n\n  return getContrastRatio(background, foreground) >= ratio;\n}\n\n/**\n * Returns the highest contrast color to the provided `backgroundColor`. This is\n * normally used to ensure that a new background color can use an accessible text\n * color of either `#000` or `#fff`.\n *\n * This is pretty much a javascript implementation as the `contrast-color` Sass\n * function.\n *\n * @since 6.0.0\n */\nexport function contrastColor(\n  backgroundColor: string,\n  lightColor = white,\n  darkColor = black\n): string {\n  const lightContrast = getContrastRatio(backgroundColor, lightColor);\n  const darkContrast = getContrastRatio(backgroundColor, darkColor);\n\n  return lightContrast > darkContrast ? lightColor : darkColor;\n}\n"],"names":["black","white","RGB_REGEX","SHORTHAND_REGEX","VERBOSE_REGEX","hexToRGB","hex","process","env","NODE_ENV","test","TypeError","replace","_m","r","g","b","result","match","parseInt","getRGB","color","rgbMatches","RED_MULTIPLIER","GREEN_MULTIPLIER","BLUE_MULTIPLIER","get8BitColor","getLuminance","red","green","blue","getContrastRatio","background","foreground","backgroundLuminance","foregroundLuminance","Math","max","min","LARGE_TEXT_CONTRAST_RATIO","NORMAL_TEXT_CONTRAST_RATIO","AAA_CONTRAST_RATIO","isContrastCompliant","compliance","ratio","contrastColor","backgroundColor","lightColor","darkColor","lightContrast","darkContrast"],"mappings":"AAAA,SAASA,KAAK,EAAEC,KAAK,QAAQ,cAAc;AAE3C,MAAMC,YAAY;AAClB,MAAMC,kBAAkB;AACxB,MAAMC,gBAAgB;AAItB;;;;;;CAMC,GACD,OAAO,SAASC,SAASC,GAAW;IAClC,IACEC,QAAQC,GAAG,CAACC,QAAQ,KAAK,gBACzB,CAACN,gBAAgBO,IAAI,CAACJ,QACtB,CAACF,cAAcM,IAAI,CAACJ,MACpB;QACA,MAAM,IAAIK,UAAU;IACtB;IAEAL,MAAMA,IAAIM,OAAO,CACfT,iBACA,CAACU,IAAIC,GAAGC,GAAGC,IAAM,GAAGF,IAAIA,IAAIC,IAAIA,IAAIC,IAAIA,GAAG;IAG7C,MAAMC,SAASX,IAAIY,KAAK,CAACd,kBAAkB,EAAE;IAC7C,MAAMU,IAAIK,SAASF,MAAM,CAAC,EAAE,IAAI,IAAI,OAAO;IAC3C,MAAMF,IAAII,SAASF,MAAM,CAAC,EAAE,IAAI,IAAI,OAAO;IAC3C,MAAMD,IAAIG,SAASF,MAAM,CAAC,EAAE,IAAI,IAAI,OAAO;IAE3C,OAAO;QAACH;QAAGC;QAAGC;KAAE;AAClB;AAEA,OAAO,SAASI,OAAOC,KAAa;IAClC,kGAAkG;IAClG,8DAA8D;IAC9DA,QAAQA,MAAMT,OAAO,CAAC,OAAO;IAC7B,MAAMU,aAAaD,MAAMH,KAAK,CAAChB;IAC/B,IAAIoB,YAAY;QACd,MAAMR,IAAIK,SAASG,UAAU,CAAC,EAAE,IAAI,IAAI,OAAO;QAC/C,MAAMP,IAAII,SAASG,UAAU,CAAC,EAAE,IAAI,IAAI,OAAO;QAC/C,MAAMN,IAAIG,SAASG,UAAU,CAAC,EAAE,IAAI,IAAI,OAAO;QAE/C,OAAO;YAACR;YAAGC;YAAGC;SAAE;IAClB;IAEA,OAAOX,SAASgB;AAClB;AAEA,MAAME,iBAAiB;AACvB,MAAMC,mBAAmB;AACzB,MAAMC,kBAAkB;AAExB;;;;;;CAMC,GACD,SAASC,aAAaL,KAAa;IACjCA,SAAS;IAET,IAAIA,SAAS,SAAS;QACpB,OAAOA,QAAQ;IACjB;IAEA,OAAO,AAAC,CAAA,AAACA,CAAAA,QAAQ,KAAI,IAAK,KAAI,KAAM;AACtC;AAEA;;;;;;CAMC,GACD,OAAO,SAASM,aAAaN,KAAa;IACxC,MAAM,CAACP,GAAGC,GAAGC,EAAE,GAAGI,OAAOC;IAEzB,MAAMO,MAAMF,aAAaZ,KAAKS;IAC9B,MAAMM,QAAQH,aAAaX,KAAKS;IAChC,MAAMM,OAAOJ,aAAaV,KAAKS;IAE/B,OAAOG,MAAMC,QAAQC;AACvB;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASC,iBACdC,UAAkB,EAClBC,UAAkB;IAElB,MAAMC,sBAAsBP,aAAaK,cAAc;IACvD,MAAMG,sBAAsBR,aAAaM,cAAc;IAEvD,OACEG,KAAKC,GAAG,CAACH,qBAAqBC,uBAC9BC,KAAKE,GAAG,CAACJ,qBAAqBC;AAElC;AAaA;;;CAGC,GACD,OAAO,MAAMI,4BAA4B,EAAE;AAE3C;;CAEC,GACD,OAAO,MAAMC,6BAA6B,IAAI;AAE9C;;CAEC,GACD,OAAO,MAAMC,qBAAqB,EAAE;AAEpC;;;;;;;;;;CAUC,GACD,OAAO,SAASC,oBACdV,UAAkB,EAClBC,UAAkB,EAClBU,aAA+C,QAAQ;IAEvD,IAAIC;IACJ,OAAQD;QACN,KAAK;YACHC,QAAQL;YACR;QACF,KAAK;YACHK,QAAQJ;YACR;QACF,KAAK;YACHI,QAAQH;YACR;QACF;YACEG,QAAQD;IACZ;IAEA,OAAOZ,iBAAiBC,YAAYC,eAAeW;AACrD;AAEA;;;;;;;;;CASC,GACD,OAAO,SAASC,cACdC,eAAuB,EACvBC,aAAa9C,KAAK,EAClB+C,YAAYhD,KAAK;IAEjB,MAAMiD,gBAAgBlB,iBAAiBe,iBAAiBC;IACxD,MAAMG,eAAenB,iBAAiBe,iBAAiBE;IAEvD,OAAOC,gBAAgBC,eAAeH,aAAaC;AACrD"}

package/dist/tooltip/useTooltip.d.ts

@@ -66,13 +66,13 @@ export interface TooltipPositioningOptions {
  * event.
  */
 export interface TooltippedElementEventHandlers<E extends HTMLElement = HTMLButtonElement> {
-    onBlur?(event: FocusEvent<E>): void;
-    onFocus?(event: FocusEvent<E>): void;
-    onMouseEnter?(event: MouseEvent<E>): void;
-    onMouseLeave?(event: MouseEvent<E>): void;
-    onTouchStart?(event: TouchEvent<E>): void;
-    onTouchEnd?(event: TouchEvent<E>): void;
-    onContextMenu?(event: MouseEvent<E>): void;
+    onBlur?: (event: FocusEvent<E>) => void;
+    onFocus?: (event: FocusEvent<E>) => void;
+    onMouseEnter?: (event: MouseEvent<E>) => void;
+    onMouseLeave?: (event: MouseEvent<E>) => void;
+    onTouchStart?: (event: TouchEvent<E>) => void;
+    onTouchEnd?: (event: TouchEvent<E>) => void;
+    onContextMenu?: (event: MouseEvent<E>) => void;
 }
 /**
  * @since 2.8.0
@@ -184,6 +184,11 @@ export interface TooltipOptions<TooltippedElement extends HTMLElement = HTMLButt
      * @since 6.0.0
      */
     overflowOnly?: boolean;
+    /**
+     * @see {@link FixedPositioningOptions.disabled}
+     * @defaultValue `false`
+     */
+    disableFixedPositioning?: boolean;
 }
 /**
  * @since 2.8.0
@@ -193,7 +198,7 @@ export interface ProvidedTooltipProps<E extends HTMLElement = HTMLSpanElement> e
     id: string;
     ref: Ref<E>;
     dense: boolean;
-    style: CSSProperties;
+    style: CSSProperties | undefined;
     visible: boolean;
     position: SimplePosition;
 }
@@ -215,7 +220,7 @@ export interface TooltipImplementation<TooltippedElement extends HTMLElement = H
      * This is a wrapper around the {@link setVisible} behavior that will also
      * clear any pending timeouts.
      */
-    hideTooltip(): void;
+    hideTooltip: () => void;
     /**
      * @since 6.0.0
      */

package/dist/tooltip/useTooltip.js

@@ -100,7 +100,7 @@ const noop = ()=>{
  * element when the click or history update happens. this causes the tooltip to
  * stay visible
  */ export function useTooltip(options = {}) {
-    const { id: propId, style: propStyle, disabled = false, describedBy, dense = false, hoverTimeout, leaveTimeout, vwMargin = DEFAULT_TOOLTIP_MARGIN, vhMargin = DEFAULT_TOOLTIP_MARGIN, spacing = DEFAULT_TOOLTIP_SPACING, denseSpacing = DEFAULT_TOOLTIP_DENSE_SPACING, disableSwapping, disableAutoSpacing, position: determinedPosition, defaultPosition = DEFAULT_TOOLTIP_POSITION, threshold = DEFAULT_TOOLTIP_THRESHOLD, onBlur = noop, onFocus = noop, onMouseEnter = noop, onMouseLeave = noop, onTouchStart = noop, onTouchEnd = noop, onContextMenu = noop, onEnter = noop, onEntering, onEntered = noop, onExited, overflowOnly } = options;
+    const { id: propId, style: propStyle, disabled = false, describedBy, dense = false, hoverTimeout, leaveTimeout, vwMargin = DEFAULT_TOOLTIP_MARGIN, vhMargin = DEFAULT_TOOLTIP_MARGIN, spacing = DEFAULT_TOOLTIP_SPACING, denseSpacing = DEFAULT_TOOLTIP_DENSE_SPACING, disableSwapping, disableAutoSpacing, position: determinedPosition, defaultPosition = DEFAULT_TOOLTIP_POSITION, threshold = DEFAULT_TOOLTIP_THRESHOLD, onBlur = noop, onFocus = noop, onMouseEnter = noop, onMouseLeave = noop, onTouchStart = noop, onTouchEnd = noop, onContextMenu = noop, onEnter = noop, onEntering, onEntered = noop, onExited, overflowOnly, disableFixedPositioning } = options;
     const fallbackId = useId();
     const id = propId || fallbackId;
     const tooltipId = `${id}-tooltip`;
@@ -131,6 +131,7 @@ const noop = ()=>{
         fixedTo: elementRef,
         anchor: getAnchor(position),
         disableSwapping: disableSwapping ?? !!determinedPosition,
+        disabled: disableFixedPositioning,
         getFixedPositionOptions () {
             let tooltipSpacing = dense ? denseSpacing : spacing;
             const tooltip = tooltipRef.current;

package/dist/tooltip/useTooltip.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/tooltip/useTooltip.ts"],"sourcesContent":["\"use client\";\nimport { cnb } from \"cnbuilder\";\nimport {\n  useCallback,\n  useEffect,\n  useId,\n  useRef,\n  type CSSProperties,\n  type FocusEvent,\n  type MouseEvent,\n  type MutableRefObject,\n  type Ref,\n  type RefObject,\n  type TouchEvent,\n} from \"react\";\nimport {\n  useHoverMode,\n  type ControlledHoverModeImplementation,\n} from \"../hoverMode/useHoverMode.js\";\nimport {\n  useUserInteractionMode,\n  type UserInteractionMode,\n} from \"../interaction/UserInteractionModeProvider.js\";\nimport { type SimplePosition } from \"../positioning/types.js\";\nimport {\n  useFixedPositioning,\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  type FixedPositioningOptions,\n  type FixedPositioningTransitionCallbacks,\n} 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 {\n  useTooltipPosition,\n  type TooltipPositionHookOptions,\n} 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   * @see {@link FixedPositioningOptions.vwMargin}\n   * @defaultValue `16`\n   */\n  vwMargin?: number;\n\n  /**\n   * @see {@link FixedPositioningOptions.vhMargin}\n   * @defaultValue `16`\n   */\n  vhMargin?: number;\n\n  /**\n   * Set this to `true` to reduce the font size and padding on the tooltip and\n   * the amount of spacing between the tooltipped element and the tooltip.\n   *\n   * @defaultValue `false`\n   */\n  dense?: boolean;\n\n  /**\n   * The amount of spacing to use between the tooltipped element and the tooltip\n   * when {@link disableAutoSpacing} is `false`.\n   *\n   * @defaultValue `\"1.5rem`\n   */\n  spacing?: number | string;\n\n  /**\n   * The amount of spacing to use between the tooltipped element and the tooltip\n   * when {@link disableAutoSpacing} is `false` and {@link dense} is `true`.\n   *\n   * @defaultValue `\"0.875rem`\n   */\n  denseSpacing?: number | string;\n\n  /**\n   * Set this to `true` to prevent the {@link defaultPosition} to swap to the\n   * other side of the tooltipped element when it is too close to the viewport\n   * edge. This will always be `true` if a {@link position} is provided.\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/**\n * @since 2.8.0\n * @since 6.0.0 Renamed from `TooltipHookProvidedElementProps`\n */\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 `1000`\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"],"mappings":"AAAA;AACA,SAASA,GAAG,QAAQ,YAAY;AAChC,SACEC,WAAW,EACXC,SAAS,EACTC,KAAK,EACLC,MAAM,QAQD,QAAQ;AACf,SACEC,YAAY,QAEP,+BAA+B;AACtC,SACEC,sBAAsB,QAEjB,gDAAgD;AAEvD,SACEC,mBAAmB,QAId,wCAAwC;AAE/C,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;AACxB,SACEC,kBAAkB,QAEb,0BAA0B;AACjC,SAASC,SAAS,QAAQ,aAAa;AAUvC,MAAMC,OAAO;AACX,aAAa;AACf;AAoPA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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"}
+{"version":3,"sources":["../../src/tooltip/useTooltip.ts"],"sourcesContent":["\"use client\";\nimport { cnb } from \"cnbuilder\";\nimport {\n  useCallback,\n  useEffect,\n  useId,\n  useRef,\n  type CSSProperties,\n  type FocusEvent,\n  type MouseEvent,\n  type MutableRefObject,\n  type Ref,\n  type RefObject,\n  type TouchEvent,\n} from \"react\";\nimport {\n  useHoverMode,\n  type ControlledHoverModeImplementation,\n} from \"../hoverMode/useHoverMode.js\";\nimport {\n  useUserInteractionMode,\n  type UserInteractionMode,\n} from \"../interaction/UserInteractionModeProvider.js\";\nimport { type SimplePosition } from \"../positioning/types.js\";\nimport {\n  useFixedPositioning,\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  type FixedPositioningOptions,\n  type FixedPositioningTransitionCallbacks,\n} 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 {\n  useTooltipPosition,\n  type TooltipPositionHookOptions,\n} 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   * @see {@link FixedPositioningOptions.vwMargin}\n   * @defaultValue `16`\n   */\n  vwMargin?: number;\n\n  /**\n   * @see {@link FixedPositioningOptions.vhMargin}\n   * @defaultValue `16`\n   */\n  vhMargin?: number;\n\n  /**\n   * Set this to `true` to reduce the font size and padding on the tooltip and\n   * the amount of spacing between the tooltipped element and the tooltip.\n   *\n   * @defaultValue `false`\n   */\n  dense?: boolean;\n\n  /**\n   * The amount of spacing to use between the tooltipped element and the tooltip\n   * when {@link disableAutoSpacing} is `false`.\n   *\n   * @defaultValue `\"1.5rem`\n   */\n  spacing?: number | string;\n\n  /**\n   * The amount of spacing to use between the tooltipped element and the tooltip\n   * when {@link disableAutoSpacing} is `false` and {@link dense} is `true`.\n   *\n   * @defaultValue `\"0.875rem`\n   */\n  denseSpacing?: number | string;\n\n  /**\n   * Set this to `true` to prevent the {@link defaultPosition} to swap to the\n   * other side of the tooltipped element when it is too close to the viewport\n   * edge. This will always be `true` if a {@link position} is provided.\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/**\n * @since 2.8.0\n * @since 6.0.0 Renamed from `TooltipHookProvidedElementProps`\n */\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 `1000`\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   * @see {@link FixedPositioningOptions.disabled}\n   * @defaultValue `false`\n   */\n  disableFixedPositioning?: 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 | undefined;\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    disableFixedPositioning,\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    disabled: disableFixedPositioning,\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","disableFixedPositioning","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"],"mappings":"AAAA;AACA,SAASA,GAAG,QAAQ,YAAY;AAChC,SACEC,WAAW,EACXC,SAAS,EACTC,KAAK,EACLC,MAAM,QAQD,QAAQ;AACf,SACEC,YAAY,QAEP,+BAA+B;AACtC,SACEC,sBAAsB,QAEjB,gDAAgD;AAEvD,SACEC,mBAAmB,QAId,wCAAwC;AAE/C,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;AACxB,SACEC,kBAAkB,QAEb,0BAA0B;AACjC,SAASC,SAAS,QAAQ,aAAa;AAUvC,MAAMC,OAAO;AACX,aAAa;AACf;AA0PA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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,EACZC,uBAAuB,EACxB,GAAGhC;IAEJ,MAAMiC,aAAanD;IACnB,MAAMmB,KAAKC,UAAU+B;IACrB,MAAMC,YAAY,GAAGjC,GAAG,QAAQ,CAAC;IACjC,MAAM,EACJkC,eAAe,EACfC,eAAe,EACfC,eAAe,EACfC,eAAe,EACfC,gBAAgB,EAChBC,iBAAiB,EACjBC,iBAAiB,EAClB,GAAGpD;IACJ,MAAM,EACJqD,OAAO,EACPC,UAAU,EACVC,aAAa,EACbC,aAAa,EACbC,sBAAsB,EACvB,GAAG9D,aAAa;QACfwB;QACA4B;QACA3B;QACA4B;QACAC;QACAC;QACAC;QACAC;IACF;IACA,MAAM,CAACzB,UAAU+B,eAAe,GAAGnD,mBAAmB;QACpDoB,UAAUC;QACVC;QACAC;IACF;IAEA,MAAM6B,OAAO/D;IACb,MAAMgE,aAAalE,OAA2B;IAC9C,MAAMmE,aAAanE,OAAuB;IAC1C,MAAMoE,cAAcpE,OAAoB;IACxC,MAAMqE,cAAcrE,OAAmC;IACvD,MAAM,EAAEsE,GAAG,EAAElD,KAAK,EAAEmD,SAAS,EAAE,GAAGpE,oBAAoB;QACpDqE,SAASL;QACT/C,OAAOC;QACPoD,SAASP;QACTQ,QAAQ5D,UAAUmB;QAClBF,iBAAiBA,mBAAmB,CAAC,CAACG;QACtCZ,UAAU2B;QACV0B;YACE,IAAIC,iBAAiBpD,QAAQM,eAAeD;YAC5C,MAAMgD,UAAUV,WAAWW,OAAO;YAClC,IAAI,CAAC9C,sBAAsB6C,SAAS;gBAClCD,iBACEG,OACGC,gBAAgB,CAACH,SACjBI,gBAAgB,CAACrE,wBAAwBiB;YAChD;YAEA,MAAMqD,iBAAiB7E,mBAAmB;gBACxC8E,OAAOP;YACT;YACA,MAAMQ,aAAanD,aAAa,UAAUA,aAAa;YAEvD,OAAO;gBACLN;gBACAC;gBACAyD,SAASD,aAAaF,iBAAiBI;gBACvCC,SAASH,aAAaE,YAAYJ;YACpC;QACF;QACAtC,SAAQ4C,SAAS;YACf5C,QAAQ4C;YAER,oEAAoE;YACpE,sEAAsE;YACtE,uDAAuD;YACvD,IAAIC,QAAQC,GAAG,CAACC,QAAQ,KAAK,gBAAgB,CAACzB,WAAWY,OAAO,EAAE;gBAChEZ,WAAWY,OAAO,GAAGc,SAASC,cAAc,CAAC3E;YAC/C;QACF;QACA2B;QACAC,WAAU0C,SAAS;YACjB1C,UAAU0C;YAEVpC,gBAAgB0B,OAAO,GAAG;QAC5B;QACA/B;IACF;IAEA,MAAM+C,cAAcjG,YAAY;QAC9BwE,YAAYS,OAAO,GAAG;QACtBtB;QACAO;QACAH,WAAW;IACb,GAAG;QAACG;QAAwBP;QAAkBI;KAAW;IAEzD9D,UAAU;QACR,IAAI,CAAC6D,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,eAAepG,OAAO;IAC5B,MAAMqG,eAAerG,OAAO;IAC5BI,gBAAgB;QACdkB;QACAgF,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,CAAC3D,cAAc;YACjB,OAAO;QACT;QAEA,MAAM4D,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;YACZ9F,IAAIiC;YACJmB;YACA9C;YACAJ;YACAuC;YACA1B;YACA,GAAGsC,SAAS;QACd;QACA0C,cAAc;YACZ,oBAAoBrH,IAAI+D,WAAWR,WAAW5B,gBAAgB+D;YAC9DpE;YACAqB,cAAayD,KAAK;gBAChBzD,aAAayD;gBACb,IACE1E,YACA2C,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,cAAc3C;YAChB;YACAsB,cAAawD,KAAK;gBAChBxD,aAAawD;gBACb,IAAI1E,YAAY+C,YAAYS,OAAO,KAAK,SAAS;oBAC/C;gBACF;gBAEAhB;gBACAO,YAAYS,OAAO,GAAG;YACxB;YACAzC,QAAO2D,KAAK;gBACV3D,OAAO2D;gBACP,IAAI1E,UAAU;oBACZ;gBACF;gBAEA+C,YAAYS,OAAO,GAAG;gBACtBhB;YACF;YACAxB,SAAQ0D,KAAK;gBACX1D,QAAQ0D;gBACR,mEAAmE;gBACnE,8CAA8C;gBAC9C,IACE1E,YACA2C,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,cAAc3C;YAChB;YACAuB,cAAauD,KAAK;gBAChBvD,aAAauD;gBACb,IACE1E,YACA+C,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,cAAc3C;YAChB;YACAwB,YAAWsD,KAAK;gBACdtD,WAAWsD;gBACX,IAAI1E,UAAU;oBACZ;gBACF;gBAEA+C,YAAYS,OAAO,GAAG;gBACtBhB;YACF;YACAnB,eAAcqD,KAAK;gBACjBrD,cAAcqD;gBACd,IACE1E,YACA+C,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/transition/SlideContainer.d.ts

@@ -56,8 +56,8 @@ export declare function slideContainer(options: SlideContainerClassNameOptions):
 export interface SlideContainerProps extends HTMLAttributes<HTMLDivElement>, SlideContainerClassNameOptions {
 }
 /**
- * **Server Component**
- * This is a server component, but generally relies on state so probably a client component.
+ * The `SlideContainer` is used to enable a slide transition when child `Slide`
+ * components change.
  *
  * @example Simple Example
  * ```tsx
@@ -102,52 +102,6 @@ export interface SlideContainerProps extends HTMLAttributes<HTMLDivElement>, Sli
  * }
  * ```
  *
- * @example Persistent Slides
- * ```tsx
- * import type { SlideDirection } from "@react-md/core";
- * import { SlideContainer, Slide } from "@react-md/core";
- * import type { ReactElement, ReactNode } from "react";
- * import { useState } from "react";
- *
- * interface State {
- *   direction: SlideDirection;
- *   activeIndex: number;
- * }
- *
- * function Example(): ReactElement {
- *   const [state, setState] = useState<State>({
- *     direction: "left",
- *     activeIndex: 0,
- *   });
- *   const { direction, activeIndex } = state;
- *
- *   // when changing a slide, `direction` should be set to "left" if the
- *   // previous `activeIndex` is less than the next index
- *   //
- *   // i.e.
- *   // setState((prevState) => ({
- *   //   direction: prevState.activeIndex < index ? "left" : "right",
- *   //   activeIndex: index,
- *   // }))
- *
- *   // enabling `persistent` makes it so that the `<Slide>` never unmounts so
- *   // that state can be maintained while it is not active.
- *   return (
- *     <SlideContainer direction={direction}>
- *       <Slide active={activeIndex === 0} persistent>
- *         Slide 1
- *       </Slide>
- *       <Slide active={activeIndex === 1} persistent>
- *         Slide 2
- *       </Slide>
- *       <Slide active={activeIndex === 2} persistent>
- *         Slide 3
- *       </Slide>
- *     </SlideContainer>
- *   );
- * }
- * ```
- *
  * @since 6.0.0
  */
 export declare const SlideContainer: import("react").ForwardRefExoticComponent<SlideContainerProps & import("react").RefAttributes<HTMLDivElement>>;

package/dist/transition/SlideContainer.js

@@ -13,8 +13,8 @@ const styles = bem("rmd-slide-container");
     }), className);
 }
 /**
- * **Server Component**
- * This is a server component, but generally relies on state so probably a client component.
+ * The `SlideContainer` is used to enable a slide transition when child `Slide`
+ * components change.
  *
  * @example Simple Example
  * ```tsx
@@ -59,52 +59,6 @@ const styles = bem("rmd-slide-container");
  * }
  * ```
  *
- * @example Persistent Slides
- * ```tsx
- * import type { SlideDirection } from "@react-md/core";
- * import { SlideContainer, Slide } from "@react-md/core";
- * import type { ReactElement, ReactNode } from "react";
- * import { useState } from "react";
- *
- * interface State {
- *   direction: SlideDirection;
- *   activeIndex: number;
- * }
- *
- * function Example(): ReactElement {
- *   const [state, setState] = useState<State>({
- *     direction: "left",
- *     activeIndex: 0,
- *   });
- *   const { direction, activeIndex } = state;
- *
- *   // when changing a slide, `direction` should be set to "left" if the
- *   // previous `activeIndex` is less than the next index
- *   //
- *   // i.e.
- *   // setState((prevState) => ({
- *   //   direction: prevState.activeIndex < index ? "left" : "right",
- *   //   activeIndex: index,
- *   // }))
- *
- *   // enabling `persistent` makes it so that the `<Slide>` never unmounts so
- *   // that state can be maintained while it is not active.
- *   return (
- *     <SlideContainer direction={direction}>
- *       <Slide active={activeIndex === 0} persistent>
- *         Slide 1
- *       </Slide>
- *       <Slide active={activeIndex === 1} persistent>
- *         Slide 2
- *       </Slide>
- *       <Slide active={activeIndex === 2} persistent>
- *         Slide 3
- *       </Slide>
- *     </SlideContainer>
- *   );
- * }
- * ```
- *
  * @since 6.0.0
  */ export const SlideContainer = /*#__PURE__*/ forwardRef(function SlideContainer(props, ref) {
     const { className, direction, children, ...remaining } = props;