@react-md/core 1.0.0-next.0 → 1.0.0-next.2

package/dist/theme/ThemeProvider.d.ts

@@ -3,6 +3,8 @@ import { type UseStateSetter } from "../types.js";
 declare module "react" {
     interface CSSProperties {
         "--rmd-background-color"?: string;
+        "--rmd-on-background-color"?: string;
+        "--rmd-surface-color"?: string;
         "--rmd-primary-color"?: string;
         "--rmd-on-primary-color"?: string;
         "--rmd-secondary-color"?: string;
@@ -17,6 +19,9 @@ declare module "react" {
         "--rmd-text-secondary-color"?: string;
         "--rmd-text-hint-color"?: string;
         "--rmd-text-disabled-color"?: string;
+        "--rmd-outline-width"?: string | number;
+        "--rmd-outline-color"?: string;
+        "--rmd-outline-grey-color"?: string;
     }
 }
 /** @remarks \@since 6.0.0 */

package/dist/theme/ThemeProvider.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/theme/ThemeProvider.tsx"],"sourcesContent":["\"use client\";\nimport {\n  createContext,\n  useContext,\n  useEffect,\n  useMemo,\n  useState,\n  type ReactElement,\n  type ReactNode,\n} from \"react\";\nimport { useSsr } from \"../SsrProvider.js\";\nimport { type UseStateSetter } from \"../types.js\";\nimport {\n  black,\n  blue500,\n  greenAccent700,\n  orangeAccent200,\n  orangeAccent400,\n  red500,\n} from \"./colors.js\";\nimport {\n  backgroundColorVar,\n  errorColorVar,\n  onErrorColorVar,\n  onPrimaryColorVar,\n  onSecondaryColorVar,\n  onSuccessColorVar,\n  onWarningColorVar,\n  primaryColorVar,\n  secondaryColorVar,\n  successColorVar,\n  textDisabledColorVar,\n  textHintColorVar,\n  textPrimaryColorVar,\n  textSecondaryColorVar,\n  warningColorVar,\n} from \"./cssVars.js\";\nimport { useColorScheme } from \"./useColorScheme.js\";\n\ndeclare module \"react\" {\n  interface CSSProperties {\n    \"--rmd-background-color\"?: string;\n    \"--rmd-primary-color\"?: string;\n    \"--rmd-on-primary-color\"?: string;\n    \"--rmd-secondary-color\"?: string;\n    \"--rmd-on-secondary-color\"?: string;\n    \"--rmd-warning-color\"?: string;\n    \"--rmd-on-warning-color\"?: string;\n    \"--rmd-error-color\"?: string;\n    \"--rmd-on-error-color\"?: string;\n    \"--rmd-success-color\"?: string;\n    \"--rmd-on-success-color\"?: string;\n    \"--rmd-text-primary-color\"?: string;\n    \"--rmd-text-secondary-color\"?: string;\n    \"--rmd-text-hint-color\"?: string;\n    \"--rmd-text-disabled-color\"?: string;\n  }\n}\n\n/** @remarks \\@since 6.0.0 */\nexport interface ThemeColors {\n  primaryColor: string;\n  onPrimaryColor: string;\n  secondaryColor: string;\n  onSecondaryColor: string;\n  warningColor: string;\n  onWarningColor: string;\n  errorColor: string;\n  onErrorColor: string;\n  successColor: string;\n  onSuccessColor: string;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport interface ThemeTextColors {\n  textPrimaryColor: string;\n  textSecondaryColor: string;\n  textHintColor: string;\n  textDisabledColor: string;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport interface ConfigurableThemeColors extends ThemeColors, ThemeTextColors {\n  backgroundColor: string;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport type ConfigurableThemeColorsName = keyof ConfigurableThemeColors;\n\n/** @remarks \\@since 6.0.0 */\nexport interface ThemeContext extends ConfigurableThemeColors {\n  /**\n   * This will be `true` if a `theme` wsa not provided to the {@link ThemeProvider}\n   */\n  derived: boolean;\n\n  /**\n   * @example\n   * Simple Example\n   * ```tsx\n   * import { getDerivedTheme, useHtmlClassName, useTheme } from \"@react-md/core\";\n   * import { useEffect } from \"react\";\n   *\n   * import styles from \"./LightTheme.module.scss\";\n   *\n   * let loadedOnce = false;\n   *\n   * export default function LightTheme(): null {\n   *   useHtmlClassName(styles.container);\n   *   const { setDerivedTheme } = useTheme();\n   *   useEffect(() => {\n   *     if (loadedOnce) {\n   *       return;\n   *     }\n   *\n   *     loadedOnce = true;\n   *     setDerivedTheme(getDerivedTheme());\n   *   }, [setDerivedTheme]);\n   *   return null;\n   * }\n   * ```\n   */\n  setDerivedTheme: UseStateSetter<Readonly<ConfigurableThemeColors>>;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport const DEFAULT_THEME_COLORS: Readonly<ThemeColors> = {\n  primaryColor: blue500,\n  onPrimaryColor: black,\n  secondaryColor: orangeAccent400,\n  onSecondaryColor: black,\n  warningColor: orangeAccent200,\n  onWarningColor: black,\n  errorColor: red500,\n  onErrorColor: black,\n  successColor: greenAccent700,\n  onSuccessColor: black,\n};\n\n/** @remarks \\@since 6.0.0 */\nexport const DEFAULT_LIGHT_THEME: Readonly<ConfigurableThemeColors> = {\n  ...DEFAULT_THEME_COLORS,\n  backgroundColor: \"#fafafa\",\n  textPrimaryColor: \"#212121\",\n  textSecondaryColor: \"#757575\",\n  textHintColor: \"#a8a8a8\",\n  textDisabledColor: \"#9e9e9e\",\n};\n\n/** @remarks \\@since 6.0.0 */\nexport const DEFAULT_DARK_THEME: Readonly<ConfigurableThemeColors> = {\n  ...DEFAULT_THEME_COLORS,\n  backgroundColor: \"#121212\",\n  textPrimaryColor: \"#d9d9d9\",\n  textSecondaryColor: \"#b3b3b3\",\n  textHintColor: \"gray\", // #808080\n  textDisabledColor: \"gray\", // #808080\n};\n\nconst context = createContext<Readonly<ThemeContext> | undefined>(undefined);\ncontext.displayName = \"Theme\";\nconst { Provider } = context;\n\n/** @remarks \\@since 6.0.0 */\nexport const getDerivedTheme = (\n  container: Element = document.documentElement\n): Readonly<ConfigurableThemeColors> => {\n  const rootStyles = window.getComputedStyle(container);\n  const backgroundColor = rootStyles.getPropertyValue(backgroundColorVar);\n  const primaryColor = rootStyles.getPropertyValue(primaryColorVar);\n  const onPrimaryColor = rootStyles.getPropertyValue(onPrimaryColorVar);\n  const secondaryColor = rootStyles.getPropertyValue(secondaryColorVar);\n  const onSecondaryColor = rootStyles.getPropertyValue(onSecondaryColorVar);\n  const warningColor = rootStyles.getPropertyValue(warningColorVar);\n  const onWarningColor = rootStyles.getPropertyValue(onWarningColorVar);\n  const errorColor = rootStyles.getPropertyValue(errorColorVar);\n  const onErrorColor = rootStyles.getPropertyValue(onErrorColorVar);\n  const successColor = rootStyles.getPropertyValue(successColorVar);\n  const onSuccessColor = rootStyles.getPropertyValue(onSuccessColorVar);\n  const textPrimaryColor = rootStyles.getPropertyValue(textPrimaryColorVar);\n  const textSecondaryColor = rootStyles.getPropertyValue(textSecondaryColorVar);\n  const textHintColor = rootStyles.getPropertyValue(textHintColorVar);\n  const textDisabledColor = rootStyles.getPropertyValue(textDisabledColorVar);\n\n  return {\n    backgroundColor,\n    primaryColor,\n    onPrimaryColor,\n    secondaryColor,\n    onSecondaryColor,\n    warningColor,\n    onWarningColor,\n    errorColor,\n    onErrorColor,\n    successColor,\n    onSuccessColor,\n    textPrimaryColor,\n    textSecondaryColor,\n    textHintColor,\n    textDisabledColor,\n  };\n};\n\n/**\n * This hook can be used to access the current theme set by the\n * {@link ThemeProvider}.\n *\n * @example\n * Simple Example\n * ```tsx\n * import { useTheme } from \"@react-md/core\";\n * import type { ReactElement } from \"react\";\n *\n * function Example(): ReactElement {\n *   const theme = useTheme();\n *\n *   return <pre><code>{JSON.stringify(theme, null, 2)}</code></pre>;\n * }\n * ```\n *\n * @remarks \\@since 6.0.0\n * @throws \"The `ThemeProvider` has not been initialized.\"\n */\nexport function useTheme(): Readonly<ThemeContext>;\n\n/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nexport function useTheme(\n  allowUndefined: true\n): Readonly<ThemeContext> | undefined;\n\n/**\n * @internal\n * @remarks \\@since 6.0.0\n * @throws \"The `ThemeProvider` has not been initialized.\"\n */\nexport function useTheme(\n  allowUndefined?: boolean\n): Readonly<ThemeContext> | undefined {\n  const theme = useContext(context);\n  if (!theme && !allowUndefined) {\n    throw new Error(\"The `ThemeProvider` has not been initialized.\");\n  }\n\n  return theme;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport interface ThemeProviderProps {\n  /**\n   * When this is `undefined`, the theme will be derived by computing the\n   * `document.documentElement`'s styles for all the `react-md` theme custom\n   * properties. The theme will also automatically update whenever the\n   * `colorScheme` or `colorSchemeMode` change.\n   *\n   * It is recommended to manually provide your theme if you know it beforehand.\n   * Deriving the theme is really only useful if you allow your user to\n   * customize all these theme values themselves and persist through local\n   * storage/cookies.\n   *\n   * @see {@link DEFAULT_DARK_THEME}\n   * @see {@link DEFAULT_LIGHT_THEME}\n   * @defaultValue `colorScheme === \"dark\" ? DEFAULT_DARK_THEME : DEFAULT_LIGHT_THEME`\n   */\n  theme?: Readonly<ConfigurableThemeColors>;\n\n  children: ReactNode;\n}\n\n/**\n * **Client Component**\n *\n * The `ThemeProvider` should be added to the root of your app but as a child of\n * the `CoreProviders`.\n *\n * @example\n * ```tsx\n * import {\n *   black,\n *   blue500,\n *   greenAccent700,\n *   orangeAccent200,\n *   orangeAccent400,\n *   red500,\n *   CoreProviders,\n *   ThemeProvider,\n * } from \"@react-md/core\";\n * import type { ConfigurableThemeColors } from \"@react-md/core\";\n * import type { ReactElement } from \"react\";\n * import { createRoot } from \"react-dom/client\";\n *\n * import App from \"./App\";\n *\n * const theme: Readonly<ConfigurableThemeColors> = {\n *   primaryColor: blue500,\n *   onPrimaryColor: black,\n *   secondaryColor: orangeAccent400,\n *   onSecondaryColor: black,\n *   warningColor: orangeAccent200,\n *   onWarningColor: black,\n *   errorColor: red500,\n *   onErrorColor: black,\n *   successColor: greenAccent700,\n *   onSuccessColor: black,\n *   backgroundColor: \"#121212\",\n *   textPrimaryColor: \"#d9d9d9\",\n *   textSecondaryColor: \"#b3b3b3\",\n *   textHintColor: \"gray\", // #808080\n *   textDisabledColor: \"gray\", // #808080\n * };\n *\n * const container = document.getElementById(\"app\");\n * const root = createRoot(container);\n * root.render(\n *   <CoreProviders>\n *     <ThemeProvider theme={theme}>\n *       <App />\n *     </ThemeProvider>\n *   </CoreProviders>\n * );\n * ```\n *\n * @example\n * Automatically Deriving the Theme\n * ```tsx\n * import {\n *   CoreProviders,\n *   LocalStorageColorSchemeProvider,\n *   ThemeProvider,\n * } from \"@react-md/core\";\n * import { type ReactElement } from \"react\";\n * import { createRoot } from \"react-dom/client\";\n *\n * import App from \"./App\";\n *\n * const container = document.getElementById(\"app\");\n * const root = createRoot(container);\n * root.render(\n *   <CoreProviders>\n *     <LocalStorageColorSchemeProvider>\n *       <ThemeProvider>\n *         <App />\n *       </ThemeProvider>\n *     </LocalStorageColorSchemeProvider>\n *   </CoreProviders>\n * );\n * ```\n *\n * @remarks \\@since 6.0.0\n */\nexport function ThemeProvider(props: ThemeProviderProps): ReactElement {\n  const { children, theme } = props;\n  const ssr = useSsr();\n  const { colorScheme, colorSchemeMode } = useColorScheme();\n  const [derivedTheme, setDerivedTheme] = useState<ConfigurableThemeColors>(\n    () => {\n      if (theme) {\n        return theme;\n      }\n\n      if (!ssr && typeof document !== \"undefined\") {\n        return getDerivedTheme(document.documentElement);\n      }\n\n      return colorScheme === \"dark\" ? DEFAULT_DARK_THEME : DEFAULT_LIGHT_THEME;\n    }\n  );\n\n  const derived = !theme;\n  useEffect(() => {\n    if (theme) {\n      return;\n    }\n\n    // This has to be recalculated after an animation to ensure the new theme\n    // styles have been applied. It will use the previous theme styles without\n    // this frame.\n    //\n    // NOTE: This will not be correct the first time a new theme is lazy-loaded\n    // and applied. It might be good to have a way to manually force this flow\n    // again?\n    const frame = window.requestAnimationFrame(() =>\n      setDerivedTheme(getDerivedTheme(document.documentElement))\n    );\n\n    return () => {\n      window.cancelAnimationFrame(frame);\n    };\n  }, [theme, colorScheme, colorSchemeMode]);\n\n  const value = useMemo<ThemeContext>(() => {\n    const backgroundColor =\n      theme?.backgroundColor ?? derivedTheme.backgroundColor;\n    const primaryColor = theme?.primaryColor ?? derivedTheme.primaryColor;\n    const onPrimaryColor = theme?.onPrimaryColor ?? derivedTheme.onPrimaryColor;\n    const secondaryColor = theme?.secondaryColor ?? derivedTheme.secondaryColor;\n    const onSecondaryColor =\n      theme?.onSecondaryColor ?? derivedTheme.onSecondaryColor;\n    const warningColor = theme?.warningColor ?? derivedTheme.warningColor;\n    const onWarningColor = theme?.onWarningColor ?? derivedTheme.onWarningColor;\n    const errorColor = theme?.errorColor ?? derivedTheme.errorColor;\n    const onErrorColor = theme?.onErrorColor ?? derivedTheme.onErrorColor;\n    const successColor = theme?.successColor ?? derivedTheme.successColor;\n    const onSuccessColor = theme?.onSuccessColor ?? derivedTheme.onSuccessColor;\n    const textPrimaryColor =\n      theme?.textPrimaryColor ?? derivedTheme.textPrimaryColor;\n    const textSecondaryColor =\n      theme?.textSecondaryColor ?? derivedTheme.textSecondaryColor;\n    const textHintColor = theme?.textHintColor ?? derivedTheme.textHintColor;\n    const textDisabledColor =\n      theme?.textDisabledColor ?? derivedTheme.textDisabledColor;\n\n    return {\n      derived,\n      backgroundColor,\n      primaryColor,\n      onPrimaryColor,\n      secondaryColor,\n      onSecondaryColor,\n      warningColor,\n      onWarningColor,\n      errorColor,\n      onErrorColor,\n      successColor,\n      onSuccessColor,\n      textPrimaryColor,\n      textSecondaryColor,\n      textHintColor,\n      textDisabledColor,\n      setDerivedTheme,\n    };\n  }, [\n    derived,\n    derivedTheme.backgroundColor,\n    derivedTheme.errorColor,\n    derivedTheme.onErrorColor,\n    derivedTheme.onPrimaryColor,\n    derivedTheme.onSecondaryColor,\n    derivedTheme.onSuccessColor,\n    derivedTheme.onWarningColor,\n    derivedTheme.primaryColor,\n    derivedTheme.secondaryColor,\n    derivedTheme.successColor,\n    derivedTheme.textDisabledColor,\n    derivedTheme.textHintColor,\n    derivedTheme.textPrimaryColor,\n    derivedTheme.textSecondaryColor,\n    derivedTheme.warningColor,\n    theme?.backgroundColor,\n    theme?.errorColor,\n    theme?.onErrorColor,\n    theme?.onPrimaryColor,\n    theme?.onSecondaryColor,\n    theme?.onSuccessColor,\n    theme?.onWarningColor,\n    theme?.primaryColor,\n    theme?.secondaryColor,\n    theme?.successColor,\n    theme?.textDisabledColor,\n    theme?.textHintColor,\n    theme?.textPrimaryColor,\n    theme?.textSecondaryColor,\n    theme?.warningColor,\n  ]);\n\n  return <Provider value={value}>{children}</Provider>;\n}\n"],"names":["createContext","useContext","useEffect","useMemo","useState","useSsr","black","blue500","greenAccent700","orangeAccent200","orangeAccent400","red500","backgroundColorVar","errorColorVar","onErrorColorVar","onPrimaryColorVar","onSecondaryColorVar","onSuccessColorVar","onWarningColorVar","primaryColorVar","secondaryColorVar","successColorVar","textDisabledColorVar","textHintColorVar","textPrimaryColorVar","textSecondaryColorVar","warningColorVar","useColorScheme","DEFAULT_THEME_COLORS","primaryColor","onPrimaryColor","secondaryColor","onSecondaryColor","warningColor","onWarningColor","errorColor","onErrorColor","successColor","onSuccessColor","DEFAULT_LIGHT_THEME","backgroundColor","textPrimaryColor","textSecondaryColor","textHintColor","textDisabledColor","DEFAULT_DARK_THEME","context","undefined","displayName","Provider","getDerivedTheme","container","document","documentElement","rootStyles","window","getComputedStyle","getPropertyValue","useTheme","allowUndefined","theme","Error","ThemeProvider","props","children","ssr","colorScheme","colorSchemeMode","derivedTheme","setDerivedTheme","derived","frame","requestAnimationFrame","cancelAnimationFrame","value"],"mappings":"AAAA;;AACA,SACEA,aAAa,EACbC,UAAU,EACVC,SAAS,EACTC,OAAO,EACPC,QAAQ,QAGH,QAAQ;AACf,SAASC,MAAM,QAAQ,oBAAoB;AAE3C,SACEC,KAAK,EACLC,OAAO,EACPC,cAAc,EACdC,eAAe,EACfC,eAAe,EACfC,MAAM,QACD,cAAc;AACrB,SACEC,kBAAkB,EAClBC,aAAa,EACbC,eAAe,EACfC,iBAAiB,EACjBC,mBAAmB,EACnBC,iBAAiB,EACjBC,iBAAiB,EACjBC,eAAe,EACfC,iBAAiB,EACjBC,eAAe,EACfC,oBAAoB,EACpBC,gBAAgB,EAChBC,mBAAmB,EACnBC,qBAAqB,EACrBC,eAAe,QACV,eAAe;AACtB,SAASC,cAAc,QAAQ,sBAAsB;AAwFrD,2BAA2B,GAC3B,OAAO,MAAMC,uBAA8C;IACzDC,cAActB;IACduB,gBAAgBxB;IAChByB,gBAAgBrB;IAChBsB,kBAAkB1B;IAClB2B,cAAcxB;IACdyB,gBAAgB5B;IAChB6B,YAAYxB;IACZyB,cAAc9B;IACd+B,cAAc7B;IACd8B,gBAAgBhC;AAClB,EAAE;AAEF,2BAA2B,GAC3B,OAAO,MAAMiC,sBAAyD;IACpE,GAAGX,oBAAoB;IACvBY,iBAAiB;IACjBC,kBAAkB;IAClBC,oBAAoB;IACpBC,eAAe;IACfC,mBAAmB;AACrB,EAAE;AAEF,2BAA2B,GAC3B,OAAO,MAAMC,qBAAwD;IACnE,GAAGjB,oBAAoB;IACvBY,iBAAiB;IACjBC,kBAAkB;IAClBC,oBAAoB;IACpBC,eAAe;IACfC,mBAAmB;AACrB,EAAE;AAEF,MAAME,wBAAU9C,cAAkD+C;AAClED,QAAQE,WAAW,GAAG;AACtB,MAAM,EAAEC,QAAQ,EAAE,GAAGH;AAErB,2BAA2B,GAC3B,OAAO,MAAMI,kBAAkB,CAC7BC,YAAqBC,SAASC,eAAe;IAE7C,MAAMC,aAAaC,OAAOC,gBAAgB,CAACL;IAC3C,MAAMX,kBAAkBc,WAAWG,gBAAgB,CAAC7C;IACpD,MAAMiB,eAAeyB,WAAWG,gBAAgB,CAACtC;IACjD,MAAMW,iBAAiBwB,WAAWG,gBAAgB,CAAC1C;IACnD,MAAMgB,iBAAiBuB,WAAWG,gBAAgB,CAACrC;IACnD,MAAMY,mBAAmBsB,WAAWG,gBAAgB,CAACzC;IACrD,MAAMiB,eAAeqB,WAAWG,gBAAgB,CAAC/B;IACjD,MAAMQ,iBAAiBoB,WAAWG,gBAAgB,CAACvC;IACnD,MAAMiB,aAAamB,WAAWG,gBAAgB,CAAC5C;IAC/C,MAAMuB,eAAekB,WAAWG,gBAAgB,CAAC3C;IACjD,MAAMuB,eAAeiB,WAAWG,gBAAgB,CAACpC;IACjD,MAAMiB,iBAAiBgB,WAAWG,gBAAgB,CAACxC;IACnD,MAAMwB,mBAAmBa,WAAWG,gBAAgB,CAACjC;IACrD,MAAMkB,qBAAqBY,WAAWG,gBAAgB,CAAChC;IACvD,MAAMkB,gBAAgBW,WAAWG,gBAAgB,CAAClC;IAClD,MAAMqB,oBAAoBU,WAAWG,gBAAgB,CAACnC;IAEtD,OAAO;QACLkB;QACAX;QACAC;QACAC;QACAC;QACAC;QACAC;QACAC;QACAC;QACAC;QACAC;QACAG;QACAC;QACAC;QACAC;IACF;AACF,EAAE;AAgCF;;;;CAIC,GACD,OAAO,SAASc,SACdC,cAAwB;IAExB,MAAMC,QAAQ3D,WAAW6C;IACzB,IAAI,CAACc,SAAS,CAACD,gBAAgB;QAC7B,MAAM,IAAIE,MAAM;IAClB;IAEA,OAAOD;AACT;AAwBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgFC,GACD,OAAO,SAASE,cAAcC,KAAyB;IACrD,MAAM,EAAEC,QAAQ,EAAEJ,KAAK,EAAE,GAAGG;IAC5B,MAAME,MAAM5D;IACZ,MAAM,EAAE6D,WAAW,EAAEC,eAAe,EAAE,GAAGxC;IACzC,MAAM,CAACyC,cAAcC,gBAAgB,GAAGjE,SACtC;QACE,IAAIwD,OAAO;YACT,OAAOA;QACT;QAEA,IAAI,CAACK,OAAO,OAAOb,aAAa,aAAa;YAC3C,OAAOF,gBAAgBE,SAASC,eAAe;QACjD;QAEA,OAAOa,gBAAgB,SAASrB,qBAAqBN;IACvD;IAGF,MAAM+B,UAAU,CAACV;IACjB1D,UAAU;QACR,IAAI0D,OAAO;YACT;QACF;QAEA,yEAAyE;QACzE,0EAA0E;QAC1E,cAAc;QACd,EAAE;QACF,2EAA2E;QAC3E,0EAA0E;QAC1E,SAAS;QACT,MAAMW,QAAQhB,OAAOiB,qBAAqB,CAAC,IACzCH,gBAAgBnB,gBAAgBE,SAASC,eAAe;QAG1D,OAAO;YACLE,OAAOkB,oBAAoB,CAACF;QAC9B;IACF,GAAG;QAACX;QAAOM;QAAaC;KAAgB;IAExC,MAAMO,QAAQvE,QAAsB;QAClC,MAAMqC,kBACJoB,OAAOpB,mBAAmB4B,aAAa5B,eAAe;QACxD,MAAMX,eAAe+B,OAAO/B,gBAAgBuC,aAAavC,YAAY;QACrE,MAAMC,iBAAiB8B,OAAO9B,kBAAkBsC,aAAatC,cAAc;QAC3E,MAAMC,iBAAiB6B,OAAO7B,kBAAkBqC,aAAarC,cAAc;QAC3E,MAAMC,mBACJ4B,OAAO5B,oBAAoBoC,aAAapC,gBAAgB;QAC1D,MAAMC,eAAe2B,OAAO3B,gBAAgBmC,aAAanC,YAAY;QACrE,MAAMC,iBAAiB0B,OAAO1B,kBAAkBkC,aAAalC,cAAc;QAC3E,MAAMC,aAAayB,OAAOzB,cAAciC,aAAajC,UAAU;QAC/D,MAAMC,eAAewB,OAAOxB,gBAAgBgC,aAAahC,YAAY;QACrE,MAAMC,eAAeuB,OAAOvB,gBAAgB+B,aAAa/B,YAAY;QACrE,MAAMC,iBAAiBsB,OAAOtB,kBAAkB8B,aAAa9B,cAAc;QAC3E,MAAMG,mBACJmB,OAAOnB,oBAAoB2B,aAAa3B,gBAAgB;QAC1D,MAAMC,qBACJkB,OAAOlB,sBAAsB0B,aAAa1B,kBAAkB;QAC9D,MAAMC,gBAAgBiB,OAAOjB,iBAAiByB,aAAazB,aAAa;QACxE,MAAMC,oBACJgB,OAAOhB,qBAAqBwB,aAAaxB,iBAAiB;QAE5D,OAAO;YACL0B;YACA9B;YACAX;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAG;YACAC;YACAC;YACAC;YACAyB;QACF;IACF,GAAG;QACDC;QACAF,aAAa5B,eAAe;QAC5B4B,aAAajC,UAAU;QACvBiC,aAAahC,YAAY;QACzBgC,aAAatC,cAAc;QAC3BsC,aAAapC,gBAAgB;QAC7BoC,aAAa9B,cAAc;QAC3B8B,aAAalC,cAAc;QAC3BkC,aAAavC,YAAY;QACzBuC,aAAarC,cAAc;QAC3BqC,aAAa/B,YAAY;QACzB+B,aAAaxB,iBAAiB;QAC9BwB,aAAazB,aAAa;QAC1ByB,aAAa3B,gBAAgB;QAC7B2B,aAAa1B,kBAAkB;QAC/B0B,aAAanC,YAAY;QACzB2B,OAAOpB;QACPoB,OAAOzB;QACPyB,OAAOxB;QACPwB,OAAO9B;QACP8B,OAAO5B;QACP4B,OAAOtB;QACPsB,OAAO1B;QACP0B,OAAO/B;QACP+B,OAAO7B;QACP6B,OAAOvB;QACPuB,OAAOhB;QACPgB,OAAOjB;QACPiB,OAAOnB;QACPmB,OAAOlB;QACPkB,OAAO3B;KACR;IAED,qBAAO,KAACgB;QAASyB,OAAOA;kBAAQV;;AAClC"}
+{"version":3,"sources":["../../src/theme/ThemeProvider.tsx"],"sourcesContent":["\"use client\";\nimport {\n  createContext,\n  useContext,\n  useEffect,\n  useMemo,\n  useState,\n  type ReactElement,\n  type ReactNode,\n} from \"react\";\nimport { useSsr } from \"../SsrProvider.js\";\nimport { type UseStateSetter } from \"../types.js\";\nimport {\n  black,\n  blue500,\n  greenAccent700,\n  orangeAccent200,\n  orangeAccent400,\n  red500,\n} from \"./colors.js\";\nimport {\n  backgroundColorVar,\n  errorColorVar,\n  onErrorColorVar,\n  onPrimaryColorVar,\n  onSecondaryColorVar,\n  onSuccessColorVar,\n  onWarningColorVar,\n  primaryColorVar,\n  secondaryColorVar,\n  successColorVar,\n  textDisabledColorVar,\n  textHintColorVar,\n  textPrimaryColorVar,\n  textSecondaryColorVar,\n  warningColorVar,\n} from \"./cssVars.js\";\nimport { useColorScheme } from \"./useColorScheme.js\";\n\ndeclare module \"react\" {\n  interface CSSProperties {\n    \"--rmd-background-color\"?: string;\n    \"--rmd-on-background-color\"?: string;\n    \"--rmd-surface-color\"?: string;\n    \"--rmd-primary-color\"?: string;\n    \"--rmd-on-primary-color\"?: string;\n    \"--rmd-secondary-color\"?: string;\n    \"--rmd-on-secondary-color\"?: string;\n    \"--rmd-warning-color\"?: string;\n    \"--rmd-on-warning-color\"?: string;\n    \"--rmd-error-color\"?: string;\n    \"--rmd-on-error-color\"?: string;\n    \"--rmd-success-color\"?: string;\n    \"--rmd-on-success-color\"?: string;\n    \"--rmd-text-primary-color\"?: string;\n    \"--rmd-text-secondary-color\"?: string;\n    \"--rmd-text-hint-color\"?: string;\n    \"--rmd-text-disabled-color\"?: string;\n\n    \"--rmd-outline-width\"?: string | number;\n    \"--rmd-outline-color\"?: string;\n    \"--rmd-outline-grey-color\"?: string;\n  }\n}\n\n/** @remarks \\@since 6.0.0 */\nexport interface ThemeColors {\n  primaryColor: string;\n  onPrimaryColor: string;\n  secondaryColor: string;\n  onSecondaryColor: string;\n  warningColor: string;\n  onWarningColor: string;\n  errorColor: string;\n  onErrorColor: string;\n  successColor: string;\n  onSuccessColor: string;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport interface ThemeTextColors {\n  textPrimaryColor: string;\n  textSecondaryColor: string;\n  textHintColor: string;\n  textDisabledColor: string;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport interface ConfigurableThemeColors extends ThemeColors, ThemeTextColors {\n  backgroundColor: string;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport type ConfigurableThemeColorsName = keyof ConfigurableThemeColors;\n\n/** @remarks \\@since 6.0.0 */\nexport interface ThemeContext extends ConfigurableThemeColors {\n  /**\n   * This will be `true` if a `theme` wsa not provided to the {@link ThemeProvider}\n   */\n  derived: boolean;\n\n  /**\n   * @example\n   * Simple Example\n   * ```tsx\n   * import { getDerivedTheme, useHtmlClassName, useTheme } from \"@react-md/core\";\n   * import { useEffect } from \"react\";\n   *\n   * import styles from \"./LightTheme.module.scss\";\n   *\n   * let loadedOnce = false;\n   *\n   * export default function LightTheme(): null {\n   *   useHtmlClassName(styles.container);\n   *   const { setDerivedTheme } = useTheme();\n   *   useEffect(() => {\n   *     if (loadedOnce) {\n   *       return;\n   *     }\n   *\n   *     loadedOnce = true;\n   *     setDerivedTheme(getDerivedTheme());\n   *   }, [setDerivedTheme]);\n   *   return null;\n   * }\n   * ```\n   */\n  setDerivedTheme: UseStateSetter<Readonly<ConfigurableThemeColors>>;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport const DEFAULT_THEME_COLORS: Readonly<ThemeColors> = {\n  primaryColor: blue500,\n  onPrimaryColor: black,\n  secondaryColor: orangeAccent400,\n  onSecondaryColor: black,\n  warningColor: orangeAccent200,\n  onWarningColor: black,\n  errorColor: red500,\n  onErrorColor: black,\n  successColor: greenAccent700,\n  onSuccessColor: black,\n};\n\n/** @remarks \\@since 6.0.0 */\nexport const DEFAULT_LIGHT_THEME: Readonly<ConfigurableThemeColors> = {\n  ...DEFAULT_THEME_COLORS,\n  backgroundColor: \"#fafafa\",\n  textPrimaryColor: \"#212121\",\n  textSecondaryColor: \"#757575\",\n  textHintColor: \"#a8a8a8\",\n  textDisabledColor: \"#9e9e9e\",\n};\n\n/** @remarks \\@since 6.0.0 */\nexport const DEFAULT_DARK_THEME: Readonly<ConfigurableThemeColors> = {\n  ...DEFAULT_THEME_COLORS,\n  backgroundColor: \"#121212\",\n  textPrimaryColor: \"#d9d9d9\",\n  textSecondaryColor: \"#b3b3b3\",\n  textHintColor: \"gray\", // #808080\n  textDisabledColor: \"gray\", // #808080\n};\n\nconst context = createContext<Readonly<ThemeContext> | undefined>(undefined);\ncontext.displayName = \"Theme\";\nconst { Provider } = context;\n\n/** @remarks \\@since 6.0.0 */\nexport const getDerivedTheme = (\n  container: Element = document.documentElement\n): Readonly<ConfigurableThemeColors> => {\n  const rootStyles = window.getComputedStyle(container);\n  const backgroundColor = rootStyles.getPropertyValue(backgroundColorVar);\n  const primaryColor = rootStyles.getPropertyValue(primaryColorVar);\n  const onPrimaryColor = rootStyles.getPropertyValue(onPrimaryColorVar);\n  const secondaryColor = rootStyles.getPropertyValue(secondaryColorVar);\n  const onSecondaryColor = rootStyles.getPropertyValue(onSecondaryColorVar);\n  const warningColor = rootStyles.getPropertyValue(warningColorVar);\n  const onWarningColor = rootStyles.getPropertyValue(onWarningColorVar);\n  const errorColor = rootStyles.getPropertyValue(errorColorVar);\n  const onErrorColor = rootStyles.getPropertyValue(onErrorColorVar);\n  const successColor = rootStyles.getPropertyValue(successColorVar);\n  const onSuccessColor = rootStyles.getPropertyValue(onSuccessColorVar);\n  const textPrimaryColor = rootStyles.getPropertyValue(textPrimaryColorVar);\n  const textSecondaryColor = rootStyles.getPropertyValue(textSecondaryColorVar);\n  const textHintColor = rootStyles.getPropertyValue(textHintColorVar);\n  const textDisabledColor = rootStyles.getPropertyValue(textDisabledColorVar);\n\n  return {\n    backgroundColor,\n    primaryColor,\n    onPrimaryColor,\n    secondaryColor,\n    onSecondaryColor,\n    warningColor,\n    onWarningColor,\n    errorColor,\n    onErrorColor,\n    successColor,\n    onSuccessColor,\n    textPrimaryColor,\n    textSecondaryColor,\n    textHintColor,\n    textDisabledColor,\n  };\n};\n\n/**\n * This hook can be used to access the current theme set by the\n * {@link ThemeProvider}.\n *\n * @example\n * Simple Example\n * ```tsx\n * import { useTheme } from \"@react-md/core\";\n * import type { ReactElement } from \"react\";\n *\n * function Example(): ReactElement {\n *   const theme = useTheme();\n *\n *   return <pre><code>{JSON.stringify(theme, null, 2)}</code></pre>;\n * }\n * ```\n *\n * @remarks \\@since 6.0.0\n * @throws \"The `ThemeProvider` has not been initialized.\"\n */\nexport function useTheme(): Readonly<ThemeContext>;\n\n/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nexport function useTheme(\n  allowUndefined: true\n): Readonly<ThemeContext> | undefined;\n\n/**\n * @internal\n * @remarks \\@since 6.0.0\n * @throws \"The `ThemeProvider` has not been initialized.\"\n */\nexport function useTheme(\n  allowUndefined?: boolean\n): Readonly<ThemeContext> | undefined {\n  const theme = useContext(context);\n  if (!theme && !allowUndefined) {\n    throw new Error(\"The `ThemeProvider` has not been initialized.\");\n  }\n\n  return theme;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport interface ThemeProviderProps {\n  /**\n   * When this is `undefined`, the theme will be derived by computing the\n   * `document.documentElement`'s styles for all the `react-md` theme custom\n   * properties. The theme will also automatically update whenever the\n   * `colorScheme` or `colorSchemeMode` change.\n   *\n   * It is recommended to manually provide your theme if you know it beforehand.\n   * Deriving the theme is really only useful if you allow your user to\n   * customize all these theme values themselves and persist through local\n   * storage/cookies.\n   *\n   * @see {@link DEFAULT_DARK_THEME}\n   * @see {@link DEFAULT_LIGHT_THEME}\n   * @defaultValue `colorScheme === \"dark\" ? DEFAULT_DARK_THEME : DEFAULT_LIGHT_THEME`\n   */\n  theme?: Readonly<ConfigurableThemeColors>;\n\n  children: ReactNode;\n}\n\n/**\n * **Client Component**\n *\n * The `ThemeProvider` should be added to the root of your app but as a child of\n * the `CoreProviders`.\n *\n * @example\n * ```tsx\n * import {\n *   black,\n *   blue500,\n *   greenAccent700,\n *   orangeAccent200,\n *   orangeAccent400,\n *   red500,\n *   CoreProviders,\n *   ThemeProvider,\n * } from \"@react-md/core\";\n * import type { ConfigurableThemeColors } from \"@react-md/core\";\n * import type { ReactElement } from \"react\";\n * import { createRoot } from \"react-dom/client\";\n *\n * import App from \"./App\";\n *\n * const theme: Readonly<ConfigurableThemeColors> = {\n *   primaryColor: blue500,\n *   onPrimaryColor: black,\n *   secondaryColor: orangeAccent400,\n *   onSecondaryColor: black,\n *   warningColor: orangeAccent200,\n *   onWarningColor: black,\n *   errorColor: red500,\n *   onErrorColor: black,\n *   successColor: greenAccent700,\n *   onSuccessColor: black,\n *   backgroundColor: \"#121212\",\n *   textPrimaryColor: \"#d9d9d9\",\n *   textSecondaryColor: \"#b3b3b3\",\n *   textHintColor: \"gray\", // #808080\n *   textDisabledColor: \"gray\", // #808080\n * };\n *\n * const container = document.getElementById(\"app\");\n * const root = createRoot(container);\n * root.render(\n *   <CoreProviders>\n *     <ThemeProvider theme={theme}>\n *       <App />\n *     </ThemeProvider>\n *   </CoreProviders>\n * );\n * ```\n *\n * @example\n * Automatically Deriving the Theme\n * ```tsx\n * import {\n *   CoreProviders,\n *   LocalStorageColorSchemeProvider,\n *   ThemeProvider,\n * } from \"@react-md/core\";\n * import { type ReactElement } from \"react\";\n * import { createRoot } from \"react-dom/client\";\n *\n * import App from \"./App\";\n *\n * const container = document.getElementById(\"app\");\n * const root = createRoot(container);\n * root.render(\n *   <CoreProviders>\n *     <LocalStorageColorSchemeProvider>\n *       <ThemeProvider>\n *         <App />\n *       </ThemeProvider>\n *     </LocalStorageColorSchemeProvider>\n *   </CoreProviders>\n * );\n * ```\n *\n * @remarks \\@since 6.0.0\n */\nexport function ThemeProvider(props: ThemeProviderProps): ReactElement {\n  const { children, theme } = props;\n  const ssr = useSsr();\n  const { colorScheme, colorSchemeMode } = useColorScheme();\n  const [derivedTheme, setDerivedTheme] = useState<ConfigurableThemeColors>(\n    () => {\n      if (theme) {\n        return theme;\n      }\n\n      if (!ssr && typeof document !== \"undefined\") {\n        return getDerivedTheme(document.documentElement);\n      }\n\n      return colorScheme === \"dark\" ? DEFAULT_DARK_THEME : DEFAULT_LIGHT_THEME;\n    }\n  );\n\n  const derived = !theme;\n  useEffect(() => {\n    if (theme) {\n      return;\n    }\n\n    // This has to be recalculated after an animation to ensure the new theme\n    // styles have been applied. It will use the previous theme styles without\n    // this frame.\n    //\n    // NOTE: This will not be correct the first time a new theme is lazy-loaded\n    // and applied. It might be good to have a way to manually force this flow\n    // again?\n    const frame = window.requestAnimationFrame(() =>\n      setDerivedTheme(getDerivedTheme(document.documentElement))\n    );\n\n    return () => {\n      window.cancelAnimationFrame(frame);\n    };\n  }, [theme, colorScheme, colorSchemeMode]);\n\n  const value = useMemo<ThemeContext>(() => {\n    const backgroundColor =\n      theme?.backgroundColor ?? derivedTheme.backgroundColor;\n    const primaryColor = theme?.primaryColor ?? derivedTheme.primaryColor;\n    const onPrimaryColor = theme?.onPrimaryColor ?? derivedTheme.onPrimaryColor;\n    const secondaryColor = theme?.secondaryColor ?? derivedTheme.secondaryColor;\n    const onSecondaryColor =\n      theme?.onSecondaryColor ?? derivedTheme.onSecondaryColor;\n    const warningColor = theme?.warningColor ?? derivedTheme.warningColor;\n    const onWarningColor = theme?.onWarningColor ?? derivedTheme.onWarningColor;\n    const errorColor = theme?.errorColor ?? derivedTheme.errorColor;\n    const onErrorColor = theme?.onErrorColor ?? derivedTheme.onErrorColor;\n    const successColor = theme?.successColor ?? derivedTheme.successColor;\n    const onSuccessColor = theme?.onSuccessColor ?? derivedTheme.onSuccessColor;\n    const textPrimaryColor =\n      theme?.textPrimaryColor ?? derivedTheme.textPrimaryColor;\n    const textSecondaryColor =\n      theme?.textSecondaryColor ?? derivedTheme.textSecondaryColor;\n    const textHintColor = theme?.textHintColor ?? derivedTheme.textHintColor;\n    const textDisabledColor =\n      theme?.textDisabledColor ?? derivedTheme.textDisabledColor;\n\n    return {\n      derived,\n      backgroundColor,\n      primaryColor,\n      onPrimaryColor,\n      secondaryColor,\n      onSecondaryColor,\n      warningColor,\n      onWarningColor,\n      errorColor,\n      onErrorColor,\n      successColor,\n      onSuccessColor,\n      textPrimaryColor,\n      textSecondaryColor,\n      textHintColor,\n      textDisabledColor,\n      setDerivedTheme,\n    };\n  }, [\n    derived,\n    derivedTheme.backgroundColor,\n    derivedTheme.errorColor,\n    derivedTheme.onErrorColor,\n    derivedTheme.onPrimaryColor,\n    derivedTheme.onSecondaryColor,\n    derivedTheme.onSuccessColor,\n    derivedTheme.onWarningColor,\n    derivedTheme.primaryColor,\n    derivedTheme.secondaryColor,\n    derivedTheme.successColor,\n    derivedTheme.textDisabledColor,\n    derivedTheme.textHintColor,\n    derivedTheme.textPrimaryColor,\n    derivedTheme.textSecondaryColor,\n    derivedTheme.warningColor,\n    theme?.backgroundColor,\n    theme?.errorColor,\n    theme?.onErrorColor,\n    theme?.onPrimaryColor,\n    theme?.onSecondaryColor,\n    theme?.onSuccessColor,\n    theme?.onWarningColor,\n    theme?.primaryColor,\n    theme?.secondaryColor,\n    theme?.successColor,\n    theme?.textDisabledColor,\n    theme?.textHintColor,\n    theme?.textPrimaryColor,\n    theme?.textSecondaryColor,\n    theme?.warningColor,\n  ]);\n\n  return <Provider value={value}>{children}</Provider>;\n}\n"],"names":["createContext","useContext","useEffect","useMemo","useState","useSsr","black","blue500","greenAccent700","orangeAccent200","orangeAccent400","red500","backgroundColorVar","errorColorVar","onErrorColorVar","onPrimaryColorVar","onSecondaryColorVar","onSuccessColorVar","onWarningColorVar","primaryColorVar","secondaryColorVar","successColorVar","textDisabledColorVar","textHintColorVar","textPrimaryColorVar","textSecondaryColorVar","warningColorVar","useColorScheme","DEFAULT_THEME_COLORS","primaryColor","onPrimaryColor","secondaryColor","onSecondaryColor","warningColor","onWarningColor","errorColor","onErrorColor","successColor","onSuccessColor","DEFAULT_LIGHT_THEME","backgroundColor","textPrimaryColor","textSecondaryColor","textHintColor","textDisabledColor","DEFAULT_DARK_THEME","context","undefined","displayName","Provider","getDerivedTheme","container","document","documentElement","rootStyles","window","getComputedStyle","getPropertyValue","useTheme","allowUndefined","theme","Error","ThemeProvider","props","children","ssr","colorScheme","colorSchemeMode","derivedTheme","setDerivedTheme","derived","frame","requestAnimationFrame","cancelAnimationFrame","value"],"mappings":"AAAA;;AACA,SACEA,aAAa,EACbC,UAAU,EACVC,SAAS,EACTC,OAAO,EACPC,QAAQ,QAGH,QAAQ;AACf,SAASC,MAAM,QAAQ,oBAAoB;AAE3C,SACEC,KAAK,EACLC,OAAO,EACPC,cAAc,EACdC,eAAe,EACfC,eAAe,EACfC,MAAM,QACD,cAAc;AACrB,SACEC,kBAAkB,EAClBC,aAAa,EACbC,eAAe,EACfC,iBAAiB,EACjBC,mBAAmB,EACnBC,iBAAiB,EACjBC,iBAAiB,EACjBC,eAAe,EACfC,iBAAiB,EACjBC,eAAe,EACfC,oBAAoB,EACpBC,gBAAgB,EAChBC,mBAAmB,EACnBC,qBAAqB,EACrBC,eAAe,QACV,eAAe;AACtB,SAASC,cAAc,QAAQ,sBAAsB;AA8FrD,2BAA2B,GAC3B,OAAO,MAAMC,uBAA8C;IACzDC,cAActB;IACduB,gBAAgBxB;IAChByB,gBAAgBrB;IAChBsB,kBAAkB1B;IAClB2B,cAAcxB;IACdyB,gBAAgB5B;IAChB6B,YAAYxB;IACZyB,cAAc9B;IACd+B,cAAc7B;IACd8B,gBAAgBhC;AAClB,EAAE;AAEF,2BAA2B,GAC3B,OAAO,MAAMiC,sBAAyD;IACpE,GAAGX,oBAAoB;IACvBY,iBAAiB;IACjBC,kBAAkB;IAClBC,oBAAoB;IACpBC,eAAe;IACfC,mBAAmB;AACrB,EAAE;AAEF,2BAA2B,GAC3B,OAAO,MAAMC,qBAAwD;IACnE,GAAGjB,oBAAoB;IACvBY,iBAAiB;IACjBC,kBAAkB;IAClBC,oBAAoB;IACpBC,eAAe;IACfC,mBAAmB;AACrB,EAAE;AAEF,MAAME,wBAAU9C,cAAkD+C;AAClED,QAAQE,WAAW,GAAG;AACtB,MAAM,EAAEC,QAAQ,EAAE,GAAGH;AAErB,2BAA2B,GAC3B,OAAO,MAAMI,kBAAkB,CAC7BC,YAAqBC,SAASC,eAAe;IAE7C,MAAMC,aAAaC,OAAOC,gBAAgB,CAACL;IAC3C,MAAMX,kBAAkBc,WAAWG,gBAAgB,CAAC7C;IACpD,MAAMiB,eAAeyB,WAAWG,gBAAgB,CAACtC;IACjD,MAAMW,iBAAiBwB,WAAWG,gBAAgB,CAAC1C;IACnD,MAAMgB,iBAAiBuB,WAAWG,gBAAgB,CAACrC;IACnD,MAAMY,mBAAmBsB,WAAWG,gBAAgB,CAACzC;IACrD,MAAMiB,eAAeqB,WAAWG,gBAAgB,CAAC/B;IACjD,MAAMQ,iBAAiBoB,WAAWG,gBAAgB,CAACvC;IACnD,MAAMiB,aAAamB,WAAWG,gBAAgB,CAAC5C;IAC/C,MAAMuB,eAAekB,WAAWG,gBAAgB,CAAC3C;IACjD,MAAMuB,eAAeiB,WAAWG,gBAAgB,CAACpC;IACjD,MAAMiB,iBAAiBgB,WAAWG,gBAAgB,CAACxC;IACnD,MAAMwB,mBAAmBa,WAAWG,gBAAgB,CAACjC;IACrD,MAAMkB,qBAAqBY,WAAWG,gBAAgB,CAAChC;IACvD,MAAMkB,gBAAgBW,WAAWG,gBAAgB,CAAClC;IAClD,MAAMqB,oBAAoBU,WAAWG,gBAAgB,CAACnC;IAEtD,OAAO;QACLkB;QACAX;QACAC;QACAC;QACAC;QACAC;QACAC;QACAC;QACAC;QACAC;QACAC;QACAG;QACAC;QACAC;QACAC;IACF;AACF,EAAE;AAgCF;;;;CAIC,GACD,OAAO,SAASc,SACdC,cAAwB;IAExB,MAAMC,QAAQ3D,WAAW6C;IACzB,IAAI,CAACc,SAAS,CAACD,gBAAgB;QAC7B,MAAM,IAAIE,MAAM;IAClB;IAEA,OAAOD;AACT;AAwBA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAgFC,GACD,OAAO,SAASE,cAAcC,KAAyB;IACrD,MAAM,EAAEC,QAAQ,EAAEJ,KAAK,EAAE,GAAGG;IAC5B,MAAME,MAAM5D;IACZ,MAAM,EAAE6D,WAAW,EAAEC,eAAe,EAAE,GAAGxC;IACzC,MAAM,CAACyC,cAAcC,gBAAgB,GAAGjE,SACtC;QACE,IAAIwD,OAAO;YACT,OAAOA;QACT;QAEA,IAAI,CAACK,OAAO,OAAOb,aAAa,aAAa;YAC3C,OAAOF,gBAAgBE,SAASC,eAAe;QACjD;QAEA,OAAOa,gBAAgB,SAASrB,qBAAqBN;IACvD;IAGF,MAAM+B,UAAU,CAACV;IACjB1D,UAAU;QACR,IAAI0D,OAAO;YACT;QACF;QAEA,yEAAyE;QACzE,0EAA0E;QAC1E,cAAc;QACd,EAAE;QACF,2EAA2E;QAC3E,0EAA0E;QAC1E,SAAS;QACT,MAAMW,QAAQhB,OAAOiB,qBAAqB,CAAC,IACzCH,gBAAgBnB,gBAAgBE,SAASC,eAAe;QAG1D,OAAO;YACLE,OAAOkB,oBAAoB,CAACF;QAC9B;IACF,GAAG;QAACX;QAAOM;QAAaC;KAAgB;IAExC,MAAMO,QAAQvE,QAAsB;QAClC,MAAMqC,kBACJoB,OAAOpB,mBAAmB4B,aAAa5B,eAAe;QACxD,MAAMX,eAAe+B,OAAO/B,gBAAgBuC,aAAavC,YAAY;QACrE,MAAMC,iBAAiB8B,OAAO9B,kBAAkBsC,aAAatC,cAAc;QAC3E,MAAMC,iBAAiB6B,OAAO7B,kBAAkBqC,aAAarC,cAAc;QAC3E,MAAMC,mBACJ4B,OAAO5B,oBAAoBoC,aAAapC,gBAAgB;QAC1D,MAAMC,eAAe2B,OAAO3B,gBAAgBmC,aAAanC,YAAY;QACrE,MAAMC,iBAAiB0B,OAAO1B,kBAAkBkC,aAAalC,cAAc;QAC3E,MAAMC,aAAayB,OAAOzB,cAAciC,aAAajC,UAAU;QAC/D,MAAMC,eAAewB,OAAOxB,gBAAgBgC,aAAahC,YAAY;QACrE,MAAMC,eAAeuB,OAAOvB,gBAAgB+B,aAAa/B,YAAY;QACrE,MAAMC,iBAAiBsB,OAAOtB,kBAAkB8B,aAAa9B,cAAc;QAC3E,MAAMG,mBACJmB,OAAOnB,oBAAoB2B,aAAa3B,gBAAgB;QAC1D,MAAMC,qBACJkB,OAAOlB,sBAAsB0B,aAAa1B,kBAAkB;QAC9D,MAAMC,gBAAgBiB,OAAOjB,iBAAiByB,aAAazB,aAAa;QACxE,MAAMC,oBACJgB,OAAOhB,qBAAqBwB,aAAaxB,iBAAiB;QAE5D,OAAO;YACL0B;YACA9B;YACAX;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAC;YACAG;YACAC;YACAC;YACAC;YACAyB;QACF;IACF,GAAG;QACDC;QACAF,aAAa5B,eAAe;QAC5B4B,aAAajC,UAAU;QACvBiC,aAAahC,YAAY;QACzBgC,aAAatC,cAAc;QAC3BsC,aAAapC,gBAAgB;QAC7BoC,aAAa9B,cAAc;QAC3B8B,aAAalC,cAAc;QAC3BkC,aAAavC,YAAY;QACzBuC,aAAarC,cAAc;QAC3BqC,aAAa/B,YAAY;QACzB+B,aAAaxB,iBAAiB;QAC9BwB,aAAazB,aAAa;QAC1ByB,aAAa3B,gBAAgB;QAC7B2B,aAAa1B,kBAAkB;QAC/B0B,aAAanC,YAAY;QACzB2B,OAAOpB;QACPoB,OAAOzB;QACPyB,OAAOxB;QACPwB,OAAO9B;QACP8B,OAAO5B;QACP4B,OAAOtB;QACPsB,OAAO1B;QACP0B,OAAO/B;QACP+B,OAAO7B;QACP6B,OAAOvB;QACPuB,OAAOhB;QACPgB,OAAOjB;QACPiB,OAAOnB;QACPmB,OAAOlB;QACPkB,OAAO3B;KACR;IAED,qBAAO,KAACgB;QAASyB,OAAOA;kBAAQV;;AAClC"}

