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

package/dist/utils/applyRef.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/applyRef.ts"],"sourcesContent":["import type { MutableRefObject, Ref } from \"react\";\n\n/**\n * A small utility function that allows me to apply a passed in ref along with\n * my own custom ref logic.\n *\n * @example\n * Simple Example\n * ```tsx\n * import { HTMLAttributes, forwardRef } from \"react\";\n * import { applyRef } from \"@react-md/core\";\n *\n * export type ExampleProps = HTMLAttributes<HTMLDivElement>;\n *\n * const Example = forwardRef<HTMLDivElement, ExampleProps>(function Example(props, ref) {\n *   const refHandler = useCallback((instance: HTMLDivElement | null) => {\n *     applyRef(instance, ref);\n *     if (!instance) {\n *       return;\n *     }\n *\n *     // do something with instance\n *   });\n *\n *   return <div ref={refHandler} />;\n * });\n * ```\n *\n * @param instance - The DOM Node instance\n * @param ref - The prop ref\n * @internal\n */\nexport function applyRef<E>(instance: E | null, ref: Ref<E> | undefined): void {\n  if (!ref) {\n    return;\n  }\n\n  if (typeof ref === \"function\") {\n    ref(instance);\n  } else if (typeof ref === \"object\") {\n    (ref as MutableRefObject<E | null>).current = instance;\n  }\n}\n"],"names":["applyRef","instance","ref","current"],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6BC,GACD,OAAO,SAASA,SAAYC,QAAkB,EAAEC,GAAuB;IACrE,IAAI,CAACA,KAAK;QACR;IACF;IAEA,IAAI,OAAOA,QAAQ,YAAY;QAC7BA,IAAID;IACN,OAAO,IAAI,OAAOC,QAAQ,UAAU;QACjCA,IAAmCC,OAAO,GAAGF;IAChD;AACF"}
+{"version":3,"sources":["../../src/utils/applyRef.ts"],"sourcesContent":["import type { MutableRefObject, Ref } from \"react\";\n\n/**\n * A small utility function that allows me to apply a passed in ref along with\n * my own custom ref logic.\n *\n * @example Simple Example\n * ```tsx\n * import { HTMLAttributes, forwardRef } from \"react\";\n * import { applyRef } from \"@react-md/core\";\n *\n * export type ExampleProps = HTMLAttributes<HTMLDivElement>;\n *\n * const Example = forwardRef<HTMLDivElement, ExampleProps>(function Example(props, ref) {\n *   const refHandler = useCallback((instance: HTMLDivElement | null) => {\n *     applyRef(instance, ref);\n *     if (!instance) {\n *       return;\n *     }\n *\n *     // do something with instance\n *   });\n *\n *   return <div ref={refHandler} />;\n * });\n * ```\n *\n * @param instance - The DOM Node instance\n * @param ref - The prop ref\n * @internal\n */\nexport function applyRef<E>(instance: E | null, ref: Ref<E> | undefined): void {\n  if (!ref) {\n    return;\n  }\n\n  if (typeof ref === \"function\") {\n    ref(instance);\n  } else if (typeof ref === \"object\") {\n    (ref as MutableRefObject<E | null>).current = instance;\n  }\n}\n"],"names":["applyRef","instance","ref","current"],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4BC,GACD,OAAO,SAASA,SAAYC,QAAkB,EAAEC,GAAuB;IACrE,IAAI,CAACA,KAAK;QACR;IACF;IAEA,IAAI,OAAOA,QAAQ,YAAY;QAC7BA,IAAID;IACN,OAAO,IAAI,OAAOC,QAAQ,UAAU;QACjCA,IAAmCC,OAAO,GAAGF;IAChD;AACF"}

package/dist/utils/bem.d.ts

@@ -1,14 +1,56 @@
-export type Block = string;
-export type Element = string;
-export type Modifier = Record<string, unknown>;
-export type BEMResult = (elementOrModifier?: Element | Modifier, modifier?: Modifier) => string;
+export type BEMModifier = Record<string, unknown>;
+/**
+ * Creates the full class name from the base block name. This can be called
+ * without any arguments which will just return the base block name (kind of
+ * worthless), or you can provide a child element name and modifiers.
+ *
+ * @since 6.0.0 Converted to an interface that supports the `base` attribute.
+ */
+export interface BEMResult {
+    /**
+     * @example Simple Example
+     * ```ts
+     * const styles = bem("root");
+     *
+     * styles("child"); // "root__child"
+     * styles("child", {
+     *   modifier1: true,
+     *   modifier2: false,
+     * }); // "root__child root__child--modifier-1"
+     * ```
+     * @param element - The child element to be prefixed before any modifiers.
+     * @param modifier - Any optional modifiers to apply to the block and optional
+     * element.
+     * @returns the full class name
+     */
+    (element: string, modifier?: BEMModifier): string;
+    /**
+     * @example Simple Example
+     * ```ts
+     * const styles = bem("root");
+     *
+     * styles() // "root"
+     * styles({
+     *   modifier1: true,
+     *   modifier2: false,
+     * }); // "root--modifier-1"
+     * ```
+     * @param modifier - Any optional modifiers to apply to the block and optional
+     * element.
+     * @returns the full class name
+     */
+    (modifier?: BEMModifier): string;
+    /**
+     * The base class name
+     */
+    base: string;
+}
 /**
  * Applies the BEM styled class name to an element.
  *
- * @example
- * Simple Example
- * ```jsx
- * import { Bem } from "@react-md/core":
+ * @example Simple Example
+ * ```tsx
+ * import { bem } from "@react-md/core/utils/bem":
  *
  * const styles = bem("my-component"):
  *
@@ -43,4 +85,4 @@ export type BEMResult = (elementOrModifier?: Element | Modifier, modifier?: Modi
  * @param base - The base class to use
  * @returns a function to call that generates the full class name
  */
-export declare function bem(base: Block): BEMResult;
+export declare function bem(base: string): BEMResult;

package/dist/utils/bem.js

@@ -13,10 +13,9 @@ function modify(base, modifier) {
 /**
  * Applies the BEM styled class name to an element.
  *
- * @example
- * Simple Example
- * ```jsx
- * import { Bem } from "@react-md/core":
+ * @example Simple Example
+ * ```tsx
+ * import { bem } from "@react-md/core/utils/bem":
  *
  * const styles = bem("my-component"):
  *
@@ -56,18 +55,7 @@ function modify(base, modifier) {
             throw new Error("bem requires a base block class but none were provided.");
         }
     }
-    /**
-   * Creates the full class name from the base block name. This can be called
-   * without any arguments which will just return the base block name (kind of
-   * worthless), or you can provide a child element name and modifiers.
-   *
-   * @param elementOrModifier - This is either the child element name or an
-   * object of modifiers to apply. This **must** be a string if the second
-   * argument is provided.
-   * @param modifier - Any optional modifiers to apply to the block and optional
-   * element.
-   * @returns the full class name
-   */ return function block(elementOrModifier, modifier) {
+    function block(elementOrModifier, modifier) {
         if (process.env.NODE_ENV !== "production") {
             if (typeof elementOrModifier !== "string" && modifier) {
                 throw new TypeError("bem does not support having two modifier arguments.");
@@ -80,7 +68,9 @@ function modify(base, modifier) {
             return modify(base, elementOrModifier);
         }
         return modify(`${base}__${elementOrModifier}`, modifier);
-    };
+    }
+    block.base = base;
+    return block;
 }
 
 //# sourceMappingURL=bem.js.map

package/dist/utils/bem.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/bem.ts"],"sourcesContent":["export type Block = string;\nexport type Element = string;\nexport type Modifier = Record<string, unknown>;\n\nfunction modify(base: string, modifier?: Modifier): string {\n  if (!modifier) {\n    return base;\n  }\n\n  const hasOwn = Object.prototype.hasOwnProperty;\n  return Object.keys(modifier).reduce((s, mod) => {\n    if (hasOwn.call(modifier, mod) && modifier[mod]) {\n      s = `${s} ${base}--${mod}`;\n    }\n\n    return s;\n  }, base);\n}\n\nexport type BEMResult = (\n  elementOrModifier?: Element | Modifier,\n  modifier?: Modifier\n) => string;\n\n/**\n * Applies the BEM styled class name to an element.\n *\n * @example\n * Simple Example\n * ```jsx\n * import { Bem } from \"@react-md/core\":\n *\n * const styles = bem(\"my-component\"):\n *\n * export function MyComponent(props) {\n *   const className = styles({\n *     always: true,\n *     never: false,\n *     \"some-condition\": props.something,\n *   }):\n *   const childClassName = styles('child', {\n *     always: true,\n *     never: false,\n *     \"some-condition\": props.something,\n *   });\n *\n *   // With a false-like `props.something`\n *   // className === \"my-component__child my-component__child--always\"\n *   // childClassName === \"my-component my-component--always\"\n *   // With a truthy `props.something`\n *   // className === \"my-component my-component--always my-component--some-condition\"\n *   // childClassName === \"my-component__child my-component__child--always my-component__child--some-condition\"\n *\n *   return (\n *     <div className={className}>\n *       <div className={childClassName} />\n *     </div>\n *   ):\n * }\n * ```\n *\n * @see https://en.bem.info/methodology/css/\n * @param base - The base class to use\n * @returns a function to call that generates the full class name\n */\nexport function bem(base: Block): BEMResult {\n  if (process.env.NODE_ENV !== \"production\") {\n    if (!base) {\n      throw new Error(\n        \"bem requires a base block class but none were provided.\"\n      );\n    }\n  }\n\n  /**\n   * Creates the full class name from the base block name. This can be called\n   * without any arguments which will just return the base block name (kind of\n   * worthless), or you can provide a child element name and modifiers.\n   *\n   * @param elementOrModifier - This is either the child element name or an\n   * object of modifiers to apply. This **must** be a string if the second\n   * argument is provided.\n   * @param modifier - Any optional modifiers to apply to the block and optional\n   * element.\n   * @returns the full class name\n   */\n  return function block(\n    elementOrModifier?: Element | Modifier,\n    modifier?: Modifier\n  ): string {\n    if (process.env.NODE_ENV !== \"production\") {\n      if (typeof elementOrModifier !== \"string\" && modifier) {\n        throw new TypeError(\n          \"bem does not support having two modifier arguments.\"\n        );\n      }\n    }\n\n    if (!elementOrModifier) {\n      return base;\n    }\n\n    if (typeof elementOrModifier !== \"string\") {\n      return modify(base, elementOrModifier);\n    }\n\n    return modify(`${base}__${elementOrModifier}`, modifier);\n  };\n}\n"],"names":["modify","base","modifier","hasOwn","Object","prototype","hasOwnProperty","keys","reduce","s","mod","call","bem","process","env","NODE_ENV","Error","block","elementOrModifier","TypeError"],"mappings":"AAIA,SAASA,OAAOC,IAAY,EAAEC,QAAmB;IAC/C,IAAI,CAACA,UAAU;QACb,OAAOD;IACT;IAEA,MAAME,SAASC,OAAOC,SAAS,CAACC,cAAc;IAC9C,OAAOF,OAAOG,IAAI,CAACL,UAAUM,MAAM,CAAC,CAACC,GAAGC;QACtC,IAAIP,OAAOQ,IAAI,CAACT,UAAUQ,QAAQR,QAAQ,CAACQ,IAAI,EAAE;YAC/CD,IAAI,CAAC,EAAEA,EAAE,CAAC,EAAER,KAAK,EAAE,EAAES,IAAI,CAAC;QAC5B;QAEA,OAAOD;IACT,GAAGR;AACL;AAOA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwCC,GACD,OAAO,SAASW,IAAIX,IAAW;IAC7B,IAAIY,QAAQC,GAAG,CAACC,QAAQ,KAAK,cAAc;QACzC,IAAI,CAACd,MAAM;YACT,MAAM,IAAIe,MACR;QAEJ;IACF;IAEA;;;;;;;;;;;GAWC,GACD,OAAO,SAASC,MACdC,iBAAsC,EACtChB,QAAmB;QAEnB,IAAIW,QAAQC,GAAG,CAACC,QAAQ,KAAK,cAAc;YACzC,IAAI,OAAOG,sBAAsB,YAAYhB,UAAU;gBACrD,MAAM,IAAIiB,UACR;YAEJ;QACF;QAEA,IAAI,CAACD,mBAAmB;YACtB,OAAOjB;QACT;QAEA,IAAI,OAAOiB,sBAAsB,UAAU;YACzC,OAAOlB,OAAOC,MAAMiB;QACtB;QAEA,OAAOlB,OAAO,CAAC,EAAEC,KAAK,EAAE,EAAEiB,kBAAkB,CAAC,EAAEhB;IACjD;AACF"}
+{"version":3,"sources":["../../src/utils/bem.ts"],"sourcesContent":["export type BEMModifier = Record<string, unknown>;\n\nfunction modify(base: string, modifier?: BEMModifier): string {\n  if (!modifier) {\n    return base;\n  }\n\n  const hasOwn = Object.prototype.hasOwnProperty;\n  return Object.keys(modifier).reduce((s, mod) => {\n    if (hasOwn.call(modifier, mod) && modifier[mod]) {\n      s = `${s} ${base}--${mod}`;\n    }\n\n    return s;\n  }, base);\n}\n\n/**\n * Creates the full class name from the base block name. This can be called\n * without any arguments which will just return the base block name (kind of\n * worthless), or you can provide a child element name and modifiers.\n *\n * @since 6.0.0 Converted to an interface that supports the `base` attribute.\n */\nexport interface BEMResult {\n  /**\n   * @example Simple Example\n   * ```ts\n   * const styles = bem(\"root\");\n   *\n   * styles(\"child\"); // \"root__child\"\n   * styles(\"child\", {\n   *   modifier1: true,\n   *   modifier2: false,\n   * }); // \"root__child root__child--modifier-1\"\n   * ```\n   * @param element - The child element to be prefixed before any modifiers.\n   * @param modifier - Any optional modifiers to apply to the block and optional\n   * element.\n   * @returns the full class name\n   */\n  (element: string, modifier?: BEMModifier): string;\n\n  /**\n   * @example Simple Example\n   * ```ts\n   * const styles = bem(\"root\");\n   *\n   * styles() // \"root\"\n   * styles({\n   *   modifier1: true,\n   *   modifier2: false,\n   * }); // \"root--modifier-1\"\n   * ```\n   * @param modifier - Any optional modifiers to apply to the block and optional\n   * element.\n   * @returns the full class name\n   */\n  (modifier?: BEMModifier): string;\n\n  /**\n   * The base class name\n   */\n  base: string;\n}\n\n/**\n * Applies the BEM styled class name to an element.\n *\n * @example Simple Example\n * ```tsx\n * import { bem } from \"@react-md/core/utils/bem\":\n *\n * const styles = bem(\"my-component\"):\n *\n * export function MyComponent(props) {\n *   const className = styles({\n *     always: true,\n *     never: false,\n *     \"some-condition\": props.something,\n *   }):\n *   const childClassName = styles('child', {\n *     always: true,\n *     never: false,\n *     \"some-condition\": props.something,\n *   });\n *\n *   // With a false-like `props.something`\n *   // className === \"my-component__child my-component__child--always\"\n *   // childClassName === \"my-component my-component--always\"\n *   // With a truthy `props.something`\n *   // className === \"my-component my-component--always my-component--some-condition\"\n *   // childClassName === \"my-component__child my-component__child--always my-component__child--some-condition\"\n *\n *   return (\n *     <div className={className}>\n *       <div className={childClassName} />\n *     </div>\n *   ):\n * }\n * ```\n *\n * @see https://en.bem.info/methodology/css/\n * @param base - The base class to use\n * @returns a function to call that generates the full class name\n */\nexport function bem(base: string): BEMResult {\n  if (process.env.NODE_ENV !== \"production\") {\n    if (!base) {\n      throw new Error(\n        \"bem requires a base block class but none were provided.\"\n      );\n    }\n  }\n\n  function block(\n    elementOrModifier?: BEMModifier | string,\n    modifier?: BEMModifier\n  ): string {\n    if (process.env.NODE_ENV !== \"production\") {\n      if (typeof elementOrModifier !== \"string\" && modifier) {\n        throw new TypeError(\n          \"bem does not support having two modifier arguments.\"\n        );\n      }\n    }\n\n    if (!elementOrModifier) {\n      return base;\n    }\n\n    if (typeof elementOrModifier !== \"string\") {\n      return modify(base, elementOrModifier);\n    }\n\n    return modify(`${base}__${elementOrModifier}`, modifier);\n  }\n  block.base = base;\n  return block;\n}\n"],"names":["modify","base","modifier","hasOwn","Object","prototype","hasOwnProperty","keys","reduce","s","mod","call","bem","process","env","NODE_ENV","Error","block","elementOrModifier","TypeError"],"mappings":"AAEA,SAASA,OAAOC,IAAY,EAAEC,QAAsB;IAClD,IAAI,CAACA,UAAU;QACb,OAAOD;IACT;IAEA,MAAME,SAASC,OAAOC,SAAS,CAACC,cAAc;IAC9C,OAAOF,OAAOG,IAAI,CAACL,UAAUM,MAAM,CAAC,CAACC,GAAGC;QACtC,IAAIP,OAAOQ,IAAI,CAACT,UAAUQ,QAAQR,QAAQ,CAACQ,IAAI,EAAE;YAC/CD,IAAI,GAAGA,EAAE,CAAC,EAAER,KAAK,EAAE,EAAES,KAAK;QAC5B;QAEA,OAAOD;IACT,GAAGR;AACL;AAmDA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAuCC,GACD,OAAO,SAASW,IAAIX,IAAY;IAC9B,IAAIY,QAAQC,GAAG,CAACC,QAAQ,KAAK,cAAc;QACzC,IAAI,CAACd,MAAM;YACT,MAAM,IAAIe,MACR;QAEJ;IACF;IAEA,SAASC,MACPC,iBAAwC,EACxChB,QAAsB;QAEtB,IAAIW,QAAQC,GAAG,CAACC,QAAQ,KAAK,cAAc;YACzC,IAAI,OAAOG,sBAAsB,YAAYhB,UAAU;gBACrD,MAAM,IAAIiB,UACR;YAEJ;QACF;QAEA,IAAI,CAACD,mBAAmB;YACtB,OAAOjB;QACT;QAEA,IAAI,OAAOiB,sBAAsB,UAAU;YACzC,OAAOlB,OAAOC,MAAMiB;QACtB;QAEA,OAAOlB,OAAO,GAAGC,KAAK,EAAE,EAAEiB,mBAAmB,EAAEhB;IACjD;IACAe,MAAMhB,IAAI,GAAGA;IACb,OAAOgB;AACT"}

package/dist/utils/debounce.d.ts

@@ -0,0 +1,5 @@
+import { type AnyFunction, type DebouncedFunction } from "../types.js";
+/**
+ * @since 6.0.0
+ */
+export declare function debounce<F extends AnyFunction>(fn: F, duration: number): DebouncedFunction<F>;

package/dist/utils/debounce.js

@@ -0,0 +1,17 @@
+/**
+ * @since 6.0.0
+ */ export function debounce(fn, duration) {
+    let timeout;
+    const debounced = (...args)=>{
+        clearTimeout(timeout);
+        timeout = setTimeout(()=>{
+            fn(...args);
+        }, duration);
+    };
+    debounced.cancel = ()=>{
+        clearTimeout(timeout);
+    };
+    return debounced;
+}
+
+//# sourceMappingURL=debounce.js.map

package/dist/utils/debounce.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/debounce.ts"],"sourcesContent":["import { type AnyFunction, type DebouncedFunction } from \"../types.js\";\n\n/**\n * @since 6.0.0\n */\nexport function debounce<F extends AnyFunction>(\n  fn: F,\n  duration: number\n): DebouncedFunction<F> {\n  let timeout: NodeJS.Timeout | undefined;\n  const debounced: DebouncedFunction<F> = (...args) => {\n    clearTimeout(timeout);\n    timeout = setTimeout(() => {\n      fn(...args);\n    }, duration);\n  };\n  debounced.cancel = () => {\n    clearTimeout(timeout);\n  };\n\n  return debounced;\n}\n"],"names":["debounce","fn","duration","timeout","debounced","args","clearTimeout","setTimeout","cancel"],"mappings":"AAEA;;CAEC,GACD,OAAO,SAASA,SACdC,EAAK,EACLC,QAAgB;IAEhB,IAAIC;IACJ,MAAMC,YAAkC,CAAC,GAAGC;QAC1CC,aAAaH;QACbA,UAAUI,WAAW;YACnBN,MAAMI;QACR,GAAGH;IACL;IACAE,UAAUI,MAAM,GAAG;QACjBF,aAAaH;IACf;IAEA,OAAOC;AACT"}

package/dist/utils/getClientPosition.d.ts

@@ -1,6 +1,6 @@
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface ClientPositionMouseEvent {
     clientX: number;
@@ -8,7 +8,7 @@ export interface ClientPositionMouseEvent {
 }
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface ClientPositionTouchEvent {
     changedTouches: {
@@ -18,7 +18,7 @@ export interface ClientPositionTouchEvent {
 export type ClientPositionEvent = ClientPositionMouseEvent | ClientPositionTouchEvent;
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface ClientPositionOptions {
     event: ClientPositionEvent;
@@ -26,6 +26,6 @@ export interface ClientPositionOptions {
 }
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare const getClientPosition: (options: ClientPositionOptions) => number;

package/dist/utils/getClientPosition.js

@@ -1,9 +1,9 @@
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export const getClientPosition = (options)=>{
     const { event, vertical } = options;
     const key = vertical ? "clientY" : "clientX";

package/dist/utils/getClientPosition.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/getClientPosition.ts"],"sourcesContent":["/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nexport interface ClientPositionMouseEvent {\n  clientX: number;\n  clientY: number;\n}\n\n/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nexport interface ClientPositionTouchEvent {\n  changedTouches: {\n    [index: number]: ClientPositionMouseEvent;\n  };\n}\n\nexport type ClientPositionEvent =\n  | ClientPositionMouseEvent\n  | ClientPositionTouchEvent;\n\n/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nexport interface ClientPositionOptions {\n  event: ClientPositionEvent;\n  vertical: boolean;\n}\n\n/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nexport const getClientPosition = (options: ClientPositionOptions): number => {\n  const { event, vertical } = options;\n\n  const key = vertical ? \"clientY\" : \"clientX\";\n  if (\"clientX\" in event) {\n    return event[key];\n  }\n\n  // this should pretty much always be defined\n  return event.changedTouches[0]?.[key] || 0;\n};\n"],"names":["getClientPosition","options","event","vertical","key","changedTouches"],"mappings":"AAAA;;;CAGC,GA6BD;;;CAGC,GACD,OAAO,MAAMA,oBAAoB,CAACC;IAChC,MAAM,EAAEC,KAAK,EAAEC,QAAQ,EAAE,GAAGF;IAE5B,MAAMG,MAAMD,WAAW,YAAY;IACnC,IAAI,aAAaD,OAAO;QACtB,OAAOA,KAAK,CAACE,IAAI;IACnB;IAEA,4CAA4C;IAC5C,OAAOF,MAAMG,cAAc,CAAC,EAAE,EAAE,CAACD,IAAI,IAAI;AAC3C,EAAE"}
+{"version":3,"sources":["../../src/utils/getClientPosition.ts"],"sourcesContent":["/**\n * @internal\n * @since 6.0.0\n */\nexport interface ClientPositionMouseEvent {\n  clientX: number;\n  clientY: number;\n}\n\n/**\n * @internal\n * @since 6.0.0\n */\nexport interface ClientPositionTouchEvent {\n  changedTouches: {\n    [index: number]: ClientPositionMouseEvent;\n  };\n}\n\nexport type ClientPositionEvent =\n  | ClientPositionMouseEvent\n  | ClientPositionTouchEvent;\n\n/**\n * @internal\n * @since 6.0.0\n */\nexport interface ClientPositionOptions {\n  event: ClientPositionEvent;\n  vertical: boolean;\n}\n\n/**\n * @internal\n * @since 6.0.0\n */\nexport const getClientPosition = (options: ClientPositionOptions): number => {\n  const { event, vertical } = options;\n\n  const key = vertical ? \"clientY\" : \"clientX\";\n  if (\"clientX\" in event) {\n    return event[key];\n  }\n\n  // this should pretty much always be defined\n  return event.changedTouches[0]?.[key] || 0;\n};\n"],"names":["getClientPosition","options","event","vertical","key","changedTouches"],"mappings":"AAAA;;;CAGC,GA6BD;;;CAGC,GACD,OAAO,MAAMA,oBAAoB,CAACC;IAChC,MAAM,EAAEC,KAAK,EAAEC,QAAQ,EAAE,GAAGF;IAE5B,MAAMG,MAAMD,WAAW,YAAY;IACnC,IAAI,aAAaD,OAAO;QACtB,OAAOA,KAAK,CAACE,IAAI;IACnB;IAEA,4CAA4C;IAC5C,OAAOF,MAAMG,cAAc,CAAC,EAAE,EAAE,CAACD,IAAI,IAAI;AAC3C,EAAE"}

package/dist/utils/getMiddleOfRange.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @since 6.0.0
+ */
+export interface GetMiddleOfRangeOptions {
+    min: number;
+    max: number;
+    step: number;
+}
+/**
+ * @internal
+ * @since 6.0.0
+ */
+export declare function getMiddleOfRange(options: GetMiddleOfRangeOptions): number;

package/dist/utils/getMiddleOfRange.js

@@ -0,0 +1,20 @@
+import { getRangeSteps } from "./getRangeSteps.js";
+import { nearest } from "./nearest.js";
+/**
+ * @internal
+ * @since 6.0.0
+ */ export function getMiddleOfRange(options) {
+    const { min, max, step } = options;
+    return nearest({
+        min,
+        max,
+        steps: getRangeSteps({
+            min,
+            max,
+            step
+        }),
+        value: (max - min) / 2 + min
+    });
+}
+
+//# sourceMappingURL=getMiddleOfRange.js.map

package/dist/utils/getMiddleOfRange.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/getMiddleOfRange.ts"],"sourcesContent":["import { getRangeSteps } from \"./getRangeSteps.js\";\nimport { nearest } from \"./nearest.js\";\n\n/**\n * @since 6.0.0\n */\nexport interface GetMiddleOfRangeOptions {\n  min: number;\n  max: number;\n  step: number;\n}\n\n/**\n * @internal\n * @since 6.0.0\n */\nexport function getMiddleOfRange(options: GetMiddleOfRangeOptions): number {\n  const { min, max, step } = options;\n\n  return nearest({\n    min,\n    max,\n    steps: getRangeSteps({ min, max, step }),\n    value: (max - min) / 2 + min,\n  });\n}\n"],"names":["getRangeSteps","nearest","getMiddleOfRange","options","min","max","step","steps","value"],"mappings":"AAAA,SAASA,aAAa,QAAQ,qBAAqB;AACnD,SAASC,OAAO,QAAQ,eAAe;AAWvC;;;CAGC,GACD,OAAO,SAASC,iBAAiBC,OAAgC;IAC/D,MAAM,EAAEC,GAAG,EAAEC,GAAG,EAAEC,IAAI,EAAE,GAAGH;IAE3B,OAAOF,QAAQ;QACbG;QACAC;QACAE,OAAOP,cAAc;YAAEI;YAAKC;YAAKC;QAAK;QACtCE,OAAO,AAACH,CAAAA,MAAMD,GAAE,IAAK,IAAIA;IAC3B;AACF"}

package/dist/utils/getPercentage.d.ts

@@ -1,4 +1,4 @@
-/** @remarks \@since 4.0.1 */
+/** @since 4.0.1 */
 export interface GetPercentageOptions {
     /**
      * The min value allowed.
@@ -26,9 +26,8 @@ export interface GetPercentageOptions {
  * @returns the percentage that the `value` is between the `min` and `max`
  * values.
  *
- * @remarks
- * \@since 4.0.1 uses an object for options instead of multiple arguments.
- * \@since 6.0.0 Updated to be included in the public API and `validate`
+ * @since 4.0.1 uses an object for options instead of multiple arguments.
+ * @since 6.0.0 Updated to be included in the public API and `validate`
  * defaults to `false` instead of `true`.
  */
 export declare function getPercentage(options: GetPercentageOptions): number;

package/dist/utils/getPercentage.js

@@ -1,12 +1,11 @@
-/** @remarks \@since 4.0.1 */ /**
+/** @since 4.0.1 */ /**
  * Gets the current percentage based on the min, max, and current value.
  *
  * @returns the percentage that the `value` is between the `min` and `max`
  * values.
  *
- * @remarks
- * \@since 4.0.1 uses an object for options instead of multiple arguments.
- * \@since 6.0.0 Updated to be included in the public API and `validate`
+ * @since 4.0.1 uses an object for options instead of multiple arguments.
+ * @since 6.0.0 Updated to be included in the public API and `validate`
  * defaults to `false` instead of `true`.
  */ export function getPercentage(options) {
     const { min, max, value, validate = false } = options;

package/dist/utils/getPercentage.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/getPercentage.ts"],"sourcesContent":["/** @remarks \\@since 4.0.1 */\nexport interface GetPercentageOptions {\n  /**\n   * The min value allowed.\n   */\n  min: number;\n\n  /**\n   * The max value allowed.\n   */\n  max: number;\n\n  /**\n   * The current value\n   */\n  value: number;\n\n  /**\n   * Boolean if the min, max, and value options should be validated to make sure\n   * they are within the correct range relative to each other.\n   *\n   * @defaultValue `false`\n   */\n  validate?: boolean;\n}\n\n/**\n * Gets the current percentage based on the min, max, and current value.\n *\n * @returns the percentage that the `value` is between the `min` and `max`\n * values.\n *\n * @remarks\n * \\@since 4.0.1 uses an object for options instead of multiple arguments.\n * \\@since 6.0.0 Updated to be included in the public API and `validate`\n * defaults to `false` instead of `true`.\n */\nexport function getPercentage(options: GetPercentageOptions): number {\n  const { min, max, value, validate = false } = options;\n  if (validate) {\n    if (min >= max) {\n      throw new RangeError(\n        \"A range must have the min value less than the max value\"\n      );\n    }\n\n    if (value > max || value < min) {\n      throw new RangeError(\"A value must be between the min and max values\");\n    }\n  }\n\n  const range = max - min;\n  const start = value - min;\n  const percentage = start / range;\n  return Math.max(0, Math.min(Math.abs(percentage), 1));\n}\n"],"names":["getPercentage","options","min","max","value","validate","RangeError","range","start","percentage","Math","abs"],"mappings":"AAAA,2BAA2B,GA0B3B;;;;;;;;;;CAUC,GACD,OAAO,SAASA,cAAcC,OAA6B;IACzD,MAAM,EAAEC,GAAG,EAAEC,GAAG,EAAEC,KAAK,EAAEC,WAAW,KAAK,EAAE,GAAGJ;IAC9C,IAAII,UAAU;QACZ,IAAIH,OAAOC,KAAK;YACd,MAAM,IAAIG,WACR;QAEJ;QAEA,IAAIF,QAAQD,OAAOC,QAAQF,KAAK;YAC9B,MAAM,IAAII,WAAW;QACvB;IACF;IAEA,MAAMC,QAAQJ,MAAMD;IACpB,MAAMM,QAAQJ,QAAQF;IACtB,MAAMO,aAAaD,QAAQD;IAC3B,OAAOG,KAAKP,GAAG,CAAC,GAAGO,KAAKR,GAAG,CAACQ,KAAKC,GAAG,CAACF,aAAa;AACpD"}
+{"version":3,"sources":["../../src/utils/getPercentage.ts"],"sourcesContent":["/** @since 4.0.1 */\nexport interface GetPercentageOptions {\n  /**\n   * The min value allowed.\n   */\n  min: number;\n\n  /**\n   * The max value allowed.\n   */\n  max: number;\n\n  /**\n   * The current value\n   */\n  value: number;\n\n  /**\n   * Boolean if the min, max, and value options should be validated to make sure\n   * they are within the correct range relative to each other.\n   *\n   * @defaultValue `false`\n   */\n  validate?: boolean;\n}\n\n/**\n * Gets the current percentage based on the min, max, and current value.\n *\n * @returns the percentage that the `value` is between the `min` and `max`\n * values.\n *\n * @since 4.0.1 uses an object for options instead of multiple arguments.\n * @since 6.0.0 Updated to be included in the public API and `validate`\n * defaults to `false` instead of `true`.\n */\nexport function getPercentage(options: GetPercentageOptions): number {\n  const { min, max, value, validate = false } = options;\n  if (validate) {\n    if (min >= max) {\n      throw new RangeError(\n        \"A range must have the min value less than the max value\"\n      );\n    }\n\n    if (value > max || value < min) {\n      throw new RangeError(\"A value must be between the min and max values\");\n    }\n  }\n\n  const range = max - min;\n  const start = value - min;\n  const percentage = start / range;\n  return Math.max(0, Math.min(Math.abs(percentage), 1));\n}\n"],"names":["getPercentage","options","min","max","value","validate","RangeError","range","start","percentage","Math","abs"],"mappings":"AAAA,iBAAiB,GA0BjB;;;;;;;;;CASC,GACD,OAAO,SAASA,cAAcC,OAA6B;IACzD,MAAM,EAAEC,GAAG,EAAEC,GAAG,EAAEC,KAAK,EAAEC,WAAW,KAAK,EAAE,GAAGJ;IAC9C,IAAII,UAAU;QACZ,IAAIH,OAAOC,KAAK;YACd,MAAM,IAAIG,WACR;QAEJ;QAEA,IAAIF,QAAQD,OAAOC,QAAQF,KAAK;YAC9B,MAAM,IAAII,WAAW;QACvB;IACF;IAEA,MAAMC,QAAQJ,MAAMD;IACpB,MAAMM,QAAQJ,QAAQF;IACtB,MAAMO,aAAaD,QAAQD;IAC3B,OAAOG,KAAKP,GAAG,CAAC,GAAGO,KAAKR,GAAG,CAACQ,KAAKC,GAAG,CAACF,aAAa;AACpD"}

package/dist/utils/getRangeDefaultValue.d.ts

@@ -1,16 +1,14 @@
-import type { UseStateInitializer } from "../types.js";
+import { type UseStateInitializer } from "../types.js";
+import { type GetMiddleOfRangeOptions } from "./getMiddleOfRange.js";
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
-export interface RangeDefaultValueOptions {
-    min: number;
-    max: number;
-    step: number;
+export interface RangeDefaultValueOptions extends GetMiddleOfRangeOptions {
     defaultValue?: UseStateInitializer<number>;
 }
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare function getRangeDefaultValue(options: RangeDefaultValueOptions): UseStateInitializer<number>;

package/dist/utils/getRangeDefaultValue.js

@@ -1,23 +1,13 @@
-import { getRangeSteps } from "./getRangeSteps.js";
-import { nearest } from "./nearest.js";
+import { getMiddleOfRange } from "./getMiddleOfRange.js";
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export function getRangeDefaultValue(options) {
-    const { min, max, step, defaultValue } = options;
+    const { defaultValue } = options;
     if (typeof defaultValue !== "undefined") {
         return defaultValue;
     }
-    return ()=>nearest({
-            min,
-            max,
-            steps: getRangeSteps({
-                min,
-                max,
-                step
-            }),
-            value: (max - min) / 2
-        });
+    return ()=>getMiddleOfRange(options);
 }
 
 //# sourceMappingURL=getRangeDefaultValue.js.map

package/dist/utils/getRangeDefaultValue.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/getRangeDefaultValue.ts"],"sourcesContent":["import type { UseStateInitializer } from \"../types.js\";\nimport { getRangeSteps } from \"./getRangeSteps.js\";\nimport { nearest } from \"./nearest.js\";\n\n/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nexport interface RangeDefaultValueOptions {\n  min: number;\n  max: number;\n  step: number;\n  defaultValue?: UseStateInitializer<number>;\n}\n\n/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nexport function getRangeDefaultValue(\n  options: RangeDefaultValueOptions\n): UseStateInitializer<number> {\n  const { min, max, step, defaultValue } = options;\n  if (typeof defaultValue !== \"undefined\") {\n    return defaultValue;\n  }\n\n  return () =>\n    nearest({\n      min,\n      max,\n      steps: getRangeSteps({ min, max, step }),\n      value: (max - min) / 2,\n    });\n}\n"],"names":["getRangeSteps","nearest","getRangeDefaultValue","options","min","max","step","defaultValue","steps","value"],"mappings":"AACA,SAASA,aAAa,QAAQ,qBAAqB;AACnD,SAASC,OAAO,QAAQ,eAAe;AAavC;;;CAGC,GACD,OAAO,SAASC,qBACdC,OAAiC;IAEjC,MAAM,EAAEC,GAAG,EAAEC,GAAG,EAAEC,IAAI,EAAEC,YAAY,EAAE,GAAGJ;IACzC,IAAI,OAAOI,iBAAiB,aAAa;QACvC,OAAOA;IACT;IAEA,OAAO,IACLN,QAAQ;YACNG;YACAC;YACAG,OAAOR,cAAc;gBAAEI;gBAAKC;gBAAKC;YAAK;YACtCG,OAAO,AAACJ,CAAAA,MAAMD,GAAE,IAAK;QACvB;AACJ"}
+{"version":3,"sources":["../../src/utils/getRangeDefaultValue.ts"],"sourcesContent":["import { type UseStateInitializer } from \"../types.js\";\nimport {\n  type GetMiddleOfRangeOptions,\n  getMiddleOfRange,\n} from \"./getMiddleOfRange.js\";\n\n/**\n * @internal\n * @since 6.0.0\n */\nexport interface RangeDefaultValueOptions extends GetMiddleOfRangeOptions {\n  defaultValue?: UseStateInitializer<number>;\n}\n\n/**\n * @internal\n * @since 6.0.0\n */\nexport function getRangeDefaultValue(\n  options: RangeDefaultValueOptions\n): UseStateInitializer<number> {\n  const { defaultValue } = options;\n  if (typeof defaultValue !== \"undefined\") {\n    return defaultValue;\n  }\n\n  return () => getMiddleOfRange(options);\n}\n"],"names":["getMiddleOfRange","getRangeDefaultValue","options","defaultValue"],"mappings":"AACA,SAEEA,gBAAgB,QACX,wBAAwB;AAU/B;;;CAGC,GACD,OAAO,SAASC,qBACdC,OAAiC;IAEjC,MAAM,EAAEC,YAAY,EAAE,GAAGD;IACzB,IAAI,OAAOC,iBAAiB,aAAa;QACvC,OAAOA;IACT;IAEA,OAAO,IAAMH,iBAAiBE;AAChC"}

package/dist/utils/getRangeSteps.d.ts

@@ -1,6 +1,6 @@
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface RangeStepsOptions {
     min: number;
@@ -11,9 +11,8 @@ export interface RangeStepsOptions {
  * Gets the number of steps in the allowed range of values.
  *
  * @internal
- * @remarks
- * \@since 2.5.0
- * \@since 6.0.0 Converted to using an object instead of multiple arguments and
+ * @since 2.5.0
+ * @since 6.0.0 Converted to using an object instead of multiple arguments and
  * renamed from `getSteps` to `getRangeSteps`.
  */
-export declare const getRangeSteps: (options: RangeStepsOptions) => number;
+export declare function getRangeSteps(options: RangeStepsOptions): number;

package/dist/utils/getRangeSteps.js

@@ -1,17 +1,16 @@
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ /**
  * Gets the number of steps in the allowed range of values.
  *
  * @internal
- * @remarks
- * \@since 2.5.0
- * \@since 6.0.0 Converted to using an object instead of multiple arguments and
+ * @since 2.5.0
+ * @since 6.0.0 Converted to using an object instead of multiple arguments and
  * renamed from `getSteps` to `getRangeSteps`.
- */ export const getRangeSteps = (options)=>{
+ */ export function getRangeSteps(options) {
     const { min, max, step } = options;
     return Math.abs(max - min) / step;
-};
+}
 
 //# sourceMappingURL=getRangeSteps.js.map

package/dist/utils/getRangeSteps.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/getRangeSteps.ts"],"sourcesContent":["/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nexport interface RangeStepsOptions {\n  min: number;\n  max: number;\n  step: number;\n}\n\n/**\n * Gets the number of steps in the allowed range of values.\n *\n * @internal\n * @remarks\n * \\@since 2.5.0\n * \\@since 6.0.0 Converted to using an object instead of multiple arguments and\n * renamed from `getSteps` to `getRangeSteps`.\n */\nexport const getRangeSteps = (options: RangeStepsOptions): number => {\n  const { min, max, step } = options;\n\n  return Math.abs(max - min) / step;\n};\n"],"names":["getRangeSteps","options","min","max","step","Math","abs"],"mappings":"AAAA;;;CAGC,GAOD;;;;;;;;CAQC,GACD,OAAO,MAAMA,gBAAgB,CAACC;IAC5B,MAAM,EAAEC,GAAG,EAAEC,GAAG,EAAEC,IAAI,EAAE,GAAGH;IAE3B,OAAOI,KAAKC,GAAG,CAACH,MAAMD,OAAOE;AAC/B,EAAE"}
+{"version":3,"sources":["../../src/utils/getRangeSteps.ts"],"sourcesContent":["/**\n * @internal\n * @since 6.0.0\n */\nexport interface RangeStepsOptions {\n  min: number;\n  max: number;\n  step: number;\n}\n\n/**\n * Gets the number of steps in the allowed range of values.\n *\n * @internal\n * @since 2.5.0\n * @since 6.0.0 Converted to using an object instead of multiple arguments and\n * renamed from `getSteps` to `getRangeSteps`.\n */\nexport function getRangeSteps(options: RangeStepsOptions): number {\n  const { min, max, step } = options;\n\n  return Math.abs(max - min) / step;\n}\n"],"names":["getRangeSteps","options","min","max","step","Math","abs"],"mappings":"AAAA;;;CAGC,GAOD;;;;;;;CAOC,GACD,OAAO,SAASA,cAAcC,OAA0B;IACtD,MAAM,EAAEC,GAAG,EAAEC,GAAG,EAAEC,IAAI,EAAE,GAAGH;IAE3B,OAAOI,KAAKC,GAAG,CAACH,MAAMD,OAAOE;AAC/B"}

package/dist/utils/identity.d.ts

@@ -1,5 +1,5 @@
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare const identity: <T>(thing: T) => T;

package/dist/utils/identity.js

@@ -1,6 +1,6 @@
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export const identity = (thing)=>thing;
 
 //# sourceMappingURL=identity.js.map

package/dist/utils/identity.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/identity.ts"],"sourcesContent":["/**\n * @internal\n * @remarks \\@since 6.0.0\n */\nexport const identity = <T>(thing: T): T => thing;\n"],"names":["identity","thing"],"mappings":"AAAA;;;CAGC,GACD,OAAO,MAAMA,WAAW,CAAIC,QAAgBA,MAAM"}
+{"version":3,"sources":["../../src/utils/identity.ts"],"sourcesContent":["/**\n * @internal\n * @since 6.0.0\n */\nexport const identity = <T>(thing: T): T => thing;\n"],"names":["identity","thing"],"mappings":"AAAA;;;CAGC,GACD,OAAO,MAAMA,WAAW,CAAIC,QAAgBA,MAAM"}

package/dist/utils/isElementVisible.d.ts

@@ -1,7 +1,7 @@
 /**
  * Note: requires the `$disable-display-none-class` variable to remain `false`.
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare const DISPLAY_NONE_CLASS = "rmd-display-none";
 /**
@@ -9,19 +9,18 @@ export declare const DISPLAY_NONE_CLASS = "rmd-display-none";
  * checking the element and all parents to see if they contain the
  * {@link DISPLAY_NONE_CLASS}.
  *
- * @example
- * Simple Example
+ * @example Simple Example
  * ```tsx
  * const treeItem = screen.getByRole("treeitem", { name: "Tree Item" });
  * const subTreeItem = screen.getByRole("treeitem", { Name: "Sub Tree Item" });
  *
  * expect(isElementVisible(treeItem)).toBe(true);
- * expect(isElementVisible(subTreeItem)).toBe(false):
+ * expect(isElementVisible(subTreeItem)).toBe(false);
  *
  * await user.click(treeItem);
  * expect(isElementVisible(treeItem)).toBe(true);
  * expect(isElementVisible(subTreeItem)).toBe(true);
  * ```
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export declare function isElementVisible(element: HTMLElement | null): boolean;

package/dist/utils/isElementVisible.js

@@ -1,27 +1,26 @@
 /**
  * Note: requires the `$disable-display-none-class` variable to remain `false`.
  *
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export const DISPLAY_NONE_CLASS = "rmd-display-none";
 /**
  * This is a small util to check if an element within react-md is visible by
  * checking the element and all parents to see if they contain the
  * {@link DISPLAY_NONE_CLASS}.
  *
- * @example
- * Simple Example
+ * @example Simple Example
  * ```tsx
  * const treeItem = screen.getByRole("treeitem", { name: "Tree Item" });
  * const subTreeItem = screen.getByRole("treeitem", { Name: "Sub Tree Item" });
  *
  * expect(isElementVisible(treeItem)).toBe(true);
- * expect(isElementVisible(subTreeItem)).toBe(false):
+ * expect(isElementVisible(subTreeItem)).toBe(false);
  *
  * await user.click(treeItem);
  * expect(isElementVisible(treeItem)).toBe(true);
  * expect(isElementVisible(subTreeItem)).toBe(true);
  * ```
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */ export function isElementVisible(element) {
     if (!element) {
         return false;

package/dist/utils/isElementVisible.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/isElementVisible.ts"],"sourcesContent":["/**\n * Note: requires the `$disable-display-none-class` variable to remain `false`.\n *\n * @remarks \\@since 6.0.0\n */\nexport const DISPLAY_NONE_CLASS = \"rmd-display-none\";\n\n/**\n * This is a small util to check if an element within react-md is visible by\n * checking the element and all parents to see if they contain the\n * {@link DISPLAY_NONE_CLASS}.\n *\n * @example\n * Simple Example\n * ```tsx\n * const treeItem = screen.getByRole(\"treeitem\", { name: \"Tree Item\" });\n * const subTreeItem = screen.getByRole(\"treeitem\", { Name: \"Sub Tree Item\" });\n *\n * expect(isElementVisible(treeItem)).toBe(true);\n * expect(isElementVisible(subTreeItem)).toBe(false):\n *\n * await user.click(treeItem);\n * expect(isElementVisible(treeItem)).toBe(true);\n * expect(isElementVisible(subTreeItem)).toBe(true);\n * ```\n * @remarks \\@since 6.0.0\n */\nexport function isElementVisible(element: HTMLElement | null): boolean {\n  if (!element) {\n    return false;\n  }\n\n  let currentElement: HTMLElement | null = element;\n  while (currentElement) {\n    if (currentElement.classList.contains(DISPLAY_NONE_CLASS)) {\n      return false;\n    }\n\n    currentElement = currentElement.parentElement;\n  }\n\n  return true;\n}\n"],"names":["DISPLAY_NONE_CLASS","isElementVisible","element","currentElement","classList","contains","parentElement"],"mappings":"AAAA;;;;CAIC,GACD,OAAO,MAAMA,qBAAqB,mBAAmB;AAErD;;;;;;;;;;;;;;;;;;;CAmBC,GACD,OAAO,SAASC,iBAAiBC,OAA2B;IAC1D,IAAI,CAACA,SAAS;QACZ,OAAO;IACT;IAEA,IAAIC,iBAAqCD;IACzC,MAAOC,eAAgB;QACrB,IAAIA,eAAeC,SAAS,CAACC,QAAQ,CAACL,qBAAqB;YACzD,OAAO;QACT;QAEAG,iBAAiBA,eAAeG,aAAa;IAC/C;IAEA,OAAO;AACT"}
+{"version":3,"sources":["../../src/utils/isElementVisible.ts"],"sourcesContent":["/**\n * Note: requires the `$disable-display-none-class` variable to remain `false`.\n *\n * @since 6.0.0\n */\nexport const DISPLAY_NONE_CLASS = \"rmd-display-none\";\n\n/**\n * This is a small util to check if an element within react-md is visible by\n * checking the element and all parents to see if they contain the\n * {@link DISPLAY_NONE_CLASS}.\n *\n * @example Simple Example\n * ```tsx\n * const treeItem = screen.getByRole(\"treeitem\", { name: \"Tree Item\" });\n * const subTreeItem = screen.getByRole(\"treeitem\", { Name: \"Sub Tree Item\" });\n *\n * expect(isElementVisible(treeItem)).toBe(true);\n * expect(isElementVisible(subTreeItem)).toBe(false);\n *\n * await user.click(treeItem);\n * expect(isElementVisible(treeItem)).toBe(true);\n * expect(isElementVisible(subTreeItem)).toBe(true);\n * ```\n * @since 6.0.0\n */\nexport function isElementVisible(element: HTMLElement | null): boolean {\n  if (!element) {\n    return false;\n  }\n\n  let currentElement: HTMLElement | null = element;\n  while (currentElement) {\n    if (currentElement.classList.contains(DISPLAY_NONE_CLASS)) {\n      return false;\n    }\n\n    currentElement = currentElement.parentElement;\n  }\n\n  return true;\n}\n"],"names":["DISPLAY_NONE_CLASS","isElementVisible","element","currentElement","classList","contains","parentElement"],"mappings":"AAAA;;;;CAIC,GACD,OAAO,MAAMA,qBAAqB,mBAAmB;AAErD;;;;;;;;;;;;;;;;;;CAkBC,GACD,OAAO,SAASC,iBAAiBC,OAA2B;IAC1D,IAAI,CAACA,SAAS;QACZ,OAAO;IACT;IAEA,IAAIC,iBAAqCD;IACzC,MAAOC,eAAgB;QACrB,IAAIA,eAAeC,SAAS,CAACC,QAAQ,CAACL,qBAAqB;YACzD,OAAO;QACT;QAEAG,iBAAiBA,eAAeG,aAAa;IAC/C;IAEA,OAAO;AACT"}

package/dist/utils/loop.d.ts

@@ -1,5 +1,5 @@
 /**
- * @remarks \@since 2.7.0
+ * @since 2.7.0
  * @internal
  */
 export interface LoopOptions {
@@ -25,6 +25,8 @@ export interface LoopOptions {
      * Boolean if the looping should be ignored and only the `min`/`max` options
      * should be respected. In other words, the looping  behavior will be disabled
      * and the `value` must be: `min >= value <= max`
+     *
+     * @defaultValue `false`
      */
     minmax?: boolean;
 }
@@ -36,7 +38,7 @@ export interface LoopOptions {
  *
  * @internal
  * @param options - {@link LoopOptions}
- * @remarks \@since 2.7.0 The `min` option was added and the arguments changed to an
+ * @since 2.7.0 The `min` option was added and the arguments changed to an
  * object
  */
 export declare function loop(options: LoopOptions): number;

package/dist/utils/loop.js

@@ -1,5 +1,5 @@
 /**
- * @remarks \@since 2.7.0
+ * @since 2.7.0
  * @internal
  */ /**
  * A small util that is used to increment or decrement a number until it reaches
@@ -9,7 +9,7 @@
  *
  * @internal
  * @param options - {@link LoopOptions}
- * @remarks \@since 2.7.0 The `min` option was added and the arguments changed to an
+ * @since 2.7.0 The `min` option was added and the arguments changed to an
  * object
  */ export function loop(options) {
     const { value, min = 0, max, increment, minmax = false } = options;

package/dist/utils/loop.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils/loop.ts"],"sourcesContent":["/**\n * @remarks \\@since 2.7.0\n * @internal\n */\nexport interface LoopOptions {\n  /**\n   * The current value that should be modified.\n   */\n  value: number;\n\n  /**\n   * An optional `min` value that can be used before looping to the `max` value.\n   *\n   * @defaultValue `0`\n   */\n  min?: number;\n\n  /**\n   * The max number that can be used before looping to the `min` value.\n   */\n  max: number;\n\n  /**\n   * Boolean if the `value` should be incremented or decremented by `1`.\n   */\n  increment: boolean;\n\n  /**\n   * Boolean if the looping should be ignored and only the `min`/`max` options\n   * should be respected. In other words, the looping  behavior will be disabled\n   * and the `value` must be: `min >= value <= max`\n   */\n  minmax?: boolean;\n}\n\n/**\n * A small util that is used to increment or decrement a number until it reaches\n * the max value or -1. When that happens, it will loop around to 0 or the max\n * value respectively. This does not work for different increment numbers or any\n * values below 0 for now.\n *\n * @internal\n * @param options - {@link LoopOptions}\n * @remarks \\@since 2.7.0 The `min` option was added and the arguments changed to an\n * object\n */\nexport function loop(options: LoopOptions): number {\n  const { value, min = 0, max, increment, minmax = false } = options;\n  let next = value + (increment ? 1 : -1);\n  if (minmax) {\n    next = Math.min(max, Math.max(min, next));\n  } else if (next > max) {\n    next = min;\n  } else if (next < min) {\n    next = max;\n  }\n\n  return next;\n}\n"],"names":["loop","options","value","min","max","increment","minmax","next","Math"],"mappings":"AAAA;;;CAGC,GAgCD;;;;;;;;;;CAUC,GACD,OAAO,SAASA,KAAKC,OAAoB;IACvC,MAAM,EAAEC,KAAK,EAAEC,MAAM,CAAC,EAAEC,GAAG,EAAEC,SAAS,EAAEC,SAAS,KAAK,EAAE,GAAGL;IAC3D,IAAIM,OAAOL,QAASG,CAAAA,YAAY,IAAI,CAAC,CAAA;IACrC,IAAIC,QAAQ;QACVC,OAAOC,KAAKL,GAAG,CAACC,KAAKI,KAAKJ,GAAG,CAACD,KAAKI;IACrC,OAAO,IAAIA,OAAOH,KAAK;QACrBG,OAAOJ;IACT,OAAO,IAAII,OAAOJ,KAAK;QACrBI,OAAOH;IACT;IAEA,OAAOG;AACT"}
+{"version":3,"sources":["../../src/utils/loop.ts"],"sourcesContent":["/**\n * @since 2.7.0\n * @internal\n */\nexport interface LoopOptions {\n  /**\n   * The current value that should be modified.\n   */\n  value: number;\n\n  /**\n   * An optional `min` value that can be used before looping to the `max` value.\n   *\n   * @defaultValue `0`\n   */\n  min?: number;\n\n  /**\n   * The max number that can be used before looping to the `min` value.\n   */\n  max: number;\n\n  /**\n   * Boolean if the `value` should be incremented or decremented by `1`.\n   */\n  increment: boolean;\n\n  /**\n   * Boolean if the looping should be ignored and only the `min`/`max` options\n   * should be respected. In other words, the looping  behavior will be disabled\n   * and the `value` must be: `min >= value <= max`\n   *\n   * @defaultValue `false`\n   */\n  minmax?: boolean;\n}\n\n/**\n * A small util that is used to increment or decrement a number until it reaches\n * the max value or -1. When that happens, it will loop around to 0 or the max\n * value respectively. This does not work for different increment numbers or any\n * values below 0 for now.\n *\n * @internal\n * @param options - {@link LoopOptions}\n * @since 2.7.0 The `min` option was added and the arguments changed to an\n * object\n */\nexport function loop(options: LoopOptions): number {\n  const { value, min = 0, max, increment, minmax = false } = options;\n  let next = value + (increment ? 1 : -1);\n  if (minmax) {\n    next = Math.min(max, Math.max(min, next));\n  } else if (next > max) {\n    next = min;\n  } else if (next < min) {\n    next = max;\n  }\n\n  return next;\n}\n"],"names":["loop","options","value","min","max","increment","minmax","next","Math"],"mappings":"AAAA;;;CAGC,GAkCD;;;;;;;;;;CAUC,GACD,OAAO,SAASA,KAAKC,OAAoB;IACvC,MAAM,EAAEC,KAAK,EAAEC,MAAM,CAAC,EAAEC,GAAG,EAAEC,SAAS,EAAEC,SAAS,KAAK,EAAE,GAAGL;IAC3D,IAAIM,OAAOL,QAASG,CAAAA,YAAY,IAAI,CAAC,CAAA;IACrC,IAAIC,QAAQ;QACVC,OAAOC,KAAKL,GAAG,CAACC,KAAKI,KAAKJ,GAAG,CAACD,KAAKI;IACrC,OAAO,IAAIA,OAAOH,KAAK;QACrBG,OAAOJ;IACT,OAAO,IAAII,OAAOJ,KAAK;QACrBI,OAAOH;IACT;IAEA,OAAOG;AACT"}

package/dist/utils/nearest.d.ts

@@ -1,6 +1,6 @@
 /**
  * @internal
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface NearestOptions {
     min: number;
@@ -15,8 +15,7 @@ export interface NearestOptions {
  *
  * @see https://stackoverflow.com/a/13635455
  * @returns the value rounded to the nearest step in the min/max range
- * @remarks
- * \@since 2.5.0 Added the `range` param
- * \@since 6.0.0 Converted to using an object instead of multiple arguments.
+ * @since 2.5.0 Added the `range` param
+ * @since 6.0.0 Converted to using an object instead of multiple arguments.
  */
 export declare function nearest(options: NearestOptions): number;