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

package/dist/theme/types.d.ts

@@ -1,11 +1,11 @@
 import type { CSSProperties } from "react";
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type CSSVariableName = `--${string}`;
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type DefinedCustomProperty<Property = keyof CSSProperties> = Property extends CSSVariableName ? Property : never;
 /**
@@ -29,6 +29,6 @@ export type DefinedCustomProperty<Property = keyof CSSProperties> = Property ext
  * // defined react-md custom properties
  * ```
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type DefinedCSSVariableName = DefinedCustomProperty;

package/dist/theme/types.js

@@ -19,7 +19,7 @@
  * // defined react-md custom properties
  * ```
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export { };
 
 //# sourceMappingURL=types.js.map

package/dist/theme/types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/theme/types.ts"],"sourcesContent":["import type { CSSProperties } from \"react\";\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport type CSSVariableName = `--${string}`;\n\n/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nexport type DefinedCustomProperty<Property = keyof CSSProperties> =\n  Property extends CSSVariableName ? Property : never;\n\n/**\n * This is a utility type that can be used to auto-complete and type-check css\n * variables that are defined through module augmentation.\n *\n * ```ts\n * declare module \"react\" {\n *   interface CSSProperties {\n *     \"--custom-property\"?: number | string;\n *   }\n * }\n *\n * // will no longer throw a type error. also the `--custom-property` will\n * // appear as an auto-complete item\n * const style: CSSProperties = {\n *   \"--custom-property\": \"red\",\n * };\n *\n * // `DefinedCSSVariableName` will also include `--custom-property` with all\n * // defined react-md custom properties\n * ```\n *\n * @remarks \\@since 6.0.0\n */\nexport type DefinedCSSVariableName = DefinedCustomProperty;\n"],"names":[],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;","mappings":"AAcA;;;;;;;;;;;;;;;;;;;;;;CAsBC,GACD,WAA2D"}
+{"version":3,"sources":["../../src/theme/types.ts"],"sourcesContent":["import type { CSSProperties } from \"react\";\n\n/**\n * @since 6.0.0\n */\nexport type CSSVariableName = `--${string}`;\n\n/**\n * @internal\n * @since 6.0.0\n */\nexport type DefinedCustomProperty<Property = keyof CSSProperties> =\n  Property extends CSSVariableName ? Property : never;\n\n/**\n * This is a utility type that can be used to auto-complete and type-check css\n * variables that are defined through module augmentation.\n *\n * ```ts\n * declare module \"react\" {\n *   interface CSSProperties {\n *     \"--custom-property\"?: number | string;\n *   }\n * }\n *\n * // will no longer throw a type error. also the `--custom-property` will\n * // appear as an auto-complete item\n * const style: CSSProperties = {\n *   \"--custom-property\": \"red\",\n * };\n *\n * // `DefinedCSSVariableName` will also include `--custom-property` with all\n * // defined react-md custom properties\n * ```\n *\n * @since 6.0.0\n */\nexport type DefinedCSSVariableName = DefinedCustomProperty;\n"],"names":[],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;","mappings":"AAcA;;;;;;;;;;;;;;;;;;;;;;CAsBC,GACD,WAA2D"}

package/dist/theme/useCSSVariables.d.ts

@@ -1,25 +1,24 @@
 import type { RefObject } from "react";
 import type { CSSVariableName, DefinedCSSVariableName } from "./types.js";
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface CSSVariable<Name extends CSSVariableName = DefinedCSSVariableName> {
     name: Name;
     value: string | number;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type CSSVariablesProperties<Name extends CSSVariableName = DefinedCSSVariableName> = {
     [key in Name]?: string | number;
 };
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type ReadonlyCSSVariableList<Name extends CSSVariableName = DefinedCSSVariableName> = readonly Readonly<CSSVariable<Name>>[];
 /**
- * @example
- * Applying Variables the root html element
+ * @example Applying Variables the root html element
  * ```ts
  * import {
  *   contrastColor,
@@ -49,12 +48,11 @@ export type ReadonlyCSSVariableList<Name extends CSSVariableName = DefinedCSSVar
  * }
  * ```
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare function useCSSVariables<Name extends CSSVariableName>(variables: ReadonlyCSSVariableList<Name>, rootNode?: RefObject<HTMLElement> | HTMLElement): void;
 /**
- * @example
- * Applying variables through inline styles
+ * @example Applying variables through inline styles
  * ```tsx
  * import {
  *   contrastColor,
@@ -85,6 +83,6 @@ export declare function useCSSVariables<Name extends CSSVariableName>(variables:
  * }
  * ```
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare function useCSSVariables<Name extends CSSVariableName>(variables: ReadonlyCSSVariableList<Name>, inlineStyle: true): CSSVariablesProperties<Name>;

package/dist/theme/useCSSVariables.js

@@ -1,7 +1,7 @@
 "use client";
 import { useEffect, useMemo } from "react";
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export function useCSSVariables(variables, rootNodeOrInlineStyle) {
     useEffect(()=>{
         if (rootNodeOrInlineStyle === true || !variables.length) {

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 * @remarks \\@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 * @remarks \\@since 6.0.0\n */\nexport type CSSVariablesProperties<\n  Name extends CSSVariableName = DefinedCSSVariableName,\n> = {\n  [key in Name]?: string | number;\n};\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport type ReadonlyCSSVariableList<\n  Name extends CSSVariableName = DefinedCSSVariableName,\n> = readonly Readonly<CSSVariable<Name>>[];\n\n/**\n * @example\n * 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 * @remarks \\@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\n * 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 * @remarks \\@since 6.0.0\n */\nexport function useCSSVariables<Name extends CSSVariableName>(\n  variables: ReadonlyCSSVariableList<Name>,\n  inlineStyle: true\n): CSSVariablesProperties<Name>;\n/**\n * @remarks \\@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"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;AAEA,SAASA,SAAS,EAAEC,OAAO,QAAQ,QAAQ;AA0G3C;;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 } 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"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","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"}

package/dist/theme/useColorScheme.d.ts

@@ -1,11 +1,11 @@
 /// <reference types="react" />
 import type { UseStateSetter } from "../types.js";
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export type ColorScheme = "light" | "dark";
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export type ColorSchemeMode = ColorScheme | "system";
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface ColorSchemeModeBehavior {
     /**
@@ -26,7 +26,7 @@ export interface ColorSchemeModeBehavior {
      */
     setColorSchemeMode: UseStateSetter<ColorSchemeMode>;
 }
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface ColorSchemeContext extends ColorSchemeModeBehavior {
     /**
      * The current color scheme that is being used. This is only useful when the
@@ -36,8 +36,7 @@ export interface ColorSchemeContext extends ColorSchemeModeBehavior {
 }
 export declare const ColorSchemeProvider: import("react").Provider<ColorSchemeContext>;
 /**
- * @example
- * Lazy Load Configurable Themes
+ * @example Lazy Load Configurable Themes
  * ```tsx
  * import type { ChangeEvent, ReactElement } from "react";
  * import { lazy } from "react";
@@ -110,6 +109,6 @@ export declare const ColorSchemeProvider: import("react").Provider<ColorSchemeCo
  * }
  * ```
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare function useColorScheme(): Readonly<ColorSchemeContext>;

package/dist/theme/useColorScheme.js

@@ -12,8 +12,7 @@ const context = createContext({
 context.displayName = "ColorScheme";
 export const { Provider: ColorSchemeProvider } = context;
 /**
- * @example
- * Lazy Load Configurable Themes
+ * @example Lazy Load Configurable Themes
  * ```tsx
  * import type { ChangeEvent, ReactElement } from "react";
  * import { lazy } from "react";
@@ -86,7 +85,7 @@ export const { Provider: ColorSchemeProvider } = context;
  * }
  * ```
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export function useColorScheme() {
     return useContext(context);
 }

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/** @remarks \\@since 6.0.0 */\nexport type ColorScheme = \"light\" | \"dark\";\n\n/** @remarks \\@since 6.0.0 */\nexport type ColorSchemeMode = ColorScheme | \"system\";\n\n/**\n * @remarks \\@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/** @remarks \\@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\n * 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 * @remarks \\@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"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4EC,GACD,OAAO,SAASW;IACd,OAAOZ,WAAWC;AACpB"}
+{"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"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","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"}

package/dist/theme/useColorSchemeMetaTag.d.ts

@@ -1,6 +1,6 @@
 import { type ColorScheme } from "./useColorScheme.js";
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface ColorSchemeMetaTagOptions {
     /**
@@ -15,6 +15,6 @@ export interface ColorSchemeMetaTagOptions {
  * should not be used if you are using the `useColorSchemeProvider` since it is
  * already built in.
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare function useColorSchemeMetaTag(options: ColorSchemeMetaTagOptions): void;

package/dist/theme/useColorSchemeMetaTag.js

@@ -6,7 +6,7 @@ import { useEffect } from "react";
  * should not be used if you are using the `useColorSchemeProvider` since it is
  * already built in.
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export function useColorSchemeMetaTag(options) {
     const { disabled, colorScheme } = options;
     useEffect(()=>{

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 * @remarks \\@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 * @remarks \\@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"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","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 \"./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"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","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,7 +1,7 @@
 import { type UseStateInitializer } from "../types.js";
 import { type ColorSchemeContext, type ColorSchemeMode, type ColorSchemeModeBehavior } from "./useColorScheme.js";
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface ColorSchemeProviderOptions extends Partial<ColorSchemeModeBehavior> {
     /**
@@ -53,7 +53,7 @@ export interface ColorSchemeProviderOptions extends Partial<ColorSchemeModeBehav
  *   return <ColorSchemeProvider value={value}>{children}</ColorSchemeProvider>
  * }
  * ```
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare function useColorSchemeProvider(options?: {
     [key in keyof ColorSchemeModeBehavior]?: never;

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 * @remarks \\@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 * @remarks \\@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"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;","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 \"./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"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;","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"}

package/dist/theme/usePrefersColorScheme.d.ts

@@ -2,6 +2,6 @@
  * A simple wrapper around the {@link useMediaQuery} hook with:
  * `"(prefers-color-scheme: dark)"`.
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare function usePrefersDarkTheme(disabled?: boolean): boolean;

package/dist/theme/usePrefersColorScheme.js

@@ -4,7 +4,7 @@ import { useMediaQuery } from "../media-queries/useMediaQuery.js";
  * A simple wrapper around the {@link useMediaQuery} hook with:
  * `"(prefers-color-scheme: dark)"`.
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export function usePrefersDarkTheme(disabled = false) {
     return useMediaQuery("(prefers-color-scheme: dark)", disabled);
 }

package/dist/theme/usePrefersColorScheme.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/theme/usePrefersColorScheme.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 * @remarks \\@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"],"rangeMappings":";;;;;;;;;","mappings":"AAAA;AACA,SAASA,aAAa,QAAQ,oCAAoC;AAElE;;;;;CAKC,GACD,OAAO,SAASC,oBAAoBC,WAAW,KAAK;IAClD,OAAOF,cAAc,gCAAgCE;AACvD"}
+{"version":3,"sources":["../../src/theme/usePrefersColorScheme.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"],"rangeMappings":";;;;;;;;;","mappings":"AAAA;AACA,SAASA,aAAa,QAAQ,oCAAoC;AAElE;;;;;CAKC,GACD,OAAO,SAASC,oBAAoBC,WAAW,KAAK;IAClD,OAAOF,cAAc,gCAAgCE;AACvD"}

package/dist/theme/utils.d.ts

@@ -70,6 +70,6 @@ export declare function isContrastCompliant(background: string, foreground: stri
  * This is pretty much a javascript implementation as the `contrast-color` Sass
  * function.
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare function contrastColor(backgroundColor: string, lightColor?: string, darkColor?: string): string;

package/dist/theme/utils.js

@@ -128,7 +128,7 @@ const BLUE_MULTIPLIER = 0.0722;
  * This is pretty much a javascript implementation as the `contrast-color` Sass
  * function.
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export function contrastColor(backgroundColor, lightColor = white, darkColor = black) {
     const lightContrast = getContrastRatio(backgroundColor, lightColor);
     const darkContrast = getContrastRatio(backgroundColor, darkColor);

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 * @remarks \\@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"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","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"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","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"}

package/dist/tooltip/Tooltip.d.ts

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

package/dist/tooltip/Tooltip.js

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

package/dist/tooltip/Tooltip.js.map

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

package/dist/tooltip/TooltipHoverModeProvider.d.ts

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

package/dist/tooltip/TooltipHoverModeProvider.js

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

package/dist/tooltip/TooltipHoverModeProvider.js.map

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

package/dist/tooltip/constants.d.ts

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