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

package/dist/icon/materialConfig.d.ts

@@ -1,7 +1,7 @@
 import { type CSSProperties } from "react";
 import { type MaterialIconFamily, type MaterialSymbolFamily } from "./material.js";
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface MaterialIconCustomization {
     /**
@@ -10,7 +10,7 @@ export interface MaterialIconCustomization {
     iconFamily?: MaterialIconFamily;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type MaterialIconConfiguration = Required<MaterialIconCustomization>;
 /**
@@ -21,7 +21,7 @@ export type MaterialIconConfiguration = Required<MaterialIconCustomization>;
  * interaction. The values are 0 for default or 1 for completely filled. Along
  * with the weight axis, the fill also impacts the look of the icon.
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type MaterialSymbolFill = 0 | 1;
 /**
@@ -29,7 +29,7 @@ export type MaterialSymbolFill = 0 | 1;
  * thin (100) and bold (700). Weight can also affect the overall size of the
  * symbol.
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type MaterialSymbolWeight = 100 | 200 | 300 | 400 | 500 | 600 | 700;
 /**
@@ -49,7 +49,7 @@ export type MaterialSymbolWeight = 100 | 200 | 300 | 400 | 500 | 600 | 700;
  * - High emphasis (e.g. 200 grade): To highlight a symbol, increase the
  *   positive grade.
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type MaterialSymbolGrade = -25 | 0 | 200;
 /**
@@ -60,7 +60,7 @@ export type MaterialSymbolGrade = -25 | 0 | 200;
  * automatically adjust the stroke weight when you increase or decrease the
  * symbol size.
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type MaterialSymbolOpticalSize = 20 | 24 | 40 | 48;
 /**
@@ -69,7 +69,7 @@ export type MaterialSymbolOpticalSize = 20 | 24 | 40 | 48;
  * info icon next to each property.
  *
  * @see https://fonts.google.com/icons?icon.set=Material+Symbols
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface MaterialSymbolCustomization {
     /**
@@ -128,27 +128,27 @@ export interface MaterialSymbolCustomization {
     family?: MaterialSymbolFamily;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type MaterialSymbolConfiguration = Required<MaterialSymbolCustomization>;
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface MaterialConfiguration extends MaterialIconConfiguration, MaterialSymbolConfiguration {
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare const MATERIAL_CONFIG: MaterialConfiguration;
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface MaterialSymbolFontVariationSettings {
     style?: CSSProperties;
     family: MaterialSymbolFamily;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export declare function getFontVariationSettings(options: MaterialSymbolCustomization & {

package/dist/icon/materialConfig.js

@@ -1,5 +1,5 @@
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export const MATERIAL_CONFIG = {
     fill: 0,
     weight: 400,
@@ -9,7 +9,7 @@
     family: "outlined"
 };
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */ export function getFontVariationSettings(options) {
     let { style } = options;

package/dist/icon/materialConfig.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/icon/materialConfig.ts"],"sourcesContent":["import { type CSSProperties } from \"react\";\nimport {\n  type MaterialIconFamily,\n  type MaterialSymbolFamily,\n} from \"./material.js\";\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport interface MaterialIconCustomization {\n  /**\n   * @defaultValue `\"filled\"`\n   */\n  iconFamily?: MaterialIconFamily;\n}\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport type MaterialIconConfiguration = Required<MaterialIconCustomization>;\n\n/**\n * Fill gives you the ability to modify the default icon style. A single icon\n * can render both unfilled and filled states.\n *\n * To convey a state transition, use the fill axis for animation or\n * interaction. The values are 0 for default or 1 for completely filled. Along\n * with the weight axis, the fill also impacts the look of the icon.\n *\n * @remarks \\@since 6.0.0\n */\nexport type MaterialSymbolFill = 0 | 1;\n\n/**\n * Weight defines the symbol’s stroke weight, with a range of weights between\n * thin (100) and bold (700). Weight can also affect the overall size of the\n * symbol.\n *\n * @remarks \\@since 6.0.0\n */\nexport type MaterialSymbolWeight = 100 | 200 | 300 | 400 | 500 | 600 | 700;\n\n/**\n * Weight and grade affect a symbol’s thickness. Adjustments to grade are more\n * granular than adjustments to weight and have a small impact on the size of\n * the symbol.\n *\n * Grade is also available in some text fonts. You can match grade levels\n * between text and symbols for a harmonious visual effect. For example, if\n * the text font has a -25 grade value, the symbols can match it with a\n * suitable value, say -25.\n *\n * You can use grade for different needs:\n *\n * - Low emphasis (e.g. -25 grade): To reduce glare for a light symbol on a\n *   dark background, use a low grade.\n * - High emphasis (e.g. 200 grade): To highlight a symbol, increase the\n *   positive grade.\n *\n * @remarks \\@since 6.0.0\n */\nexport type MaterialSymbolGrade = -25 | 0 | 200;\n\n/**\n * Optical Sizes range from 20dp to 48dp.\n *\n * For the image to look the same at different sizes, the stroke weight\n * (thickness) changes as the icon size scales. Optical Size offers a way to\n * automatically adjust the stroke weight when you increase or decrease the\n * symbol size.\n *\n * @remarks \\@since 6.0.0\n */\nexport type MaterialSymbolOpticalSize = 20 | 24 | 40 | 48;\n\n/**\n * The comments for each customizable part was copied from\n * https://fonts.google.com/icons?icon.set=Material+Symbols and clicking the\n * info icon next to each property.\n *\n * @see https://fonts.google.com/icons?icon.set=Material+Symbols\n * @remarks \\@since 6.0.0\n */\nexport interface MaterialSymbolCustomization {\n  /**\n   * Fill gives you the ability to modify the default icon style. A single icon\n   * can render both unfilled and filled states.\n   *\n   * To convey a state transition, use the fill axis for animation or\n   * interaction. The values are 0 for default or 1 for completely filled. Along\n   * with the weight axis, the fill also impacts the look of the icon.\n   *\n   * @defaultValue `0`\n   */\n  fill?: MaterialSymbolFill;\n\n  /**\n   * Weight defines the symbol’s stroke weight, with a range of weights between\n   * thin (100) and bold (700). Weight can also affect the overall size of the\n   * symbol.\n   *\n   * @defaultValue `400`\n   */\n  weight?: MaterialSymbolWeight;\n\n  /**\n   * Weight and grade affect a symbol’s thickness. Adjustments to grade are more\n   * granular than adjustments to weight and have a small impact on the size of\n   * the symbol.\n   *\n   * Grade is also available in some text fonts. You can match grade levels\n   * between text and symbols for a harmonious visual effect. For example, if\n   * the text font has a -25 grade value, the symbols can match it with a\n   * suitable value, say -25.\n   *\n   * You can use grade for different needs:\n   *\n   * - Low emphasis (e.g. -25 grade): To reduce glare for a light symbol on a\n   *   dark background, use a low grade.\n   * - High emphasis (e.g. 200 grade): To highlight a symbol, increase the\n   *   positive grade.\n   *\n   * @defaultValue `0`\n   */\n  grade?: MaterialSymbolGrade;\n\n  /**\n   * Optical Sizes range from 20dp to 48dp.\n   *\n   * For the image to look the same at different sizes, the stroke weight\n   * (thickness) changes as the icon size scales. Optical Size offers a way to\n   * automatically adjust the stroke weight when you increase or decrease the\n   * symbol size.\n   *\n   * @defaultValue `48`\n   */\n  opticalSize?: MaterialSymbolOpticalSize;\n\n  /**\n   * @defaultValue `\"outlined\"`\n   */\n  family?: MaterialSymbolFamily;\n}\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport type MaterialSymbolConfiguration = Required<MaterialSymbolCustomization>;\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport interface MaterialConfiguration\n  extends MaterialIconConfiguration,\n    MaterialSymbolConfiguration {}\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport const MATERIAL_CONFIG: MaterialConfiguration = {\n  fill: 0,\n  weight: 400,\n  grade: 0,\n  opticalSize: 48,\n  iconFamily: \"filled\",\n  family: \"outlined\",\n};\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport interface MaterialSymbolFontVariationSettings {\n  style?: CSSProperties;\n  family: MaterialSymbolFamily;\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport function getFontVariationSettings(\n  options: MaterialSymbolCustomization & { style?: CSSProperties }\n): MaterialSymbolFontVariationSettings {\n  let { style } = options;\n  const {\n    fill = MATERIAL_CONFIG.fill,\n    grade = MATERIAL_CONFIG.grade,\n    opticalSize = MATERIAL_CONFIG.opticalSize,\n    weight = MATERIAL_CONFIG.weight,\n    family: symbolFamily = MATERIAL_CONFIG.family,\n  } = options;\n  if (\n    !style?.fontVariationSettings &&\n    (fill !== MATERIAL_CONFIG.fill ||\n      grade !== MATERIAL_CONFIG.grade ||\n      opticalSize !== MATERIAL_CONFIG.opticalSize ||\n      weight !== MATERIAL_CONFIG.weight)\n  ) {\n    style = {\n      ...style,\n      fontVariationSettings: `\"FILL\" ${fill}, \"wght\" ${weight}, \"GRAD\" ${grade}, \"opsz\" ${opticalSize}`,\n    };\n  }\n\n  return { family: symbolFamily, style };\n}\n"],"names":["MATERIAL_CONFIG","fill","weight","grade","opticalSize","iconFamily","family","getFontVariationSettings","options","style","symbolFamily","fontVariationSettings"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AA4JA;;CAEC,GACD,OAAO,MAAMA,kBAAyC;IACpDC,MAAM;IACNC,QAAQ;IACRC,OAAO;IACPC,aAAa;IACbC,YAAY;IACZC,QAAQ;AACV,EAAE;AAUF;;;CAGC,GACD,OAAO,SAASC,yBACdC,OAAgE;IAEhE,IAAI,EAAEC,KAAK,EAAE,GAAGD;IAChB,MAAM,EACJP,OAAOD,gBAAgBC,IAAI,EAC3BE,QAAQH,gBAAgBG,KAAK,EAC7BC,cAAcJ,gBAAgBI,WAAW,EACzCF,SAASF,gBAAgBE,MAAM,EAC/BI,QAAQI,eAAeV,gBAAgBM,MAAM,EAC9C,GAAGE;IACJ,IACE,CAACC,OAAOE,yBACPV,CAAAA,SAASD,gBAAgBC,IAAI,IAC5BE,UAAUH,gBAAgBG,KAAK,IAC/BC,gBAAgBJ,gBAAgBI,WAAW,IAC3CF,WAAWF,gBAAgBE,MAAM,AAAD,GAClC;QACAO,QAAQ;YACN,GAAGA,KAAK;YACRE,uBAAuB,CAAC,OAAO,EAAEV,KAAK,SAAS,EAAEC,OAAO,SAAS,EAAEC,MAAM,SAAS,EAAEC,YAAY,CAAC;QACnG;IACF;IAEA,OAAO;QAAEE,QAAQI;QAAcD;IAAM;AACvC"}
+{"version":3,"sources":["../../src/icon/materialConfig.ts"],"sourcesContent":["import { type CSSProperties } from \"react\";\nimport {\n  type MaterialIconFamily,\n  type MaterialSymbolFamily,\n} from \"./material.js\";\n\n/**\n * @since 6.0.0\n */\nexport interface MaterialIconCustomization {\n  /**\n   * @defaultValue `\"filled\"`\n   */\n  iconFamily?: MaterialIconFamily;\n}\n\n/**\n * @since 6.0.0\n */\nexport type MaterialIconConfiguration = Required<MaterialIconCustomization>;\n\n/**\n * Fill gives you the ability to modify the default icon style. A single icon\n * can render both unfilled and filled states.\n *\n * To convey a state transition, use the fill axis for animation or\n * interaction. The values are 0 for default or 1 for completely filled. Along\n * with the weight axis, the fill also impacts the look of the icon.\n *\n * @since 6.0.0\n */\nexport type MaterialSymbolFill = 0 | 1;\n\n/**\n * Weight defines the symbol’s stroke weight, with a range of weights between\n * thin (100) and bold (700). Weight can also affect the overall size of the\n * symbol.\n *\n * @since 6.0.0\n */\nexport type MaterialSymbolWeight = 100 | 200 | 300 | 400 | 500 | 600 | 700;\n\n/**\n * Weight and grade affect a symbol’s thickness. Adjustments to grade are more\n * granular than adjustments to weight and have a small impact on the size of\n * the symbol.\n *\n * Grade is also available in some text fonts. You can match grade levels\n * between text and symbols for a harmonious visual effect. For example, if\n * the text font has a -25 grade value, the symbols can match it with a\n * suitable value, say -25.\n *\n * You can use grade for different needs:\n *\n * - Low emphasis (e.g. -25 grade): To reduce glare for a light symbol on a\n *   dark background, use a low grade.\n * - High emphasis (e.g. 200 grade): To highlight a symbol, increase the\n *   positive grade.\n *\n * @since 6.0.0\n */\nexport type MaterialSymbolGrade = -25 | 0 | 200;\n\n/**\n * Optical Sizes range from 20dp to 48dp.\n *\n * For the image to look the same at different sizes, the stroke weight\n * (thickness) changes as the icon size scales. Optical Size offers a way to\n * automatically adjust the stroke weight when you increase or decrease the\n * symbol size.\n *\n * @since 6.0.0\n */\nexport type MaterialSymbolOpticalSize = 20 | 24 | 40 | 48;\n\n/**\n * The comments for each customizable part was copied from\n * https://fonts.google.com/icons?icon.set=Material+Symbols and clicking the\n * info icon next to each property.\n *\n * @see https://fonts.google.com/icons?icon.set=Material+Symbols\n * @since 6.0.0\n */\nexport interface MaterialSymbolCustomization {\n  /**\n   * Fill gives you the ability to modify the default icon style. A single icon\n   * can render both unfilled and filled states.\n   *\n   * To convey a state transition, use the fill axis for animation or\n   * interaction. The values are 0 for default or 1 for completely filled. Along\n   * with the weight axis, the fill also impacts the look of the icon.\n   *\n   * @defaultValue `0`\n   */\n  fill?: MaterialSymbolFill;\n\n  /**\n   * Weight defines the symbol’s stroke weight, with a range of weights between\n   * thin (100) and bold (700). Weight can also affect the overall size of the\n   * symbol.\n   *\n   * @defaultValue `400`\n   */\n  weight?: MaterialSymbolWeight;\n\n  /**\n   * Weight and grade affect a symbol’s thickness. Adjustments to grade are more\n   * granular than adjustments to weight and have a small impact on the size of\n   * the symbol.\n   *\n   * Grade is also available in some text fonts. You can match grade levels\n   * between text and symbols for a harmonious visual effect. For example, if\n   * the text font has a -25 grade value, the symbols can match it with a\n   * suitable value, say -25.\n   *\n   * You can use grade for different needs:\n   *\n   * - Low emphasis (e.g. -25 grade): To reduce glare for a light symbol on a\n   *   dark background, use a low grade.\n   * - High emphasis (e.g. 200 grade): To highlight a symbol, increase the\n   *   positive grade.\n   *\n   * @defaultValue `0`\n   */\n  grade?: MaterialSymbolGrade;\n\n  /**\n   * Optical Sizes range from 20dp to 48dp.\n   *\n   * For the image to look the same at different sizes, the stroke weight\n   * (thickness) changes as the icon size scales. Optical Size offers a way to\n   * automatically adjust the stroke weight when you increase or decrease the\n   * symbol size.\n   *\n   * @defaultValue `48`\n   */\n  opticalSize?: MaterialSymbolOpticalSize;\n\n  /**\n   * @defaultValue `\"outlined\"`\n   */\n  family?: MaterialSymbolFamily;\n}\n\n/**\n * @since 6.0.0\n */\nexport type MaterialSymbolConfiguration = Required<MaterialSymbolCustomization>;\n\n/**\n * @since 6.0.0\n */\nexport interface MaterialConfiguration\n  extends MaterialIconConfiguration,\n    MaterialSymbolConfiguration {}\n\n/**\n * @since 6.0.0\n */\nexport const MATERIAL_CONFIG: MaterialConfiguration = {\n  fill: 0,\n  weight: 400,\n  grade: 0,\n  opticalSize: 48,\n  iconFamily: \"filled\",\n  family: \"outlined\",\n};\n\n/**\n * @since 6.0.0\n */\nexport interface MaterialSymbolFontVariationSettings {\n  style?: CSSProperties;\n  family: MaterialSymbolFamily;\n}\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport function getFontVariationSettings(\n  options: MaterialSymbolCustomization & { style?: CSSProperties }\n): MaterialSymbolFontVariationSettings {\n  let { style } = options;\n  const {\n    fill = MATERIAL_CONFIG.fill,\n    grade = MATERIAL_CONFIG.grade,\n    opticalSize = MATERIAL_CONFIG.opticalSize,\n    weight = MATERIAL_CONFIG.weight,\n    family: symbolFamily = MATERIAL_CONFIG.family,\n  } = options;\n  if (\n    !style?.fontVariationSettings &&\n    (fill !== MATERIAL_CONFIG.fill ||\n      grade !== MATERIAL_CONFIG.grade ||\n      opticalSize !== MATERIAL_CONFIG.opticalSize ||\n      weight !== MATERIAL_CONFIG.weight)\n  ) {\n    style = {\n      ...style,\n      fontVariationSettings: `\"FILL\" ${fill}, \"wght\" ${weight}, \"GRAD\" ${grade}, \"opsz\" ${opticalSize}`,\n    };\n  }\n\n  return { family: symbolFamily, style };\n}\n"],"names":["MATERIAL_CONFIG","fill","weight","grade","opticalSize","iconFamily","family","getFontVariationSettings","options","style","symbolFamily","fontVariationSettings"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AA4JA;;CAEC,GACD,OAAO,MAAMA,kBAAyC;IACpDC,MAAM;IACNC,QAAQ;IACRC,OAAO;IACPC,aAAa;IACbC,YAAY;IACZC,QAAQ;AACV,EAAE;AAUF;;;CAGC,GACD,OAAO,SAASC,yBACdC,OAAgE;IAEhE,IAAI,EAAEC,KAAK,EAAE,GAAGD;IAChB,MAAM,EACJP,OAAOD,gBAAgBC,IAAI,EAC3BE,QAAQH,gBAAgBG,KAAK,EAC7BC,cAAcJ,gBAAgBI,WAAW,EACzCF,SAASF,gBAAgBE,MAAM,EAC/BI,QAAQI,eAAeV,gBAAgBM,MAAM,EAC9C,GAAGE;IACJ,IACE,CAACC,OAAOE,yBACPV,CAAAA,SAASD,gBAAgBC,IAAI,IAC5BE,UAAUH,gBAAgBG,KAAK,IAC/BC,gBAAgBJ,gBAAgBI,WAAW,IAC3CF,WAAWF,gBAAgBE,MAAM,AAAD,GAClC;QACAO,QAAQ;YACN,GAAGA,KAAK;YACRE,uBAAuB,CAAC,OAAO,EAAEV,KAAK,SAAS,EAAEC,OAAO,SAAS,EAAEC,MAAM,SAAS,EAAEC,YAAY,CAAC;QACnG;IACF;IAEA,OAAO;QAAEE,QAAQI;QAAcD;IAAM;AACvC"}

package/dist/icon/styles.d.ts

@@ -9,7 +9,7 @@ declare module "react" {
         "--rmd-icon-rotate-to"?: string | number;
     }
 }
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface SVGIconClassNameOptions {
     className?: string;
     /**
@@ -49,7 +49,7 @@ export interface SVGIconClassNameOptions {
      */
     inline?: boolean;
 }
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface FontIconClassNameOptions extends SVGIconClassNameOptions {
     /**
      * The font icon class name to use.
@@ -58,15 +58,15 @@ export interface FontIconClassNameOptions extends SVGIconClassNameOptions {
      */
     iconClassName?: string;
 }
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface MaterialIconClassNameOptions extends SVGIconClassNameOptions {
     family: MaterialIconFamily;
 }
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface MaterialSymbolClassNameOptions extends SVGIconClassNameOptions {
     family: MaterialSymbolFamily;
 }
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export type IconClassNameOptions = ({
     type: "font";
 } & FontIconClassNameOptions) | ({
@@ -78,10 +78,10 @@ export type IconClassNameOptions = ({
 } & MaterialSymbolClassNameOptions);
 /**
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare function icon(options: IconClassNameOptions): string;
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface IconRotatorClassNameOptions {
     className?: string;
     /**
@@ -97,6 +97,6 @@ export interface IconRotatorClassNameOptions {
 }
 /**
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare function iconRotator(options: IconRotatorClassNameOptions): string;

package/dist/icon/styles.js

@@ -5,7 +5,7 @@ const styles = bem("rmd-icon");
 const rotatorStyles = bem("rmd-icon-rotator");
 /**
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export function icon(options) {
     const { className, type, theme, family = "", dense = false, inline = false, iconClassName } = options;
     const isFont = type === "font";
@@ -24,7 +24,7 @@ const rotatorStyles = bem("rmd-icon-rotator");
 }
 /**
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export function iconRotator(options) {
     const { className, rotated, disableTransition = false } = options;
     return cnb(rotatorStyles({

package/dist/icon/styles.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/icon/styles.ts"],"sourcesContent":["import { cnb } from \"cnbuilder\";\nimport { cssUtils, type TextColor, type ThemeColor } from \"../cssUtils.js\";\nimport { bem } from \"../utils/bem.js\";\nimport type { MaterialIconFamily, MaterialSymbolFamily } from \"./material.js\";\n\ndeclare module \"react\" {\n  interface CSSProperties {\n    \"--rmd-icon-color\"?: string;\n    \"--rmd-icon-size\"?: string | number;\n    \"--rmd-icon-spacing\"?: string | number;\n    \"--rmd-icon-rotate-from\"?: string | number;\n    \"--rmd-icon-rotate-to\"?: string | number;\n  }\n}\n\nconst styles = bem(\"rmd-icon\");\nconst rotatorStyles = bem(\"rmd-icon-rotator\");\n\n/** @remarks \\@since 6.0.0 */\nexport interface SVGIconClassNameOptions {\n  className?: string;\n\n  /**\n   * An optional theme color to apply to the icon. When this is `undefined`, the\n   * default icon color will be used instead.\n   *\n   * - `primary -> $primary-color`\n   * - `secondary -> $secondary-color`\n   * - `warning -> $warning-color`\n   * - `success -> $success-color`\n   * - `error -> $error-color`\n   * - `text-primary -> $text-primary-color`\n   * - `text-secondary -> $text-primary-color`\n   * - `text-hint -> $text-hint-color`\n   * - `text-disabled -> $text-disabled-color`\n   */\n  theme?: ThemeColor | TextColor;\n\n  /**\n   * Boolean if the font icon should use the dense spec.\n   *\n   * @defaultValue `false`\n   */\n  dense?: boolean;\n\n  /**\n   * Set this to `true` if the icon should display inline with other text (like\n   * a paragraph) by applying `vertical-align: bottom`.\n   *\n   * @example\n   * ```tsx\n   * <Typography>\n   *   <InfoIcon inline className=\"rmd-icon--before\" />\n   *   Some additional information around xyz.\n   * </Typography>\n   * ```\n   *\n   * @defaultValue `false`\n   */\n  inline?: boolean;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport interface FontIconClassNameOptions extends SVGIconClassNameOptions {\n  /**\n   * The font icon class name to use.\n   *\n   * @defaultValue `\"material-icons\"`\n   */\n  iconClassName?: string;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport interface MaterialIconClassNameOptions extends SVGIconClassNameOptions {\n  family: MaterialIconFamily;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport interface MaterialSymbolClassNameOptions\n  extends SVGIconClassNameOptions {\n  family: MaterialSymbolFamily;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport type IconClassNameOptions =\n  | ({ type: \"font\" } & FontIconClassNameOptions)\n  | ({ type: \"svg\" } & SVGIconClassNameOptions)\n  | ({ type: \"material\" } & MaterialIconClassNameOptions)\n  | ({ type: \"symbol\" } & MaterialSymbolClassNameOptions);\n\n/**\n *\n * @remarks \\@since 6.0.0\n */\nexport function icon(options: IconClassNameOptions): string {\n  const {\n    className,\n    type,\n    theme,\n    family = \"\",\n    dense = false,\n    inline = false,\n    iconClassName,\n  } = options as FontIconClassNameOptions &\n    SVGIconClassNameOptions & {\n      type: \"font\" | \"svg\" | \"symbol\" | \"material\";\n      family?: MaterialIconFamily;\n    };\n\n  const isFont = type === \"font\";\n  const isSvg = type === \"svg\";\n  const isSymbol = type === \"symbol\";\n  const isMaterial = type === \"material\";\n\n  return cnb(\n    styles({\n      svg: isSvg,\n      font: isFont || isMaterial,\n      symbol: isSymbol,\n      vab: inline,\n      dense,\n    }),\n    isSymbol && `material-symbols-${family}`,\n    isMaterial &&\n      `material-icons${\n        family === \"filled\" ? \"\" : `-${family === \"rounded\" ? \"round\" : family}`\n      }`,\n    cssUtils({\n      textColor: theme,\n    }),\n    iconClassName,\n    className\n  );\n}\n\n/** @remarks \\@since 6.0.0 */\nexport interface IconRotatorClassNameOptions {\n  className?: string;\n\n  /**\n   * Boolean if the icon is currently rotated.\n   */\n  rotated: boolean;\n\n  /**\n   * Boolean if changing the {@link rotated} state should no longer transition.\n   *\n   * @defaultValue `false`\n   */\n  disableTransition?: boolean;\n}\n\n/**\n *\n * @remarks \\@since 6.0.0\n */\nexport function iconRotator(options: IconRotatorClassNameOptions): string {\n  const { className, rotated, disableTransition = false } = options;\n\n  return cnb(\n    rotatorStyles({\n      animate: !disableTransition,\n      rotated,\n    }),\n    className\n  );\n}\n"],"names":["cnb","cssUtils","bem","styles","rotatorStyles","icon","options","className","type","theme","family","dense","inline","iconClassName","isFont","isSvg","isSymbol","isMaterial","svg","font","symbol","vab","textColor","iconRotator","rotated","disableTransition","animate"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA,SAASA,GAAG,QAAQ,YAAY;AAChC,SAASC,QAAQ,QAAyC,iBAAiB;AAC3E,SAASC,GAAG,QAAQ,kBAAkB;AAatC,MAAMC,SAASD,IAAI;AACnB,MAAME,gBAAgBF,IAAI;AA0E1B;;;CAGC,GACD,OAAO,SAASG,KAAKC,OAA6B;IAChD,MAAM,EACJC,SAAS,EACTC,IAAI,EACJC,KAAK,EACLC,SAAS,EAAE,EACXC,QAAQ,KAAK,EACbC,SAAS,KAAK,EACdC,aAAa,EACd,GAAGP;IAMJ,MAAMQ,SAASN,SAAS;IACxB,MAAMO,QAAQP,SAAS;IACvB,MAAMQ,WAAWR,SAAS;IAC1B,MAAMS,aAAaT,SAAS;IAE5B,OAAOR,IACLG,OAAO;QACLe,KAAKH;QACLI,MAAML,UAAUG;QAChBG,QAAQJ;QACRK,KAAKT;QACLD;IACF,IACAK,YAAY,CAAC,iBAAiB,EAAEN,OAAO,CAAC,EACxCO,cACE,CAAC,cAAc,EACbP,WAAW,WAAW,KAAK,CAAC,CAAC,EAAEA,WAAW,YAAY,UAAUA,OAAO,CAAC,CACzE,CAAC,EACJT,SAAS;QACPqB,WAAWb;IACb,IACAI,eACAN;AAEJ;AAmBA;;;CAGC,GACD,OAAO,SAASgB,YAAYjB,OAAoC;IAC9D,MAAM,EAAEC,SAAS,EAAEiB,OAAO,EAAEC,oBAAoB,KAAK,EAAE,GAAGnB;IAE1D,OAAON,IACLI,cAAc;QACZsB,SAAS,CAACD;QACVD;IACF,IACAjB;AAEJ"}
+{"version":3,"sources":["../../src/icon/styles.ts"],"sourcesContent":["import { cnb } from \"cnbuilder\";\nimport { cssUtils, type TextColor, type ThemeColor } from \"../cssUtils.js\";\nimport { bem } from \"../utils/bem.js\";\nimport type { MaterialIconFamily, MaterialSymbolFamily } from \"./material.js\";\n\ndeclare module \"react\" {\n  interface CSSProperties {\n    \"--rmd-icon-color\"?: string;\n    \"--rmd-icon-size\"?: string | number;\n    \"--rmd-icon-spacing\"?: string | number;\n    \"--rmd-icon-rotate-from\"?: string | number;\n    \"--rmd-icon-rotate-to\"?: string | number;\n  }\n}\n\nconst styles = bem(\"rmd-icon\");\nconst rotatorStyles = bem(\"rmd-icon-rotator\");\n\n/** @since 6.0.0 */\nexport interface SVGIconClassNameOptions {\n  className?: string;\n\n  /**\n   * An optional theme color to apply to the icon. When this is `undefined`, the\n   * default icon color will be used instead.\n   *\n   * - `primary -> $primary-color`\n   * - `secondary -> $secondary-color`\n   * - `warning -> $warning-color`\n   * - `success -> $success-color`\n   * - `error -> $error-color`\n   * - `text-primary -> $text-primary-color`\n   * - `text-secondary -> $text-primary-color`\n   * - `text-hint -> $text-hint-color`\n   * - `text-disabled -> $text-disabled-color`\n   */\n  theme?: ThemeColor | TextColor;\n\n  /**\n   * Boolean if the font icon should use the dense spec.\n   *\n   * @defaultValue `false`\n   */\n  dense?: boolean;\n\n  /**\n   * Set this to `true` if the icon should display inline with other text (like\n   * a paragraph) by applying `vertical-align: bottom`.\n   *\n   * @example\n   * ```tsx\n   * <Typography>\n   *   <InfoIcon inline className=\"rmd-icon--before\" />\n   *   Some additional information around xyz.\n   * </Typography>\n   * ```\n   *\n   * @defaultValue `false`\n   */\n  inline?: boolean;\n}\n\n/** @since 6.0.0 */\nexport interface FontIconClassNameOptions extends SVGIconClassNameOptions {\n  /**\n   * The font icon class name to use.\n   *\n   * @defaultValue `\"material-icons\"`\n   */\n  iconClassName?: string;\n}\n\n/** @since 6.0.0 */\nexport interface MaterialIconClassNameOptions extends SVGIconClassNameOptions {\n  family: MaterialIconFamily;\n}\n\n/** @since 6.0.0 */\nexport interface MaterialSymbolClassNameOptions\n  extends SVGIconClassNameOptions {\n  family: MaterialSymbolFamily;\n}\n\n/** @since 6.0.0 */\nexport type IconClassNameOptions =\n  | ({ type: \"font\" } & FontIconClassNameOptions)\n  | ({ type: \"svg\" } & SVGIconClassNameOptions)\n  | ({ type: \"material\" } & MaterialIconClassNameOptions)\n  | ({ type: \"symbol\" } & MaterialSymbolClassNameOptions);\n\n/**\n *\n * @since 6.0.0\n */\nexport function icon(options: IconClassNameOptions): string {\n  const {\n    className,\n    type,\n    theme,\n    family = \"\",\n    dense = false,\n    inline = false,\n    iconClassName,\n  } = options as FontIconClassNameOptions &\n    SVGIconClassNameOptions & {\n      type: \"font\" | \"svg\" | \"symbol\" | \"material\";\n      family?: MaterialIconFamily;\n    };\n\n  const isFont = type === \"font\";\n  const isSvg = type === \"svg\";\n  const isSymbol = type === \"symbol\";\n  const isMaterial = type === \"material\";\n\n  return cnb(\n    styles({\n      svg: isSvg,\n      font: isFont || isMaterial,\n      symbol: isSymbol,\n      vab: inline,\n      dense,\n    }),\n    isSymbol && `material-symbols-${family}`,\n    isMaterial &&\n      `material-icons${\n        family === \"filled\" ? \"\" : `-${family === \"rounded\" ? \"round\" : family}`\n      }`,\n    cssUtils({\n      textColor: theme,\n    }),\n    iconClassName,\n    className\n  );\n}\n\n/** @since 6.0.0 */\nexport interface IconRotatorClassNameOptions {\n  className?: string;\n\n  /**\n   * Boolean if the icon is currently rotated.\n   */\n  rotated: boolean;\n\n  /**\n   * Boolean if changing the {@link rotated} state should no longer transition.\n   *\n   * @defaultValue `false`\n   */\n  disableTransition?: boolean;\n}\n\n/**\n *\n * @since 6.0.0\n */\nexport function iconRotator(options: IconRotatorClassNameOptions): string {\n  const { className, rotated, disableTransition = false } = options;\n\n  return cnb(\n    rotatorStyles({\n      animate: !disableTransition,\n      rotated,\n    }),\n    className\n  );\n}\n"],"names":["cnb","cssUtils","bem","styles","rotatorStyles","icon","options","className","type","theme","family","dense","inline","iconClassName","isFont","isSvg","isSymbol","isMaterial","svg","font","symbol","vab","textColor","iconRotator","rotated","disableTransition","animate"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA,SAASA,GAAG,QAAQ,YAAY;AAChC,SAASC,QAAQ,QAAyC,iBAAiB;AAC3E,SAASC,GAAG,QAAQ,kBAAkB;AAatC,MAAMC,SAASD,IAAI;AACnB,MAAME,gBAAgBF,IAAI;AA0E1B;;;CAGC,GACD,OAAO,SAASG,KAAKC,OAA6B;IAChD,MAAM,EACJC,SAAS,EACTC,IAAI,EACJC,KAAK,EACLC,SAAS,EAAE,EACXC,QAAQ,KAAK,EACbC,SAAS,KAAK,EACdC,aAAa,EACd,GAAGP;IAMJ,MAAMQ,SAASN,SAAS;IACxB,MAAMO,QAAQP,SAAS;IACvB,MAAMQ,WAAWR,SAAS;IAC1B,MAAMS,aAAaT,SAAS;IAE5B,OAAOR,IACLG,OAAO;QACLe,KAAKH;QACLI,MAAML,UAAUG;QAChBG,QAAQJ;QACRK,KAAKT;QACLD;IACF,IACAK,YAAY,CAAC,iBAAiB,EAAEN,OAAO,CAAC,EACxCO,cACE,CAAC,cAAc,EACbP,WAAW,WAAW,KAAK,CAAC,CAAC,EAAEA,WAAW,YAAY,UAAUA,OAAO,CAAC,CACzE,CAAC,EACJT,SAAS;QACPqB,WAAWb;IACb,IACAI,eACAN;AAEJ;AAmBA;;;CAGC,GACD,OAAO,SAASgB,YAAYjB,OAAoC;IAC9D,MAAM,EAAEC,SAAS,EAAEiB,OAAO,EAAEC,oBAAoB,KAAK,EAAE,GAAGnB;IAE1D,OAAON,IACLI,cAAc;QACZsB,SAAS,CAACD;QACVD;IACF,IACAjB;AAEJ"}

package/dist/interaction/UserInteractionModeProvider.d.ts

@@ -29,8 +29,7 @@ export interface UserInteractionModeProviderProps {
  * - only display `:focus` outlines while in `"keyboard-mode"`
  * - do not display `:hover` effects while in `"touch-mode"`
  *
- * @example
- * Mount at the root of your app
+ * @example Mount at the root of your app
  * ```tsx
  * import { createRoot } from "react-dom/client";
  * import { UserInteractionModeProvider } from "@react-md/core";

package/dist/interaction/UserInteractionModeProvider.js

@@ -28,8 +28,7 @@ const { Provider } = context;
  * - only display `:focus` outlines while in `"keyboard-mode"`
  * - do not display `:hover` effects while in `"touch-mode"`
  *
- * @example
- * Mount at the root of your app
+ * @example Mount at the root of your app
  * ```tsx
  * import { createRoot } from "react-dom/client";
  * import { UserInteractionModeProvider } from "@react-md/core";

package/dist/interaction/UserInteractionModeProvider.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/interaction/UserInteractionModeProvider.tsx"],"sourcesContent":["\"use client\";\nimport {\n  createContext,\n  useContext,\n  useEffect,\n  useMemo,\n  useRef,\n  useState,\n  type ReactElement,\n  type ReactNode,\n} from \"react\";\n\n/**\n * This is the current mode for how your user is interacting with your app. This\n * will be used to determine which type of state styles should be applied at the\n * time of interacting with an element on your page.\n *\n * @defaultValue `\"mouse\"`\n */\nexport type UserInteractionMode = \"keyboard\" | \"mouse\" | \"touch\";\n\n/** @internal */\ninterface UserInteractionModeContext {\n  __root: boolean;\n  mode: UserInteractionMode;\n}\n\nconst context = createContext<UserInteractionModeContext>({\n  __root: false,\n  mode: \"mouse\",\n});\ncontext.displayName = \"UserInteractionMode\";\nconst { Provider } = context;\n\n/**\n * @returns the current user interaction mode\n */\nexport function useUserInteractionMode(): UserInteractionMode {\n  return useContext(context).mode;\n}\n\n/** @internal */\nconst TOUCH_TIMEOUT = 1200;\n\nexport interface UserInteractionModeProviderProps {\n  children: ReactNode;\n}\n\n/**\n * **Client Component**\n *\n * This component is used to determine how a user is interacting with your app\n * to update component functionality and applying the following class names to\n * the `document.body`:\n *\n * - `\"mouse-mode\"`\n * - `\"keyboard-mode\"`\n * - `\"touch-mode\"`\n *\n * Within `react-md`, these classes are used for the following behavior:\n * - only display `:focus` outlines while in `\"keyboard-mode\"`\n * - do not display `:hover` effects while in `\"touch-mode\"`\n *\n * @example\n * Mount at the root of your app\n * ```tsx\n * import { createRoot } from \"react-dom/client\";\n * import { UserInteractionModeProvider } from \"@react-md/core\";\n * import App from \"./App\":\n *\n * const container = document.getElementById(\"root\");\n * const root = createRoot(container);\n *\n * root.render(\n *   <UserInteractionModeProvider>\n *     <App />\n *   </UserInteractionModeProvider>\n * );\n * ```\n *\n * @throws \"The `UserInteractionModeProvider` cannot be mounted multiple times.\"\n * if this component is mounted multiple times in your app.\n */\nexport function UserInteractionModeProvider(\n  props: UserInteractionModeProviderProps\n): ReactElement {\n  const { children } = props;\n  const { __root } = useContext(context);\n  if (__root) {\n    throw new Error(\n      \"The `UserInteractionModeProvider` cannot be mounted multiple times.\"\n    );\n  }\n\n  const [mode, setMode] = useState<UserInteractionMode>(\"mouse\");\n  const lastTouchTime = useRef(0);\n  const isTouchContextMenu = useRef(false);\n\n  /**\n   * This effect helps determine the current interaction mode by attaching the\n   * required event listeners to the window. The `mode` will always be defaulted\n   * to `mouse` at first since it has the least possibilities of causing errors\n   * with styles since the mouse-only styles are normally just `:hover` effects.\n   *\n   * ## Switching between modes:\n   *\n   * ### While in `mouse` mode:\n   *\n   * - any `keydown` event will switch to `keyboard` mode\n   *   - this does have the side effect of meta keys also causing the switch over,\n   *     but it feels fine since it helps show the current focus in the document\n   *     as well\n   * - any `touchstart` event will switch to `touch` mode\n   *\n   * ### While in `keyboard` mode:\n   *\n   * - any `mousedown` event will switch to `mouse` mode\n   *   - it is perfectly okay to move the mouse while in keyboard mode, but still\n   *     want to keep the keyboard styles until the user actually starts clicking\n   * - any `touchstart` event will switch to `touch` mode\n   *\n   * ### While in `touch` mode:\n   *\n   * - any `mousemove` event will switch to `mouse` mode, but **only** if there\n   *   hasn't been a `contextmenu` event within the last `1.2s`\n   *   - you can really only switch back to `mouse` mode if you are using the\n   *     devtools to emulate devices OR using a touch-desktop. I don't know how\n   *     common this really is though.\n   *   - touching the screen will always fire a `mousemove` event (which is why\n   *     the `:hover` styles are normally with `rmd-utils-mouse-only`) and even\n   *     after the `contextmenu` event. Normally want to go back to `mouse` mode\n   *     when the mouse re-enters the `window`\n   *\n   * Note: It's currently impossible to switch from `touch` to `keyboard`\n   * immediately. You'd first need to switch to `mouse` and then to `keyboard`. I\n   * don't really know of any use-cases other than the weird touch-desktop stuff\n   * and I have no experience using them.\n   */\n  useEffect(() => {\n    const enableMouseMode = (): void => setMode(\"mouse\");\n    const enableKeyboardMode = (): void => setMode(\"keyboard\");\n\n    const handleTouchStart = (): void => {\n      lastTouchTime.current = Date.now();\n      isTouchContextMenu.current = false;\n      setMode(\"touch\");\n    };\n\n    const handleMouseMove = (): void => {\n      if (\n        isTouchContextMenu.current ||\n        Date.now() - lastTouchTime.current < TOUCH_TIMEOUT\n      ) {\n        isTouchContextMenu.current = false;\n        return;\n      }\n\n      enableMouseMode();\n    };\n    const handleContextMenu = (): void => {\n      isTouchContextMenu.current = true;\n    };\n\n    const className = `${mode}-mode`;\n    document.body.classList.add(className);\n    window.addEventListener(\"touchstart\", handleTouchStart, true);\n    if (mode === \"mouse\") {\n      window.addEventListener(\"keydown\", enableKeyboardMode, true);\n    } else if (mode === \"keyboard\") {\n      window.addEventListener(\"mousedown\", enableMouseMode, true);\n    } else {\n      window.addEventListener(\"mousemove\", handleMouseMove, true);\n      window.addEventListener(\"contextmenu\", handleContextMenu, true);\n    }\n\n    return () => {\n      document.body.classList.remove(className);\n      window.removeEventListener(\"touchstart\", handleTouchStart, true);\n      if (mode === \"mouse\") {\n        window.removeEventListener(\"keydown\", enableKeyboardMode, true);\n      } else if (mode === \"keyboard\") {\n        window.removeEventListener(\"mousedown\", enableMouseMode, true);\n      } else {\n        window.removeEventListener(\"mousemove\", handleMouseMove, true);\n        window.removeEventListener(\"contextmenu\", handleContextMenu, true);\n      }\n    };\n  }, [mode]);\n\n  const value = useMemo<UserInteractionModeContext>(\n    () => ({\n      mode,\n      __root: true,\n    }),\n    [mode]\n  );\n  return <Provider value={value}>{children}</Provider>;\n}\n"],"names":["createContext","useContext","useEffect","useMemo","useRef","useState","context","__root","mode","displayName","Provider","useUserInteractionMode","TOUCH_TIMEOUT","UserInteractionModeProvider","props","children","Error","setMode","lastTouchTime","isTouchContextMenu","enableMouseMode","enableKeyboardMode","handleTouchStart","current","Date","now","handleMouseMove","handleContextMenu","className","document","body","classList","add","window","addEventListener","remove","removeEventListener","value"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;;AACA,SACEA,aAAa,EACbC,UAAU,EACVC,SAAS,EACTC,OAAO,EACPC,MAAM,EACNC,QAAQ,QAGH,QAAQ;AAiBf,MAAMC,wBAAUN,cAA0C;IACxDO,QAAQ;IACRC,MAAM;AACR;AACAF,QAAQG,WAAW,GAAG;AACtB,MAAM,EAAEC,QAAQ,EAAE,GAAGJ;AAErB;;CAEC,GACD,OAAO,SAASK;IACd,OAAOV,WAAWK,SAASE,IAAI;AACjC;AAEA,cAAc,GACd,MAAMI,gBAAgB;AAMtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkCC,GACD,OAAO,SAASC,4BACdC,KAAuC;IAEvC,MAAM,EAAEC,QAAQ,EAAE,GAAGD;IACrB,MAAM,EAAEP,MAAM,EAAE,GAAGN,WAAWK;IAC9B,IAAIC,QAAQ;QACV,MAAM,IAAIS,MACR;IAEJ;IAEA,MAAM,CAACR,MAAMS,QAAQ,GAAGZ,SAA8B;IACtD,MAAMa,gBAAgBd,OAAO;IAC7B,MAAMe,qBAAqBf,OAAO;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCC,GACDF,UAAU;QACR,MAAMkB,kBAAkB,IAAYH,QAAQ;QAC5C,MAAMI,qBAAqB,IAAYJ,QAAQ;QAE/C,MAAMK,mBAAmB;YACvBJ,cAAcK,OAAO,GAAGC,KAAKC,GAAG;YAChCN,mBAAmBI,OAAO,GAAG;YAC7BN,QAAQ;QACV;QAEA,MAAMS,kBAAkB;YACtB,IACEP,mBAAmBI,OAAO,IAC1BC,KAAKC,GAAG,KAAKP,cAAcK,OAAO,GAAGX,eACrC;gBACAO,mBAAmBI,OAAO,GAAG;gBAC7B;YACF;YAEAH;QACF;QACA,MAAMO,oBAAoB;YACxBR,mBAAmBI,OAAO,GAAG;QAC/B;QAEA,MAAMK,YAAY,CAAC,EAAEpB,KAAK,KAAK,CAAC;QAChCqB,SAASC,IAAI,CAACC,SAAS,CAACC,GAAG,CAACJ;QAC5BK,OAAOC,gBAAgB,CAAC,cAAcZ,kBAAkB;QACxD,IAAId,SAAS,SAAS;YACpByB,OAAOC,gBAAgB,CAAC,WAAWb,oBAAoB;QACzD,OAAO,IAAIb,SAAS,YAAY;YAC9ByB,OAAOC,gBAAgB,CAAC,aAAad,iBAAiB;QACxD,OAAO;YACLa,OAAOC,gBAAgB,CAAC,aAAaR,iBAAiB;YACtDO,OAAOC,gBAAgB,CAAC,eAAeP,mBAAmB;QAC5D;QAEA,OAAO;YACLE,SAASC,IAAI,CAACC,SAAS,CAACI,MAAM,CAACP;YAC/BK,OAAOG,mBAAmB,CAAC,cAAcd,kBAAkB;YAC3D,IAAId,SAAS,SAAS;gBACpByB,OAAOG,mBAAmB,CAAC,WAAWf,oBAAoB;YAC5D,OAAO,IAAIb,SAAS,YAAY;gBAC9ByB,OAAOG,mBAAmB,CAAC,aAAahB,iBAAiB;YAC3D,OAAO;gBACLa,OAAOG,mBAAmB,CAAC,aAAaV,iBAAiB;gBACzDO,OAAOG,mBAAmB,CAAC,eAAeT,mBAAmB;YAC/D;QACF;IACF,GAAG;QAACnB;KAAK;IAET,MAAM6B,QAAQlC,QACZ,IAAO,CAAA;YACLK;YACAD,QAAQ;QACV,CAAA,GACA;QAACC;KAAK;IAER,qBAAO,KAACE;QAAS2B,OAAOA;kBAAQtB;;AAClC"}
+{"version":3,"sources":["../../src/interaction/UserInteractionModeProvider.tsx"],"sourcesContent":["\"use client\";\nimport {\n  createContext,\n  useContext,\n  useEffect,\n  useMemo,\n  useRef,\n  useState,\n  type ReactElement,\n  type ReactNode,\n} from \"react\";\n\n/**\n * This is the current mode for how your user is interacting with your app. This\n * will be used to determine which type of state styles should be applied at the\n * time of interacting with an element on your page.\n *\n * @defaultValue `\"mouse\"`\n */\nexport type UserInteractionMode = \"keyboard\" | \"mouse\" | \"touch\";\n\n/** @internal */\ninterface UserInteractionModeContext {\n  __root: boolean;\n  mode: UserInteractionMode;\n}\n\nconst context = createContext<UserInteractionModeContext>({\n  __root: false,\n  mode: \"mouse\",\n});\ncontext.displayName = \"UserInteractionMode\";\nconst { Provider } = context;\n\n/**\n * @returns the current user interaction mode\n */\nexport function useUserInteractionMode(): UserInteractionMode {\n  return useContext(context).mode;\n}\n\n/** @internal */\nconst TOUCH_TIMEOUT = 1200;\n\nexport interface UserInteractionModeProviderProps {\n  children: ReactNode;\n}\n\n/**\n * **Client Component**\n *\n * This component is used to determine how a user is interacting with your app\n * to update component functionality and applying the following class names to\n * the `document.body`:\n *\n * - `\"mouse-mode\"`\n * - `\"keyboard-mode\"`\n * - `\"touch-mode\"`\n *\n * Within `react-md`, these classes are used for the following behavior:\n * - only display `:focus` outlines while in `\"keyboard-mode\"`\n * - do not display `:hover` effects while in `\"touch-mode\"`\n *\n * @example Mount at the root of your app\n * ```tsx\n * import { createRoot } from \"react-dom/client\";\n * import { UserInteractionModeProvider } from \"@react-md/core\";\n * import App from \"./App\":\n *\n * const container = document.getElementById(\"root\");\n * const root = createRoot(container);\n *\n * root.render(\n *   <UserInteractionModeProvider>\n *     <App />\n *   </UserInteractionModeProvider>\n * );\n * ```\n *\n * @throws \"The `UserInteractionModeProvider` cannot be mounted multiple times.\"\n * if this component is mounted multiple times in your app.\n */\nexport function UserInteractionModeProvider(\n  props: UserInteractionModeProviderProps\n): ReactElement {\n  const { children } = props;\n  const { __root } = useContext(context);\n  if (__root) {\n    throw new Error(\n      \"The `UserInteractionModeProvider` cannot be mounted multiple times.\"\n    );\n  }\n\n  const [mode, setMode] = useState<UserInteractionMode>(\"mouse\");\n  const lastTouchTime = useRef(0);\n  const isTouchContextMenu = useRef(false);\n\n  /**\n   * This effect helps determine the current interaction mode by attaching the\n   * required event listeners to the window. The `mode` will always be defaulted\n   * to `mouse` at first since it has the least possibilities of causing errors\n   * with styles since the mouse-only styles are normally just `:hover` effects.\n   *\n   * ## Switching between modes:\n   *\n   * ### While in `mouse` mode:\n   *\n   * - any `keydown` event will switch to `keyboard` mode\n   *   - this does have the side effect of meta keys also causing the switch over,\n   *     but it feels fine since it helps show the current focus in the document\n   *     as well\n   * - any `touchstart` event will switch to `touch` mode\n   *\n   * ### While in `keyboard` mode:\n   *\n   * - any `mousedown` event will switch to `mouse` mode\n   *   - it is perfectly okay to move the mouse while in keyboard mode, but still\n   *     want to keep the keyboard styles until the user actually starts clicking\n   * - any `touchstart` event will switch to `touch` mode\n   *\n   * ### While in `touch` mode:\n   *\n   * - any `mousemove` event will switch to `mouse` mode, but **only** if there\n   *   hasn't been a `contextmenu` event within the last `1.2s`\n   *   - you can really only switch back to `mouse` mode if you are using the\n   *     devtools to emulate devices OR using a touch-desktop. I don't know how\n   *     common this really is though.\n   *   - touching the screen will always fire a `mousemove` event (which is why\n   *     the `:hover` styles are normally with `rmd-utils-mouse-only`) and even\n   *     after the `contextmenu` event. Normally want to go back to `mouse` mode\n   *     when the mouse re-enters the `window`\n   *\n   * Note: It's currently impossible to switch from `touch` to `keyboard`\n   * immediately. You'd first need to switch to `mouse` and then to `keyboard`. I\n   * don't really know of any use-cases other than the weird touch-desktop stuff\n   * and I have no experience using them.\n   */\n  useEffect(() => {\n    const enableMouseMode = (): void => setMode(\"mouse\");\n    const enableKeyboardMode = (): void => setMode(\"keyboard\");\n\n    const handleTouchStart = (): void => {\n      lastTouchTime.current = Date.now();\n      isTouchContextMenu.current = false;\n      setMode(\"touch\");\n    };\n\n    const handleMouseMove = (): void => {\n      if (\n        isTouchContextMenu.current ||\n        Date.now() - lastTouchTime.current < TOUCH_TIMEOUT\n      ) {\n        isTouchContextMenu.current = false;\n        return;\n      }\n\n      enableMouseMode();\n    };\n    const handleContextMenu = (): void => {\n      isTouchContextMenu.current = true;\n    };\n\n    const className = `${mode}-mode`;\n    document.body.classList.add(className);\n    window.addEventListener(\"touchstart\", handleTouchStart, true);\n    if (mode === \"mouse\") {\n      window.addEventListener(\"keydown\", enableKeyboardMode, true);\n    } else if (mode === \"keyboard\") {\n      window.addEventListener(\"mousedown\", enableMouseMode, true);\n    } else {\n      window.addEventListener(\"mousemove\", handleMouseMove, true);\n      window.addEventListener(\"contextmenu\", handleContextMenu, true);\n    }\n\n    return () => {\n      document.body.classList.remove(className);\n      window.removeEventListener(\"touchstart\", handleTouchStart, true);\n      if (mode === \"mouse\") {\n        window.removeEventListener(\"keydown\", enableKeyboardMode, true);\n      } else if (mode === \"keyboard\") {\n        window.removeEventListener(\"mousedown\", enableMouseMode, true);\n      } else {\n        window.removeEventListener(\"mousemove\", handleMouseMove, true);\n        window.removeEventListener(\"contextmenu\", handleContextMenu, true);\n      }\n    };\n  }, [mode]);\n\n  const value = useMemo<UserInteractionModeContext>(\n    () => ({\n      mode,\n      __root: true,\n    }),\n    [mode]\n  );\n  return <Provider value={value}>{children}</Provider>;\n}\n"],"names":["createContext","useContext","useEffect","useMemo","useRef","useState","context","__root","mode","displayName","Provider","useUserInteractionMode","TOUCH_TIMEOUT","UserInteractionModeProvider","props","children","Error","setMode","lastTouchTime","isTouchContextMenu","enableMouseMode","enableKeyboardMode","handleTouchStart","current","Date","now","handleMouseMove","handleContextMenu","className","document","body","classList","add","window","addEventListener","remove","removeEventListener","value"],"rangeMappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;","mappings":"AAAA;;AACA,SACEA,aAAa,EACbC,UAAU,EACVC,SAAS,EACTC,OAAO,EACPC,MAAM,EACNC,QAAQ,QAGH,QAAQ;AAiBf,MAAMC,wBAAUN,cAA0C;IACxDO,QAAQ;IACRC,MAAM;AACR;AACAF,QAAQG,WAAW,GAAG;AACtB,MAAM,EAAEC,QAAQ,EAAE,GAAGJ;AAErB;;CAEC,GACD,OAAO,SAASK;IACd,OAAOV,WAAWK,SAASE,IAAI;AACjC;AAEA,cAAc,GACd,MAAMI,gBAAgB;AAMtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiCC,GACD,OAAO,SAASC,4BACdC,KAAuC;IAEvC,MAAM,EAAEC,QAAQ,EAAE,GAAGD;IACrB,MAAM,EAAEP,MAAM,EAAE,GAAGN,WAAWK;IAC9B,IAAIC,QAAQ;QACV,MAAM,IAAIS,MACR;IAEJ;IAEA,MAAM,CAACR,MAAMS,QAAQ,GAAGZ,SAA8B;IACtD,MAAMa,gBAAgBd,OAAO;IAC7B,MAAMe,qBAAqBf,OAAO;IAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCC,GACDF,UAAU;QACR,MAAMkB,kBAAkB,IAAYH,QAAQ;QAC5C,MAAMI,qBAAqB,IAAYJ,QAAQ;QAE/C,MAAMK,mBAAmB;YACvBJ,cAAcK,OAAO,GAAGC,KAAKC,GAAG;YAChCN,mBAAmBI,OAAO,GAAG;YAC7BN,QAAQ;QACV;QAEA,MAAMS,kBAAkB;YACtB,IACEP,mBAAmBI,OAAO,IAC1BC,KAAKC,GAAG,KAAKP,cAAcK,OAAO,GAAGX,eACrC;gBACAO,mBAAmBI,OAAO,GAAG;gBAC7B;YACF;YAEAH;QACF;QACA,MAAMO,oBAAoB;YACxBR,mBAAmBI,OAAO,GAAG;QAC/B;QAEA,MAAMK,YAAY,CAAC,EAAEpB,KAAK,KAAK,CAAC;QAChCqB,SAASC,IAAI,CAACC,SAAS,CAACC,GAAG,CAACJ;QAC5BK,OAAOC,gBAAgB,CAAC,cAAcZ,kBAAkB;QACxD,IAAId,SAAS,SAAS;YACpByB,OAAOC,gBAAgB,CAAC,WAAWb,oBAAoB;QACzD,OAAO,IAAIb,SAAS,YAAY;YAC9ByB,OAAOC,gBAAgB,CAAC,aAAad,iBAAiB;QACxD,OAAO;YACLa,OAAOC,gBAAgB,CAAC,aAAaR,iBAAiB;YACtDO,OAAOC,gBAAgB,CAAC,eAAeP,mBAAmB;QAC5D;QAEA,OAAO;YACLE,SAASC,IAAI,CAACC,SAAS,CAACI,MAAM,CAACP;YAC/BK,OAAOG,mBAAmB,CAAC,cAAcd,kBAAkB;YAC3D,IAAId,SAAS,SAAS;gBACpByB,OAAOG,mBAAmB,CAAC,WAAWf,oBAAoB;YAC5D,OAAO,IAAIb,SAAS,YAAY;gBAC9ByB,OAAOG,mBAAmB,CAAC,aAAahB,iBAAiB;YAC3D,OAAO;gBACLa,OAAOG,mBAAmB,CAAC,aAAaV,iBAAiB;gBACzDO,OAAOG,mBAAmB,CAAC,eAAeT,mBAAmB;YAC/D;QACF;IACF,GAAG;QAACnB;KAAK;IAET,MAAM6B,QAAQlC,QACZ,IAAO,CAAA;YACLK;YACAD,QAAQ;QACV,CAAA,GACA;QAACC;KAAK;IAER,qBAAO,KAACE;QAAS2B,OAAOA;kBAAQtB;;AAClC"}

package/dist/interaction/config.d.ts

@@ -1,12 +1,12 @@
 import { type ElementInteractionMode } from "./types.js";
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface ElementInteractionConfiguration {
     mode: ElementInteractionMode;
     higherContrast: boolean;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare const INTERACTION_CONFIG: ElementInteractionConfiguration;

package/dist/interaction/config.js

@@ -2,7 +2,7 @@
 let mode = "ripple";
 let higherContrast = true;
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export const INTERACTION_CONFIG = {
     get mode () {
         return mode;

package/dist/interaction/config.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/interaction/config.ts"],"sourcesContent":["import { type ElementInteractionMode } from \"./types.js\";\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport interface ElementInteractionConfiguration {\n  mode: ElementInteractionMode;\n  higherContrast: boolean;\n}\n\n// NOTE: Uses get/set for test mocking\n\nlet mode: ElementInteractionMode = \"ripple\";\nlet higherContrast = true;\n\n/**\n * @remarks \\@since 6.0.0\n */\nexport const INTERACTION_CONFIG: ElementInteractionConfiguration = {\n  get mode() {\n    return mode;\n  },\n  set mode(nextMode: ElementInteractionMode) {\n    mode = nextMode;\n  },\n  get higherContrast() {\n    return higherContrast;\n  },\n  set higherContrast(nextHigherContrast) {\n    higherContrast = nextHigherContrast;\n  },\n};\n"],"names":["mode","higherContrast","INTERACTION_CONFIG","nextMode","nextHigherContrast"],"rangeMappings":";;;;;;;;;;;;;;;;;;","mappings":"AAUA,sCAAsC;AAEtC,IAAIA,OAA+B;AACnC,IAAIC,iBAAiB;AAErB;;CAEC,GACD,OAAO,MAAMC,qBAAsD;IACjE,IAAIF,QAAO;QACT,OAAOA;IACT;IACA,IAAIA,MAAKG,SAAkC;QACzCH,OAAOG;IACT;IACA,IAAIF,kBAAiB;QACnB,OAAOA;IACT;IACA,IAAIA,gBAAeG,mBAAoB;QACrCH,iBAAiBG;IACnB;AACF,EAAE"}
+{"version":3,"sources":["../../src/interaction/config.ts"],"sourcesContent":["import { type ElementInteractionMode } from \"./types.js\";\n\n/**\n * @since 6.0.0\n */\nexport interface ElementInteractionConfiguration {\n  mode: ElementInteractionMode;\n  higherContrast: boolean;\n}\n\n// NOTE: Uses get/set for test mocking\n\nlet mode: ElementInteractionMode = \"ripple\";\nlet higherContrast = true;\n\n/**\n * @since 6.0.0\n */\nexport const INTERACTION_CONFIG: ElementInteractionConfiguration = {\n  get mode() {\n    return mode;\n  },\n  set mode(nextMode: ElementInteractionMode) {\n    mode = nextMode;\n  },\n  get higherContrast() {\n    return higherContrast;\n  },\n  set higherContrast(nextHigherContrast) {\n    higherContrast = nextHigherContrast;\n  },\n};\n"],"names":["mode","higherContrast","INTERACTION_CONFIG","nextMode","nextHigherContrast"],"rangeMappings":";;;;;;;;;;;;;;;;;;","mappings":"AAUA,sCAAsC;AAEtC,IAAIA,OAA+B;AACnC,IAAIC,iBAAiB;AAErB;;CAEC,GACD,OAAO,MAAMC,qBAAsD;IACjE,IAAIF,QAAO;QACT,OAAOA;IACT;IACA,IAAIA,MAAKG,SAAkC;QACzCH,OAAOG;IACT;IACA,IAAIF,kBAAiB;QACnB,OAAOA;IACT;IACA,IAAIA,gBAAeG,mBAAoB;QACrCH,iBAAiBG;IACnB;AACF,EAAE"}

package/dist/interaction/types.d.ts

@@ -33,10 +33,10 @@ declare module "react" {
  * Note: this should match the `$interaction-mode` SCSS variable.
  *
  * @defaultValue `"ripple"`
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export type ElementInteractionMode = "ripple" | "press" | "none";
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface ElementInteractionHandlers<E extends HTMLElement> {
     onBlur: FocusEventHandler<E>;
     /**
@@ -104,7 +104,7 @@ export interface ElementInteractionHandlers<E extends HTMLElement> {
     onTouchMove: TouchEventHandler<E>;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export interface RippleStyle {
@@ -114,7 +114,7 @@ export interface RippleStyle {
     readonly width: number;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export interface RippleState {
@@ -124,12 +124,12 @@ export interface RippleState {
     readonly startTime: number;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export type RippleStateList = readonly RippleState[];
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export interface RippleTransitionCallbacks {
@@ -137,14 +137,14 @@ export interface RippleTransitionCallbacks {
     onExited(ripple: RippleState): void;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export interface ProvidedRippleContainerProps extends RippleTransitionCallbacks {
     ripples: RippleStateList;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */
 export interface ElementInteractionState {

package/dist/interaction/types.js

@@ -1,5 +1,5 @@
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  * @internal
  */ export { };
 

package/dist/interaction/types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/interaction/types.ts"],"sourcesContent":["import type {\n  DragEventHandler,\n  FocusEventHandler,\n  KeyboardEventHandler,\n  MouseEventHandler,\n  TouchEventHandler,\n} from \"react\";\n\ndeclare module \"react\" {\n  interface CSSProperties {\n    \"--rmd-ripple-background-color\"?: string;\n    \"--rmd-interaction-background-color\"?: string;\n    \"--rmd-hover-background-color\"?: string;\n    \"--rmd-focus-background-color\"?: string;\n    \"--rmd-press-background-color\"?: string;\n    \"--rmd-selected-background-color\"?: string;\n    \"--rmd-focus-color\"?: string;\n    \"--rmd-focus-width\"?: string | number;\n  }\n}\n\n/**\n * This is used to provide feedback to the user that they are interacting with\n * elements on the page. It is recommended to not set this to `\"none\"` unless\n * you will implement your own version.\n *\n * When this is set to `\"press\"`, the `background-color` for the element will\n * become slightly darker while the user:\n * - is holding the mouse down on the element\n * - holding the enter or space key on the element\n * - holding their finger on the element for touch devices\n *\n * The `background-color` will transition in and out based on the pressed state.\n *\n * When this is set to `\"ripple\"`, a water droplet type of animation will appear\n * from the current coordinates of the mouse or touch event within the element.\n * Keyboard events will just trigger the animation from the center of the\n * element. Once the user stops pressing the element, the animation will start\n * to fade out.\n *\n * Note: this should match the `$interaction-mode` SCSS variable.\n *\n * @defaultValue `\"ripple\"`\n * @remarks \\@since 6.0.0\n */\nexport type ElementInteractionMode = \"ripple\" | \"press\" | \"none\";\n\n/** @remarks \\@since 6.0.0 */\nexport interface ElementInteractionHandlers<E extends HTMLElement> {\n  onBlur: FocusEventHandler<E>;\n\n  /**\n   * The click event handler is is only used to display a ripple for\n   * `<button type=\"submit\" />` since pressing enter on form elements should\n   * submit the form. This ripple is really just to help show that the form has\n   * been submitted.\n   */\n  onClick: MouseEventHandler<E>;\n\n  /**\n   * The keydown event handler is used to either activate the `pressed` state\n   * for the element or start the ripple animation when the `enter` or `space`\n   * keys are pressed. It will also trigger a click event for elements that do\n   * not support this natively (`<button>`, `<a>`).\n   *\n   * When the space key is pressed, `event.preventDefault()` will also be called\n   * to prevent the page from scrolling.\n   */\n  onKeyDown: KeyboardEventHandler<E>;\n\n  /**\n   * The keyup event handler is used to either deactivate the `pressed` state\n   * for the element or start the exit animation for the ripple if the ripple\n   * was activated by the keydown event.\n   */\n  onKeyUp: KeyboardEventHandler<E>;\n\n  /**\n   * The mousedown event handler is used to either activate the `pressed` state\n   * for the element or start the ripple animation.\n   */\n  onMouseDown: MouseEventHandler<E>;\n\n  /**\n   * The mouseup event handler is used to either deactivate the `pressed` state\n   * for the element or start the exit animation for the ripple if the ripple\n   * was activated by the mousedown event.\n   */\n  onMouseUp: MouseEventHandler<E>;\n\n  /**\n   * The mouseleave event handler will remove all ripples and prevent any other\n   * interactions if the current {@link UserInteractionMode} is `\"mouse\"`.\n   *\n   * The ripples have to be cancelled since the user might release the mouse\n   * outside of the element which would never trigger the `onMouseUp` flow.\n   */\n  onMouseLeave: MouseEventHandler<E>;\n\n  /**\n   * The dragstart event handler will remove the ripples and prevent any other\n   * interactions.\n   */\n  onDragStart: DragEventHandler<E>;\n\n  /**\n   * The touchstart event handler is used to either activate the `pressed` state\n   * for the element or start the ripple animation.\n   */\n  onTouchStart: TouchEventHandler<E>;\n\n  /**\n   * The touchend event handler is used to either deactivate the `pressed`\n   * state for the element or start the exit animation for the ripple if the\n   * ripple was activated by the touchstart event.\n   */\n  onTouchEnd: TouchEventHandler<E>;\n\n  /**\n   * The touchmove event handler will remove all ripples and prevent any other\n   * interactions if the current {@link UserInteractionMode} is `\"touch\"`.\n   */\n  onTouchMove: TouchEventHandler<E>;\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport interface RippleStyle {\n  readonly left: number;\n  readonly top: number;\n  readonly height: number;\n  readonly width: number;\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport interface RippleState {\n  readonly style: RippleStyle;\n  readonly exiting: boolean;\n  readonly entered: boolean;\n  readonly startTime: number;\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport type RippleStateList = readonly RippleState[];\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport interface RippleTransitionCallbacks {\n  onEntered(ripple: RippleState): void;\n  onExited(ripple: RippleState): void;\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport interface ProvidedRippleContainerProps\n  extends RippleTransitionCallbacks {\n  ripples: RippleStateList;\n}\n\n/**\n * @remarks \\@since 6.0.0\n * @internal\n */\nexport interface ElementInteractionState {\n  pressed: boolean;\n  ripples: RippleStateList;\n}\n"],"names":[],"rangeMappings":";;;","mappings":"AA2KA;;;CAGC,GACD,WAGC"}
+{"version":3,"sources":["../../src/interaction/types.ts"],"sourcesContent":["import type {\n  DragEventHandler,\n  FocusEventHandler,\n  KeyboardEventHandler,\n  MouseEventHandler,\n  TouchEventHandler,\n} from \"react\";\n\ndeclare module \"react\" {\n  interface CSSProperties {\n    \"--rmd-ripple-background-color\"?: string;\n    \"--rmd-interaction-background-color\"?: string;\n    \"--rmd-hover-background-color\"?: string;\n    \"--rmd-focus-background-color\"?: string;\n    \"--rmd-press-background-color\"?: string;\n    \"--rmd-selected-background-color\"?: string;\n    \"--rmd-focus-color\"?: string;\n    \"--rmd-focus-width\"?: string | number;\n  }\n}\n\n/**\n * This is used to provide feedback to the user that they are interacting with\n * elements on the page. It is recommended to not set this to `\"none\"` unless\n * you will implement your own version.\n *\n * When this is set to `\"press\"`, the `background-color` for the element will\n * become slightly darker while the user:\n * - is holding the mouse down on the element\n * - holding the enter or space key on the element\n * - holding their finger on the element for touch devices\n *\n * The `background-color` will transition in and out based on the pressed state.\n *\n * When this is set to `\"ripple\"`, a water droplet type of animation will appear\n * from the current coordinates of the mouse or touch event within the element.\n * Keyboard events will just trigger the animation from the center of the\n * element. Once the user stops pressing the element, the animation will start\n * to fade out.\n *\n * Note: this should match the `$interaction-mode` SCSS variable.\n *\n * @defaultValue `\"ripple\"`\n * @since 6.0.0\n */\nexport type ElementInteractionMode = \"ripple\" | \"press\" | \"none\";\n\n/** @since 6.0.0 */\nexport interface ElementInteractionHandlers<E extends HTMLElement> {\n  onBlur: FocusEventHandler<E>;\n\n  /**\n   * The click event handler is is only used to display a ripple for\n   * `<button type=\"submit\" />` since pressing enter on form elements should\n   * submit the form. This ripple is really just to help show that the form has\n   * been submitted.\n   */\n  onClick: MouseEventHandler<E>;\n\n  /**\n   * The keydown event handler is used to either activate the `pressed` state\n   * for the element or start the ripple animation when the `enter` or `space`\n   * keys are pressed. It will also trigger a click event for elements that do\n   * not support this natively (`<button>`, `<a>`).\n   *\n   * When the space key is pressed, `event.preventDefault()` will also be called\n   * to prevent the page from scrolling.\n   */\n  onKeyDown: KeyboardEventHandler<E>;\n\n  /**\n   * The keyup event handler is used to either deactivate the `pressed` state\n   * for the element or start the exit animation for the ripple if the ripple\n   * was activated by the keydown event.\n   */\n  onKeyUp: KeyboardEventHandler<E>;\n\n  /**\n   * The mousedown event handler is used to either activate the `pressed` state\n   * for the element or start the ripple animation.\n   */\n  onMouseDown: MouseEventHandler<E>;\n\n  /**\n   * The mouseup event handler is used to either deactivate the `pressed` state\n   * for the element or start the exit animation for the ripple if the ripple\n   * was activated by the mousedown event.\n   */\n  onMouseUp: MouseEventHandler<E>;\n\n  /**\n   * The mouseleave event handler will remove all ripples and prevent any other\n   * interactions if the current {@link UserInteractionMode} is `\"mouse\"`.\n   *\n   * The ripples have to be cancelled since the user might release the mouse\n   * outside of the element which would never trigger the `onMouseUp` flow.\n   */\n  onMouseLeave: MouseEventHandler<E>;\n\n  /**\n   * The dragstart event handler will remove the ripples and prevent any other\n   * interactions.\n   */\n  onDragStart: DragEventHandler<E>;\n\n  /**\n   * The touchstart event handler is used to either activate the `pressed` state\n   * for the element or start the ripple animation.\n   */\n  onTouchStart: TouchEventHandler<E>;\n\n  /**\n   * The touchend event handler is used to either deactivate the `pressed`\n   * state for the element or start the exit animation for the ripple if the\n   * ripple was activated by the touchstart event.\n   */\n  onTouchEnd: TouchEventHandler<E>;\n\n  /**\n   * The touchmove event handler will remove all ripples and prevent any other\n   * interactions if the current {@link UserInteractionMode} is `\"touch\"`.\n   */\n  onTouchMove: TouchEventHandler<E>;\n}\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport interface RippleStyle {\n  readonly left: number;\n  readonly top: number;\n  readonly height: number;\n  readonly width: number;\n}\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport interface RippleState {\n  readonly style: RippleStyle;\n  readonly exiting: boolean;\n  readonly entered: boolean;\n  readonly startTime: number;\n}\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport type RippleStateList = readonly RippleState[];\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport interface RippleTransitionCallbacks {\n  onEntered(ripple: RippleState): void;\n  onExited(ripple: RippleState): void;\n}\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport interface ProvidedRippleContainerProps\n  extends RippleTransitionCallbacks {\n  ripples: RippleStateList;\n}\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport interface ElementInteractionState {\n  pressed: boolean;\n  ripples: RippleStateList;\n}\n"],"names":[],"rangeMappings":";;;","mappings":"AA2KA;;;CAGC,GACD,WAGC"}

package/dist/interaction/useElementInteraction.d.ts

@@ -6,9 +6,9 @@ declare module "react" {
         "--rmd-surface-border-radius"?: string | number;
     }
 }
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export declare const PRESSED_CLASS_NAME = "rmd-pressed";
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface ElementInteractionOptions<E extends HTMLElement> extends Partial<ElementInteractionHandlers<E>> {
     /**
      * Boolean if the element is currently disabled which will prevent any of the
@@ -18,7 +18,7 @@ export interface ElementInteractionOptions<E extends HTMLElement> extends Partia
      */
     disabled?: boolean;
 }
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface ElementInteractionHookReturnValue<E extends HTMLElement> {
     /**
      * The event handlers required for element interaction.
@@ -36,7 +36,7 @@ export interface ElementInteractionHookReturnValue<E extends HTMLElement> {
      */
     pressedClassName: string | undefined;
     /**
-     * The ripple click/touch interaction. This will be `undefined` when the {@Link ElementInteractionMode}
+     * The ripple click/touch interaction. This will be `undefined` when the {@link ElementInteractionMode}
      * is set to `"none"` or `"press"`.
      */
     ripples?: ReactElement;
@@ -45,8 +45,7 @@ export interface ElementInteractionHookReturnValue<E extends HTMLElement> {
  * This hook is used to apply the required element interaction based on the
  * {@link ElementInteractionMode} and should generally be used internally only.
  *
- * @example
- * Providing Element Interaction
+ * @example Providing Element Interaction
  * ```tsx
  * import { useElementInteraction } from "@react-md/core";
  * import { cnb } from "cnbuilder";
@@ -112,7 +111,7 @@ export interface ElementInteractionHookReturnValue<E extends HTMLElement> {
  * @param options - An object of {@link ElementInteractionOptions} that is used
  * to merge event handlers or disable the interactions.
  * @returns the {@link ElementInteractionHookReturnValue}
- * @remarks \@since 6.0.0 Touch interactions were removed since it never looked
+ * @since 6.0.0 Touch interactions were removed since it never looked
  * good if the user touched a clickable element right before scrolling. The
  * ripple effect will only be fired on click now for touch devices.
  */

package/dist/interaction/useElementInteraction.js

@@ -5,7 +5,7 @@ import { RippleContainer } from "./RippleContainer.js";
 import { useUserInteractionMode } from "./UserInteractionModeProvider.js";
 import { INTERACTION_CONFIG } from "./config.js";
 import { getRippleStyle, releaseRipple, updateRipplesState } from "./utils.js";
-/** @remarks \@since 6.0.0 */ export const PRESSED_CLASS_NAME = "rmd-pressed";
+/** @since 6.0.0 */ export const PRESSED_CLASS_NAME = "rmd-pressed";
 const noop = ()=>{
 // do nothing
 };
@@ -13,8 +13,7 @@ const noop = ()=>{
  * This hook is used to apply the required element interaction based on the
  * {@link ElementInteractionMode} and should generally be used internally only.
  *
- * @example
- * Providing Element Interaction
+ * @example Providing Element Interaction
  * ```tsx
  * import { useElementInteraction } from "@react-md/core";
  * import { cnb } from "cnbuilder";
@@ -80,7 +79,7 @@ const noop = ()=>{
  * @param options - An object of {@link ElementInteractionOptions} that is used
  * to merge event handlers or disable the interactions.
  * @returns the {@link ElementInteractionHookReturnValue}
- * @remarks \@since 6.0.0 Touch interactions were removed since it never looked
+ * @since 6.0.0 Touch interactions were removed since it never looked
  * good if the user touched a clickable element right before scrolling. The
  * ripple effect will only be fired on click now for touch devices.
  */ export function useElementInteraction(options = {}) {