package/dist/theme/_theme.scss

@@ -129,96 +129,34 @@ $_validated_color_scheme: utils.validate(
   "$color-scheme"
 );
 
-$theme-var-lookup: (
-  background-color: (
-    var: --rmd-background-color,
-    value: $background-color,
-  ),
-  on-background-color: (
-    var: --rmd-on-background-color,
-    value: null,
-  ),
-  surface-color: (
-    var: --rmd-surface-color,
-    value: $surface-color,
-  ),
-  primary-color: (
-    var: --rmd-primary-color,
-    value: $primary-color,
-  ),
-  on-primary-color: (
-    var: --rmd-on-primary-color,
-    value: $on-primary-color,
-  ),
-  secondary-color: (
-    var: --rmd-secondary-color,
-    value: $secondary-color,
-  ),
-  on-secondary-color: (
-    var: --rmd-on-secondary-color,
-    value: $on-secondary-color,
-  ),
-  warning-color: (
-    var: --rmd-warning-color,
-    value: $warning-color,
-  ),
-  on-warning-color: (
-    var: --rmd-on-warning-color,
-    value: $on-warning-color,
-  ),
-  error-color: (
-    var: --rmd-error-color,
-    value: $error-color,
-  ),
-  on-error-color: (
-    var: --rmd-on-error-color,
-    value: $on-error-color,
-  ),
-  success-color: (
-    var: --rmd-success-color,
-    value: $success-color,
-  ),
-  on-success-color: (
-    var: --rmd-on-success-color,
-    value: $on-success-color,
-  ),
-  text-primary-color: (
-    var: --rmd-text-primary-color,
-    value: $text-primary-color,
-  ),
-  text-secondary-color: (
-    var: --rmd-text-secondary-color,
-    value: $text-secondary-color,
-  ),
-  text-hint-color: (
-    var: --rmd-text-hint-color,
-    value: $text-hint-color,
-  ),
-  text-disabled-color: (
-    var: --rmd-text-disabled-color,
-    value: $text-disabled-color,
-  ),
-  outline-width: (
-    var: --rmd-outline-width,
-    value: $outline-width,
-  ),
-  outline-color: (
-    var: --rmd-outline-color,
-    value: $outline-color,
-  ),
-  outline-grey-color: (
-    var: --rmd-outline-grey-color,
-    value: $outline-grey-color,
-  ),
+$theme-variables: (
+  background-color,
+  on-background-color,
+  surface-color,
+  primary-color,
+  on-primary-color,
+  secondary-color,
+  on-secondary-color,
+  warning-color,
+  on-warning-color,
+  success-color,
+  on-success-color,
+  error-color,
+  on-error-color,
+  text-primary-color,
+  text-secondary-color,
+  text-hint-color,
+  text-disabled-color,
+  outline-width,
+  outline-color,
+  outline-grey-color
 );
 
 @function theme-get-var($name, $fallback: null) {
-  $found: utils.validate($theme-var-lookup, $name, "theme var");
-  $var: map.get($found, var);
-  $value: if($fallback, $fallback, map.get($found, value));
+  $var: utils.get-var-name($theme-variables, $name, "theme");
 
-  @if $value {
-    @return var(#{$var}, #{$value});
+  @if $fallback {
+    @return var(#{$var}, #{$fallback});
   }
 
   @return var(#{$var});
@@ -237,9 +175,9 @@ $theme-var-lookup: (
 }
 
 @mixin theme-set-var($name, $value-or-theme-name) {
-  $var: map.get(utils.validate($theme-var-lookup, $name, "theme var"), var);
+  $var: utils.get-var-name($theme-variables, $name, "theme");
   $value: $value-or-theme-name;
-  @if map.has-key($theme-var-lookup, $value-or-theme-name) {
+  @if list.index($theme-variables, $value-or-theme-name) {
     $name: $value-or-theme-name;
     $value: theme-get-var($name);
   }
@@ -291,7 +229,7 @@ $theme-var-lookup: (
   }
 }
 
-@mixin colors {
+@mixin theme-variables {
   @include theme-set-var(background-color, $background-color);
   @if $disable-dark-elevation {
     @include theme-set-var(surface-color, $surface-color);
@@ -317,6 +255,10 @@ $theme-var-lookup: (
       @include set-dark-elevation-color($z-value, $background-color);
     }
   }
+
+  @include theme-set-var(outline-width, $outline-width);
+  @include theme-set-var(outline-color, $outline-color);
+  @include theme-set-var(outline-grey-color, $outline-grey-color);
 }
 
 @mixin create-surface($z-value, $disable-colors: $disable-dark-elevation) {

package/dist/tooltip/Tooltip.d.ts

@@ -1,4 +1,5 @@
 import { type HTMLAttributes } from "react";
+import { type TextOverflow } from "../cssUtils.js";
 import { type SimplePosition } from "../positioning/types.js";
 import { type CSSTransitionComponentProps, type TransitionActions } from "../transition/types.js";
 /**
@@ -20,20 +21,26 @@ export interface TooltipProps extends HTMLAttributes<HTMLSpanElement>, CSSTransi
      * @see {@link DEFAULT_TOOLTIP_POSITION}
      */
     position?: SimplePosition;
+    /**
+     * @see {@link CSSTransitionComponentProps.temporary}
+     * @defaultValue `true`
+     */
+    temporary?: boolean;
     /**
      * @defaultValue `false`
      */
     disablePortal?: boolean;
     /**
-     * Set this to `true` to add `white-space: nowrap` to the tooltip.
+     * Set this to `"nowrap"` for tooltips that are positioned near the edge of
+     * the viewport that have a position of `"above"` or `"below"` so that the
+     * tooltip no longer aligns to the center of the tooltipped element.
      *
-     * This prop is useful for tooltips that are positioned near the edge of the
-     * viewport with `"above"` or `"below"` so that the tooltip no longer aligns
-     * the center of the tooltip with the center of the tooltipped element.
+     * Set this to `"ellipsis"` if the tooltip should only show a single line of
+     * text and ellipsis once it has reached the max tooltip width.
      *
-     * @defaultValue `false`
+     * @defaultValue `"allow"`
      */
-    disableLineWrap?: boolean;
+    textOverflow?: TextOverflow;
 }
 /**
  * **Client Component**

package/dist/tooltip/Tooltip.js

@@ -33,7 +33,7 @@ import { tooltip } from "./tooltipStyles.js";
  * }
  * ```
  */ export const Tooltip = /*#__PURE__*/ forwardRef(function Tooltip(props, nodeRef) {
-    const { id: propId, dense, visible, children, appear, enter, exit, onEnter, onEntering, onEntered, onExit, onExiting, onExited, timeout = DEFAULT_TOOLTIP_TIMEOUT, classNames = DEFAULT_TOOLTIP_CLASSNAMES, className, position = DEFAULT_TOOLTIP_POSITION, temporary, exitedHidden = !temporary, disableLineWrap, disablePortal: propDisablePortal, ...remaining } = props;
+    const { id: propId, dense, visible, children, appear, enter, exit, onEnter, onEntering, onEntered, onExit, onExiting, onExited, timeout = DEFAULT_TOOLTIP_TIMEOUT, classNames = DEFAULT_TOOLTIP_CLASSNAMES, className, position = DEFAULT_TOOLTIP_POSITION, temporary = true, exitedHidden = !temporary, textOverflow, disablePortal: propDisablePortal, ...remaining } = props;
     const id = useEnsuredId(propId, "tooltip");
     const { rendered, elementProps, disablePortal } = useCSSTransition({
         nodeRef,
@@ -47,7 +47,7 @@ import { tooltip } from "./tooltipStyles.js";
             dense,
             position,
             className,
-            disableLineWrap
+            textOverflow
         }),
         onEnter,
         onEntering,

package/dist/tooltip/Tooltip.js.map

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

package/dist/tooltip/TooltipHoverModeProvider.d.ts

@@ -12,6 +12,21 @@ export declare function useTooltipHoverMode(): Readonly<TooltipHoverModeContext>
  */
 export interface TooltipHoverModeProviderProps extends Partial<HoverModeConfiguration> {
     children: ReactNode;
+    /**
+     * @see {@link HoverModeConfiguration.hoverTimeout}
+     * @defaultValue `1000`
+     */
+    hoverTimeout?: number;
+    /**
+     * @see {@link HoverModeConfiguration.leaveTimeout}
+     * @defaultValue `0`
+     */
+    leaveTimeout?: number;
+    /**
+     * @see {@link HoverModeConfiguration.disableTimeout}
+     * @defaultValue `1000`
+     */
+    disableTimeout?: number;
 }
 /**
  * **Client Component**

package/dist/tooltip/TooltipHoverModeProvider.js.map

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

package/dist/tooltip/_tooltip.scss

@@ -45,45 +45,36 @@ $leave-duration: transition.$linear-duration !default;
 $leave-timing-function: transition.$acceleration-timing-function !default;
 $transition-distance: 0.5rem !default;
 
-$var-lookup: (
-  background-color: (
-    var: --rmd-tooltip-background-color,
-    value: $background-color,
-  ),
-  color: (
-    var: --rmd-tooltip-color,
-    value: $color,
-  ),
-  spacing: (
-    // this is only added so you can safely do:
-    // @include react-md.tooltip-set-var(spacing, $custom-spacing);
-    var: --rmd-tooltip-spacing,
-    value: $spacing,
-  ),
-);
+$variables: (background-color, color, spacing);
 
 @function get-var($name, $fallback: null) {
-  $found: utils.validate($var-lookup, $name, "tooltip var");
-  $var: map.get($found, var);
-  $value: if($fallback, $fallback, map.get($found, value));
-
-  @if $value {
-    @return var(#{$var}, #{$value});
+  $var: utils.get-var-name($variables, $name, "tooltip");
+  @if $fallback {
+    @return var(#{$var}, #{$fallback});
   }
 
   @return var(#{$var});
 }
 
 @mixin set-var($name, $value) {
-  $var: map.get(utils.validate($var-lookup, $name, "tooltip var"), var);
-
-  #{$var}: #{$value};
+  @if $value {
+    #{utils.get-var-name($variables, $name, "tooltip")}: #{$value};
+  }
 }
 
 @mixin use-var($property, $name: $property, $fallback: null) {
   #{$property}: get-var($name, $fallback);
 }
 
+@mixin variables {
+  @if not $disable-everything {
+    @include set-var(background-color, $background-color);
+    @include set-var(color, $color);
+
+    // do not include spacing
+  }
+}
+
 @mixin styles {
   @if not $disable-everything {
     .rmd-tooltip {
@@ -95,6 +86,7 @@ $var-lookup: (
       max-width: $max-width;
       min-height: $min-height;
       opacity: 0;
+      overflow: hidden;
       overflow-wrap: anywhere;
       padding: $vertical-padding $horizontal-padding;
       pointer-events: none;

package/dist/tooltip/tooltipStyles.d.ts

@@ -1,3 +1,4 @@
+import { type TextOverflow } from "../cssUtils.js";
 import type { SimplePosition } from "../positioning/types.js";
 /**
  * @remarks \@since 6.0.0
@@ -6,7 +7,7 @@ export interface TooltipClassNameOptions {
     className?: string;
     dense?: boolean;
     position: SimplePosition;
-    disableLineWrap?: boolean;
+    textOverflow?: TextOverflow;
 }
 /**
  * @remarks \@since 6.0.0

package/dist/tooltip/tooltipStyles.js

@@ -5,12 +5,12 @@ const styles = bem("rmd-tooltip");
 /**
  * @remarks \@since 6.0.0
  */ export function tooltip(options) {
-    const { dense, position, className, disableLineWrap } = options;
+    const { dense, position, className, textOverflow } = options;
     return cnb(styles({
         dense,
         [position]: true
     }), cssUtils({
-        textOverflow: disableLineWrap ? "nowrap" : undefined
+        textOverflow
     }), className);
 }
 

package/dist/tooltip/tooltipStyles.js.map

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

package/dist/tooltip/useTooltip.d.ts

@@ -1,4 +1,6 @@
-import type { CSSProperties, FocusEvent, MouseEvent, Ref, TouchEvent } from "react";
+import type { CSSProperties, FocusEvent, MouseEvent, MutableRefObject, Ref, RefObject, TouchEvent } from "react";
+import { type ControlledHoverModeImplementation } from "../hoverMode/useHoverMode.js";
+import type { UserInteractionMode } from "../interaction/UserInteractionModeProvider.js";
 import type { SimplePosition } from "../positioning/types.js";
 import type { FixedPositioningTransitionCallbacks } from "../positioning/useFixedPositioning.js";
 import type { UseStateSetter } from "../types.js";
@@ -152,7 +154,7 @@ export interface TooltipOptions extends FixedPositioningTransitionCallbacks, Too
      *
      * @defaultValue `DEFAULT_TOOLTIP_DELAY`
      */
-    hoverTime?: number;
+    hoverTimeout?: number;
     /**
      * The amount of time to wait before triggering the exit animation for the
      * tooltip.
@@ -162,16 +164,24 @@ export interface TooltipOptions extends FixedPositioningTransitionCallbacks, Too
      *
      * @defaultValue `0`
      */
-    leaveTime?: number;
+    leaveTimeout?: number;
+    /**
+     * Set this to `true` to only allow the tooltip to become visible when the
+     * `event .currentTarget` or `overflowRef` has text overflow.
+     *
+     * @defaultValue `false`
+     * @remarks \@since 6.0.0
+     */
+    overflowOnly?: boolean;
 }
 /**
  * @remarks
  * \@since 2.8.0
  * \@since 6.0.0 This was renamed from `TooltipHookProvidedTooltipProps`
  */
-export interface ProvidedTooltipProps extends Required<FixedPositioningTransitionCallbacks> {
+export interface ProvidedTooltipProps<E extends HTMLElement = HTMLSpanElement> extends Required<FixedPositioningTransitionCallbacks> {
     id: string;
-    ref: Ref<HTMLSpanElement>;
+    ref: Ref<E>;
     dense: boolean;
     style: CSSProperties;
     visible: boolean;
@@ -185,17 +195,22 @@ export interface ProvidedTooltipProps extends Required<FixedPositioningTransitio
  * `TooltipHookReturnValue` to `TooltipImplementation` to match other hook
  * naming conventions.
  */
-export interface TooltipImplementation {
+export interface TooltipImplementation<TooltipElement extends HTMLElement = HTMLSpanElement> extends ControlledHoverModeImplementation {
     visible: boolean;
     setVisible: UseStateSetter<boolean>;
     animatedOnce: boolean;
+    initiatedBy: MutableRefObject<UserInteractionMode | null>;
     elementProps: ProvidedTooltippedElementProps;
-    tooltipProps: ProvidedTooltipProps;
+    tooltipProps: ProvidedTooltipProps<TooltipElement>;
     /**
      * This is a wrapper around the {@link setVisible} behavior that will also
      * clear any pending timeouts.
      */
     hideTooltip(): void;
+    /**
+     * @remarks \@since 6.0.0
+     */
+    overflowRef: RefObject<HTMLElement>;
 }
 /**
  * @example
@@ -217,6 +232,54 @@ export interface TooltipImplementation {
  * }
  * ```
  *
+ * @example
+ * Overflow-only Tooltips
+ * ```tsx
+ * import {
+ *   cssUtils,
+ *   Link,
+ *   Tooltip,
+ *   useTooltip,
+ *   type LinkProps,
+ * } from "@react-md/core";
+ * import { type ReactElement } from "react";
+ *
+ * function NavigationLink(props: LinkProps): ReactElement {
+ *   const { children, ...remaining } = props;
+ *
+ *   // using the `overflowRef` is optional and will default to the
+ *   // `event.currentTarget` when `null`
+ *   const { overflowRef, elementProps, tooltipProps } = useOverflowTooltip({
+ *     // just to pass any event handlers
+ *     ...remaining,
+ *     overflowOnly: true,
+ *   });
+ *
+ *   return (
+ *     <Link {...remaining} {...elementProps} style={{ width: "100%" }}>
+ *       <span ref={overflowRef} className={cssUtils({ textOverflow: "ellipsis" })}>
+ *         {children}
+ *       </span>
+ *       <Tooltip {...tooltipProps}>
+ *         {children}
+ *       </Tooltip>
+ *     </Link>
+ *   );
+ * }
+ *
+ * function Example(): ReactElement {
+ *   return (
+ *     <div style={{ width: "10rem", overflow: "auto" }}>
+ *       <NavigationLink href="/">Home</NavigationLink>
+ *       <NavigationLink href="/some-path">
+ *         Super long text that will be truncated with ellipsis and
+ *         have a tooltip appear
+ *       </NavigationLink>
+ *     </div>
+ *   );
+ * }
+ * ```
+ *
  * ## Inspecting Tooltip Styles
  *
  * Since tooltips will disappear on blur, mouseleave, etc, it is a bit hard to
@@ -239,4 +302,4 @@ export interface TooltipImplementation {
  * element when the click or history update happens. this causes the tooltip to
  * stay visible
  */
-export declare function useTooltip(options?: TooltipOptions): TooltipImplementation;
+export declare function useTooltip<TooltipElement extends HTMLElement = HTMLSpanElement>(options?: TooltipOptions): TooltipImplementation<TooltipElement>;