@react-md/core 1.0.0-next.8 → 6.0.0

package/dist/form/useEditableCombobox.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/form/useEditableCombobox.ts"],"sourcesContent":["\"use client\";\n\nimport { useRef } from \"react\";\n\nimport { isTypeEvent } from \"../movement/utils.js\";\nimport {\n  type ComboboxImplementation,\n  type ComboboxWidgetProps,\n  type ConfigurableComboboxOptions,\n  useCombobox,\n} from \"./useCombobox.js\";\nimport {\n  type EditableHTMLElement,\n  isChangeableHTMLElement,\n  triggerManualChangeEvent,\n} from \"./utils.js\";\n\n/**\n * @since 6.0.0\n */\nexport type EditableComboboxOptions<\n  ComboboxEl extends HTMLElement = HTMLInputElement,\n  PopupEl extends HTMLElement = HTMLElement,\n> = ConfigurableComboboxOptions<ComboboxEl, PopupEl>;\n\n/**\n * @since 6.0.0\n */\nexport interface EditableComboboxWidgetProps<\n  ComboboxEl extends EditableHTMLElement = HTMLInputElement,\n> extends ComboboxWidgetProps<ComboboxEl> {\n  /**\n   * This is set to `off` to prevent browser from providing their own\n   * suggestions.\n   *\n   * @defaultValue `\"off\"`\n   */\n  autoComplete: string;\n\n  /**\n   * This is set to `\"none\"` to prevent browsers from automatically capitalizing\n   * the first letter.\n   *\n   * @defaultValue `\"none\"`\n   */\n  autoCapitalize: string;\n}\n\n/**\n * @since 6.0.0\n */\nexport interface EditableComboboxImplementation<\n  ComboboxEl extends EditableHTMLElement = HTMLInputElement,\n  PopupEl extends HTMLElement = HTMLElement,\n> extends ComboboxImplementation<ComboboxEl, PopupEl> {\n  comboboxProps: EditableComboboxWidgetProps<ComboboxEl>;\n}\n\n/**\n * @since 6.0.0\n */\nexport function useEditableCombobox<\n  ComboboxEl extends EditableHTMLElement = HTMLInputElement,\n  PopupEl extends HTMLElement = HTMLElement,\n>(\n  options: EditableComboboxOptions<ComboboxEl, PopupEl> = {}\n): EditableComboboxImplementation<ComboboxEl, PopupEl> {\n  const focusFirst = useRef(false);\n  const { getMenuProps, ...combobox } = useCombobox({\n    ...options,\n    loopable: true,\n    searchable: false,\n    isNegativeOneAllowed: true,\n    getEnterDefaultFocusedIndex(options) {\n      const { focusLast, focusables, currentFocusIndex } = options;\n      if (focusFirst.current) {\n        focusFirst.current = false;\n        return 0;\n      }\n\n      if (focusLast) {\n        return focusables.length - 1;\n      }\n\n      return currentFocusIndex;\n    },\n    extendKeyDown(movementData) {\n      const {\n        event,\n        show,\n        hide,\n        visible,\n        currentFocusIndex,\n        setActiveDescendantId,\n      } = movementData;\n\n      const resetFocus = (): void => {\n        currentFocusIndex.current = -1;\n        setActiveDescendantId(\"\");\n      };\n\n      switch (event.key) {\n        case \"Escape\":\n          if (!visible && isChangeableHTMLElement(event.currentTarget)) {\n            event.preventDefault();\n            event.stopPropagation();\n            triggerManualChangeEvent(event.currentTarget, \"\");\n          }\n          break;\n        case \"Home\":\n        case \"End\":\n          // do not attempt to jump to the start or end of the listbox so\n          // natural text editing occurs\n          event.stopPropagation();\n          if (visible) {\n            resetFocus();\n          }\n          break;\n        case \"ArrowLeft\":\n        case \"ArrowRight\":\n          if (visible) {\n            resetFocus();\n          }\n          break;\n        case \"ArrowUp\":\n          // Note: The non-altKey version is handled in the `useCombobox` hook\n          //\n          // if the popup is available and the altKey was pressed, return focus\n          // to the combobox without closing. If the focus was already on the\n          // combobox, hide the popup\n          if (visible && event.altKey) {\n            event.preventDefault();\n            event.stopPropagation();\n\n            if (currentFocusIndex.current !== -1) {\n              resetFocus();\n            } else {\n              hide();\n            }\n          }\n          break;\n        case \"ArrowDown\":\n          // if the popup is available, display the popup keep the focus on the\n          // combobox if the altKey was pressed. Otherwise, move focus into the\n          // listbox\n          if (!visible) {\n            event.preventDefault();\n            event.stopPropagation();\n            focusFirst.current = !event.altKey;\n            show();\n          }\n          break;\n        default:\n          if (isTypeEvent(event)) {\n            show();\n            resetFocus();\n          }\n      }\n    },\n  });\n\n  return {\n    ...combobox,\n    comboboxProps: {\n      ...combobox.comboboxProps,\n      autoCapitalize: \"none\",\n      autoComplete: \"off\",\n    },\n    getMenuProps(props) {\n      return {\n        // override the inherited renderAsSheet context since the sheet makes it\n        // so the user can't actually type in the combobox\n        renderAsSheet: false,\n        preventOverlap: true,\n        ...getMenuProps(props),\n      };\n    },\n  };\n}\n"],"names":["useRef","isTypeEvent","useCombobox","isChangeableHTMLElement","triggerManualChangeEvent","useEditableCombobox","options","focusFirst","getMenuProps","combobox","loopable","searchable","isNegativeOneAllowed","getEnterDefaultFocusedIndex","focusLast","focusables","currentFocusIndex","current","length","extendKeyDown","movementData","event","show","hide","visible","setActiveDescendantId","resetFocus","key","currentTarget","preventDefault","stopPropagation","altKey","comboboxProps","autoCapitalize","autoComplete","props","renderAsSheet","preventOverlap"],"mappings":"AAAA;AAEA,SAASA,MAAM,QAAQ,QAAQ;AAE/B,SAASC,WAAW,QAAQ,uBAAuB;AACnD,SAIEC,WAAW,QACN,mBAAmB;AAC1B,SAEEC,uBAAuB,EACvBC,wBAAwB,QACnB,aAAa;AA2CpB;;CAEC,GACD,OAAO,SAASC,oBAIdC,UAAwD,CAAC,CAAC;IAE1D,MAAMC,aAAaP,OAAO;IAC1B,MAAM,EAAEQ,YAAY,EAAE,GAAGC,UAAU,GAAGP,YAAY;QAChD,GAAGI,OAAO;QACVI,UAAU;QACVC,YAAY;QACZC,sBAAsB;QACtBC,6BAA4BP,OAAO;YACjC,MAAM,EAAEQ,SAAS,EAAEC,UAAU,EAAEC,iBAAiB,EAAE,GAAGV;YACrD,IAAIC,WAAWU,OAAO,EAAE;gBACtBV,WAAWU,OAAO,GAAG;gBACrB,OAAO;YACT;YAEA,IAAIH,WAAW;gBACb,OAAOC,WAAWG,MAAM,GAAG;YAC7B;YAEA,OAAOF;QACT;QACAG,eAAcC,YAAY;YACxB,MAAM,EACJC,KAAK,EACLC,IAAI,EACJC,IAAI,EACJC,OAAO,EACPR,iBAAiB,EACjBS,qBAAqB,EACtB,GAAGL;YAEJ,MAAMM,aAAa;gBACjBV,kBAAkBC,OAAO,GAAG,CAAC;gBAC7BQ,sBAAsB;YACxB;YAEA,OAAQJ,MAAMM,GAAG;gBACf,KAAK;oBACH,IAAI,CAACH,WAAWrB,wBAAwBkB,MAAMO,aAAa,GAAG;wBAC5DP,MAAMQ,cAAc;wBACpBR,MAAMS,eAAe;wBACrB1B,yBAAyBiB,MAAMO,aAAa,EAAE;oBAChD;oBACA;gBACF,KAAK;gBACL,KAAK;oBACH,+DAA+D;oBAC/D,8BAA8B;oBAC9BP,MAAMS,eAAe;oBACrB,IAAIN,SAAS;wBACXE;oBACF;oBACA;gBACF,KAAK;gBACL,KAAK;oBACH,IAAIF,SAAS;wBACXE;oBACF;oBACA;gBACF,KAAK;oBACH,oEAAoE;oBACpE,EAAE;oBACF,qEAAqE;oBACrE,mEAAmE;oBACnE,2BAA2B;oBAC3B,IAAIF,WAAWH,MAAMU,MAAM,EAAE;wBAC3BV,MAAMQ,cAAc;wBACpBR,MAAMS,eAAe;wBAErB,IAAId,kBAAkBC,OAAO,KAAK,CAAC,GAAG;4BACpCS;wBACF,OAAO;4BACLH;wBACF;oBACF;oBACA;gBACF,KAAK;oBACH,qEAAqE;oBACrE,qEAAqE;oBACrE,UAAU;oBACV,IAAI,CAACC,SAAS;wBACZH,MAAMQ,cAAc;wBACpBR,MAAMS,eAAe;wBACrBvB,WAAWU,OAAO,GAAG,CAACI,MAAMU,MAAM;wBAClCT;oBACF;oBACA;gBACF;oBACE,IAAIrB,YAAYoB,QAAQ;wBACtBC;wBACAI;oBACF;YACJ;QACF;IACF;IAEA,OAAO;QACL,GAAGjB,QAAQ;QACXuB,eAAe;YACb,GAAGvB,SAASuB,aAAa;YACzBC,gBAAgB;YAChBC,cAAc;QAChB;QACA1B,cAAa2B,KAAK;YAChB,OAAO;gBACL,wEAAwE;gBACxE,kDAAkD;gBAClDC,eAAe;gBACfC,gBAAgB;gBAChB,GAAG7B,aAAa2B,MAAM;YACxB;QACF;IACF;AACF"}

package/dist/form/useFormReset.d.ts

@@ -0,0 +1,16 @@
+import { type RefObject } from "react";
+import { type ChangeableHTMLElement } from "./utils.js";
+/**
+ * @since 6.0.0
+ * @internal
+ */
+export interface FormResetOptions {
+    form?: string;
+    elementRef: RefObject<ChangeableHTMLElement>;
+    defaultValue: string;
+}
+/**
+ * @since 6.0.0
+ * @internal
+ */
+export declare function useFormReset(options: FormResetOptions): void;

package/dist/form/useFormReset.js

@@ -0,0 +1,32 @@
+"use client";
+import { useEffect } from "react";
+import { triggerManualChangeEvent } from "./utils.js";
+/**
+ * @since 6.0.0
+ * @internal
+ */ export function useFormReset(options) {
+    const { form, elementRef, defaultValue } = options;
+    useEffect(()=>{
+        const element = elementRef.current;
+        if (!element) {
+            return;
+        }
+        const formElement = form && document.getElementById(form) || element.closest("form") || null;
+        if (!formElement) {
+            return;
+        }
+        const handleReset = ()=>{
+            triggerManualChangeEvent(element, defaultValue);
+        };
+        formElement.addEventListener("reset", handleReset);
+        return ()=>{
+            formElement.removeEventListener("reset", handleReset);
+        };
+    }, [
+        defaultValue,
+        elementRef,
+        form
+    ]);
+}
+
+//# sourceMappingURL=useFormReset.js.map

package/dist/form/useFormReset.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/form/useFormReset.ts"],"sourcesContent":["\"use client\";\n\nimport { type RefObject, useEffect } from \"react\";\n\nimport {\n  type ChangeableHTMLElement,\n  triggerManualChangeEvent,\n} from \"./utils.js\";\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport interface FormResetOptions {\n  form?: string;\n  elementRef: RefObject<ChangeableHTMLElement>;\n  defaultValue: string;\n}\n\n/**\n * @since 6.0.0\n * @internal\n */\nexport function useFormReset(options: FormResetOptions): void {\n  const { form, elementRef, defaultValue } = options;\n\n  useEffect(() => {\n    const element = elementRef.current;\n    if (!element) {\n      return;\n    }\n\n    const formElement =\n      (form && document.getElementById(form)) ||\n      element.closest<HTMLFormElement>(\"form\") ||\n      null;\n    if (!formElement) {\n      return;\n    }\n\n    const handleReset = (): void => {\n      triggerManualChangeEvent(element, defaultValue);\n    };\n\n    formElement.addEventListener(\"reset\", handleReset);\n    return () => {\n      formElement.removeEventListener(\"reset\", handleReset);\n    };\n  }, [defaultValue, elementRef, form]);\n}\n"],"names":["useEffect","triggerManualChangeEvent","useFormReset","options","form","elementRef","defaultValue","element","current","formElement","document","getElementById","closest","handleReset","addEventListener","removeEventListener"],"mappings":"AAAA;AAEA,SAAyBA,SAAS,QAAQ,QAAQ;AAElD,SAEEC,wBAAwB,QACnB,aAAa;AAYpB;;;CAGC,GACD,OAAO,SAASC,aAAaC,OAAyB;IACpD,MAAM,EAAEC,IAAI,EAAEC,UAAU,EAAEC,YAAY,EAAE,GAAGH;IAE3CH,UAAU;QACR,MAAMO,UAAUF,WAAWG,OAAO;QAClC,IAAI,CAACD,SAAS;YACZ;QACF;QAEA,MAAME,cACJ,AAACL,QAAQM,SAASC,cAAc,CAACP,SACjCG,QAAQK,OAAO,CAAkB,WACjC;QACF,IAAI,CAACH,aAAa;YAChB;QACF;QAEA,MAAMI,cAAc;YAClBZ,yBAAyBM,SAASD;QACpC;QAEAG,YAAYK,gBAAgB,CAAC,SAASD;QACtC,OAAO;YACLJ,YAAYM,mBAAmB,CAAC,SAASF;QAC3C;IACF,GAAG;QAACP;QAAcD;QAAYD;KAAK;AACrC"}

package/dist/form/useNumberField.d.ts

@@ -1,6 +1,6 @@
 import { type UseStateInitializer, type UseStateSetter } from "../types.js";
 import { type ProvidedTextFieldMessageProps, type ProvidedTextFieldProps, type TextFieldHookOptions, type TextFieldHookState, type TextFieldImplementation, type ValidatedTextFieldImplementation } from "./useTextField.js";
-/** @remarks \@since 2.5.0 */
+/** @since 2.5.0 */
 export interface NumberFieldConstraints {
     /**
      * An optional min value for the number field.
@@ -19,9 +19,8 @@ export interface NumberFieldConstraints {
     step?: number;
 }
 /**
- * @remarks
- * \@since 2.5.0
- * \@since 6.0.0
+ * @since 2.5.0
+ * @since 6.0.0
  * - Removed `updateOnChange` in favor of `updateValue`
  * - Renamed `fixOnBlur` to `updateValueOnBlur`
  */
@@ -36,10 +35,10 @@ export interface NumberFieldHookOptions extends Omit<TextFieldHookOptions<HTMLIn
      * other components, keep this as the default of `"change"`. Otherwise, set
      * this to `"blur"`.
      *
-     * @example
-     * Deferring Updates on Blur
+     * @example Deferring Updates on Blur
      * ```tsx
-     * import { TextField, useNumberField } from "@react-md/core";
+     * import { TextField } from "@react-md/core/form/TextField";
+     * import { useNumberField } from "@react-md/core/form/useNumberField";
      * import type { ReactElement } from "react";
      *
      * function Example(): ReactElement {
@@ -80,44 +79,44 @@ export interface NumberFieldHookOptions extends Omit<TextFieldHookOptions<HTMLIn
      * fix any min/max errors manually and maintain weird formatting.
      *
      * @defaultValue `true`
-     * @remarks \@since 6.0.0 This was renamed from `fixOnBlur` and removed the
+     * @since 6.0.0 This was renamed from `fixOnBlur` and removed the
      * `"min"` and `"max"` behavior.
      */
     updateValueOnBlur?: boolean;
 }
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface NumberFieldHookState extends Omit<TextFieldHookState, "value"> {
     value: number | undefined;
 }
-/** @remarks \@since 2.5.6 */
+/** @since 2.5.6 */
 export interface ProvidedNumberFieldProps extends ProvidedTextFieldProps<HTMLInputElement>, NumberFieldConstraints {
     type: "number";
 }
-/** @remarks \@since 2.5.6 */
+/** @since 2.5.6 */
 export interface ProvidedNumberFieldMessageProps extends ProvidedTextFieldMessageProps<HTMLInputElement>, NumberFieldConstraints {
     type: "number";
 }
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface NumberFieldImplementation extends Omit<TextFieldImplementation<HTMLInputElement>, "value" | "setState"> {
     value: number | undefined;
     setState: UseStateSetter<NumberFieldHookState>;
     fieldProps: ProvidedNumberFieldProps;
 }
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface NumberFieldWithMessageImplementation extends NumberFieldImplementation {
     fieldProps: ProvidedNumberFieldMessageProps;
 }
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface ValidatedNumberFieldImplementation extends Omit<ValidatedTextFieldImplementation<HTMLInputElement>, "value" | "setState"> {
     value: number | undefined;
     setState: UseStateSetter<NumberFieldHookState>;
     fieldProps: ProvidedNumberFieldProps | ProvidedNumberFieldMessageProps;
 }
 /**
- * @example
- * Enforce Number Value and No Error Messages
+ * @example Enforce Number Value and No Error Messages
  * ```tsx
- * import { TextField, useNumberField } from "@react-md/core";
+ * import { TextField } from "@react-md/core/form/TextField";
+ * import { useNumberField } from "@react-md/core/form/useNumberField";
  * import type { ReactElement } from "react";
  *
  * function Example(): ReactElement {
@@ -136,6 +135,7 @@ export interface ValidatedNumberFieldImplementation extends Omit<ValidatedTextFi
  *
  *   return <TextField {...fieldProps} label="Label" />;
  * }
+ * ```
  *
  * @see {@link useTextField}
  * @see {@link useNumberField} overrides for other examples.
@@ -151,10 +151,10 @@ export declare function useNumberField(options: NumberFieldHookOptions & {
     }>;
 };
 /**
- * @example
- * No Error Messages
+ * @example No Error Messages
  * ```tsx
- * import { TextField, useNumberField } from "@react-md/core";
+ * import { TextField } from "@react-md/core/form/TextField";
+ * import { useNumberField } from "@react-md/core/form/useNumberField";
  * import type { ReactElement } from "react";
  *
  * function Example(): ReactElement {
@@ -182,10 +182,10 @@ export declare function useNumberField(options: NumberFieldHookOptions & {
     disableMessage: true;
 }): NumberFieldImplementation;
 /**
- * @example
- * Enforce Number Value
+ * @example Enforce Number Value
  * ```tsx
- * import { TextField, useNumberField } from "@react-md/core";
+ * import { TextField } from "@react-md/core/form/TextField";
+ * import { useNumberField } from "@react-md/core/form/useNumberField";
  * import type { ReactElement } from "react";
  *
  * function Example(): ReactElement {
@@ -205,10 +205,10 @@ export declare function useNumberField(options: NumberFieldHookOptions & {
  * }
  * ```
  *
- * @example
- * Enforce Number Value and Deferring Updates
+ * @example Enforce Number Value and Deferring Updates
  * ```tsx
- * import { TextField, useNumberField } from "@react-md/core";
+ * import { TextField } from "@react-md/core/form/TextField";
+ * import { useNumberField } from "@react-md/core/form/useNumberField";
  * import type { ReactElement } from "react";
  *
  * function Example(): ReactElement {
@@ -244,10 +244,10 @@ export declare function useNumberField(options: NumberFieldHookOptions & {
  * The `useNumberField` hook is used to control the state of a `TextField` or
  * `<input type="number">`
  *
- * @example
- * Default Implementation
+ * @example Default Implementation
  * ```tsx
- * import { TextField, useNumberField } from "@react-md/core";
+ * import { TextField } from "@react-md/core/form/TextField";
+ * import { useNumberField } from "@react-md/core/form/useNumberField";
  * import type { ReactElement } from "react";
  *
  * function Example(): ReactElement {
@@ -267,10 +267,10 @@ export declare function useNumberField(options: NumberFieldHookOptions & {
  * }
  * ```
  *
- * @example
- * Adding Constraints
+ * @example Adding Constraints
  * ```tsx
- * import { TextField, useNumberField } from "@react-md/core";
+ * import { TextField } from "@react-md/core/form/TextField";
+ * import { useNumberField } from "@react-md/core/form/useNumberField";
  * import type { ReactElement } from "react";
  *
  * function Example(): ReactElement {
@@ -287,6 +287,8 @@ export declare function useNumberField(options: NumberFieldHookOptions & {
  * ```
  *
  * @see https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5/Constraint_validation
+ * @see {@link https://next.react-md.dev/components/text-field#number | Number TextField Demos}
+ * @see {@link https://next.react-md.dev/hooks/use-number-field | useNumberField Demos}
  * @see {@link useTextField}
  */
 export declare function useNumberField(options: NumberFieldHookOptions): NumberFieldWithMessageImplementation;

package/dist/form/useNumberField.js

@@ -7,6 +7,8 @@ const noop = ()=>{
 };
 /**
  * @internal
+ * @see {@link https://next.react-md.dev/components/text-field#number | Number TextField Demos}
+ * @see {@link https://next.react-md.dev/hooks/use-number-field | useNumberField Demos}
  * @see {@link useTextField}
  * @see {@link useNumberField} overrides for other examples.
  */ export function useNumberField(options) {

package/dist/form/useNumberField.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/form/useNumberField.ts"],"sourcesContent":["\"use client\";\nimport { useCallback, useRef, useState } from \"react\";\nimport { type UseStateInitializer, type UseStateSetter } from \"../types.js\";\nimport { withinRange } from \"../utils/withinRange.js\";\nimport {\n  useTextField,\n  type ProvidedTextFieldMessageProps,\n  type ProvidedTextFieldProps,\n  type TextFieldHookOptions,\n  type TextFieldHookState,\n  type TextFieldImplementation,\n  type ValidatedTextFieldImplementation,\n} from \"./useTextField.js\";\n\nconst noop = (): void => {\n  // do nothing\n};\n\n/** @remarks \\@since 2.5.0 */\nexport interface NumberFieldConstraints {\n  /**\n   * An optional min value for the number field.\n   */\n  min?: number;\n\n  /**\n   * An optional max value for the number field.\n   */\n  max?: number;\n\n  /**\n   * An optional step amount to use.\n   *\n   * Note: The `min` and `max` values must be divisible by this value when any\n   * are defined.\n   */\n  step?: number;\n}\n\n/**\n * @remarks\n * \\@since 2.5.0\n * \\@since 6.0.0\n * - Removed `updateOnChange` in favor of `updateValue`\n * - Renamed `fixOnBlur` to `updateValueOnBlur`\n */\nexport interface NumberFieldHookOptions\n  extends Omit<\n      TextFieldHookOptions<HTMLInputElement>,\n      \"defaultValue\" | \"isNumber\"\n    >,\n    NumberFieldConstraints {\n  /**\n   * @defaultValue `undefined`\n   */\n  defaultValue?: UseStateInitializer<number>;\n\n  /**\n   * This controls the behavior for the `value` returned by this hook. If you\n   * need access to the current value immediately as the user types to update\n   * other components, keep this as the default of `\"change\"`. Otherwise, set\n   * this to `\"blur\"`.\n   *\n   * @example\n   * Deferring Updates on Blur\n   * ```tsx\n   * import { TextField, useNumberField } from \"@react-md/core\";\n   * import type { ReactElement } from \"react\";\n   *\n   * function Example(): ReactElement {\n   *   const { fieldProps, value } = useNumberField({\n   *     min: 0,\n   *     max: 100,\n   *     name: \"someName\",\n   *     defaultValue: 0,\n   *     updateValue: \"blur\",\n   *   });\n   *\n   *   const result = useMemo(() => someExpensiveComputation(value), [value]);\n   *\n   *   return <TextField {...fieldProps} label=\"Label\" />;\n   * }\n   * ```\n   *\n   * @defaultValue `\"change\"`\n   */\n  updateValue?: \"blur\" | \"change\";\n\n  /**\n   * This option is used to update the `number` value and text field value to be\n   * within the `min` and `max` range or just format the text field value when\n   * the input is blurred. This update will only be applied if the text field\n   * contains a valid number. Using `min = 0` and `max = 10`:\n   *\n   * | text value | updated value |\n   * | ---------- | ------------- |\n   * | 000001     | 1             |\n   * | -1         | 0             |\n   * | 20         | 10            |\n   * | -12        | 0             |\n   * | --1        | --1           |\n   * | fjdka      | fjdka         |\n   *\n   *\n   * Set this to `false` if no changed should be applied and force the user to\n   * fix any min/max errors manually and maintain weird formatting.\n   *\n   * @defaultValue `true`\n   * @remarks \\@since 6.0.0 This was renamed from `fixOnBlur` and removed the\n   * `\"min\"` and `\"max\"` behavior.\n   */\n  updateValueOnBlur?: boolean;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport interface NumberFieldHookState\n  extends Omit<TextFieldHookState, \"value\"> {\n  value: number | undefined;\n}\n\n/** @remarks \\@since 2.5.6 */\nexport interface ProvidedNumberFieldProps\n  extends ProvidedTextFieldProps<HTMLInputElement>,\n    NumberFieldConstraints {\n  type: \"number\";\n}\n\n/** @remarks \\@since 2.5.6 */\nexport interface ProvidedNumberFieldMessageProps\n  extends ProvidedTextFieldMessageProps<HTMLInputElement>,\n    NumberFieldConstraints {\n  type: \"number\";\n}\n\n/** @remarks \\@since 6.0.0 */\nexport interface NumberFieldImplementation\n  extends Omit<\n    TextFieldImplementation<HTMLInputElement>,\n    \"value\" | \"setState\"\n  > {\n  value: number | undefined;\n  setState: UseStateSetter<NumberFieldHookState>;\n  fieldProps: ProvidedNumberFieldProps;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport interface NumberFieldWithMessageImplementation\n  extends NumberFieldImplementation {\n  fieldProps: ProvidedNumberFieldMessageProps;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport interface ValidatedNumberFieldImplementation\n  extends Omit<\n    ValidatedTextFieldImplementation<HTMLInputElement>,\n    \"value\" | \"setState\"\n  > {\n  value: number | undefined;\n  setState: UseStateSetter<NumberFieldHookState>;\n  fieldProps: ProvidedNumberFieldProps | ProvidedNumberFieldMessageProps;\n}\n\n/**\n * @example\n * Enforce Number Value and No Error Messages\n * ```tsx\n * import { TextField, useNumberField } from \"@react-md/core\";\n * import type { ReactElement } from \"react\";\n *\n * function Example(): ReactElement {\n *   const { fieldProps, value } = useNumberField({\n *     min: 0,\n *     max: 100,\n *     name: \"someName\",\n *     defaultValue: 0,\n *     disableMessage: true,\n *   });\n *\n *   // this is safe since `value` will always be a number even if there is a\n *   // validation error. since the min and max options were provided as well,\n *   // number will be between that range as well.\n *   const computed = value * 10;\n *\n *   return <TextField {...fieldProps} label=\"Label\" />;\n * }\n *\n * @see {@link useTextField}\n * @see {@link useNumberField} overrides for other examples.\n * ```\n */\nexport function useNumberField(\n  options: NumberFieldHookOptions & {\n    disableMessage: true;\n    defaultValue: UseStateInitializer<number>;\n  }\n): NumberFieldImplementation & {\n  value: number;\n  setState: UseStateSetter<NumberFieldHookState & { value: number }>;\n};\n\n/**\n * @example\n * No Error Messages\n * ```tsx\n * import { TextField, useNumberField } from \"@react-md/core\";\n * import type { ReactElement } from \"react\";\n *\n * function Example(): ReactElement {\n *   const { fieldProps, value } = useNumberField({\n *     min: 0,\n *     max: 100,\n *     name: \"someName\",\n *     disableMessage: true,\n *   });\n *\n *   // `value` will be `undefined` until the user enters a valid value once\n *   // there is a valid value, `value` will be a `number`. So this might cause\n *   // `computed` to be `NaN | number`\n *   //\n *   // const computed = value * 10;\n *\n *   return <TextField {...fieldProps} label=\"Label\" />;\n * }\n * ```\n *\n * @see {@link useTextField}\n * @see {@link useNumberField} overrides for other examples.\n */\nexport function useNumberField(\n  options: NumberFieldHookOptions & { disableMessage: true }\n): NumberFieldImplementation;\n\n/**\n * @example\n * Enforce Number Value\n * ```tsx\n * import { TextField, useNumberField } from \"@react-md/core\";\n * import type { ReactElement } from \"react\";\n *\n * function Example(): ReactElement {\n *   const { fieldProps, value } = useNumberField({\n *     min: 0,\n *     max: 100,\n *     name: \"someName\",\n *     defaultValue: 0,\n *   });\n *\n *   // this is safe since `value` will always be a number even if there is a\n *   // validation error. since the min and max options were provided as well,\n *   // number will be between that range as well.\n *   const computed = value * 10;\n *\n *   return <TextField {...fieldProps} label=\"Label\" />;\n * }\n * ```\n *\n * @example\n * Enforce Number Value and Deferring Updates\n * ```tsx\n * import { TextField, useNumberField } from \"@react-md/core\";\n * import type { ReactElement } from \"react\";\n *\n * function Example(): ReactElement {\n *   const { fieldProps, value } = useNumberField({\n *     min: 0,\n *     max: 100,\n *     name: \"someName\",\n *     defaultValue: 0,\n *     updateValue: \"blur\",\n *   });\n *\n *   // the `value` will only be updated whenever the `TextField` is blurred.\n *   // This is helpful if the `value` is used in expensive computations or\n *   // updates that do not need to be updated as the user types\n *   const computed = value * 10;\n *\n *   return <TextField {...fieldProps} label=\"Label\" />;\n * }\n * ```\n *\n * @see {@link useTextField}\n * @see {@link useNumberField} overrides for other examples.\n */\nexport function useNumberField(\n  options: NumberFieldHookOptions & {\n    defaultValue: UseStateInitializer<number>;\n  }\n): NumberFieldWithMessageImplementation & {\n  value: number;\n  setState: UseStateSetter<NumberFieldHookState & { value: number }>;\n};\n\n/**\n * The `useNumberField` hook is used to control the state of a `TextField` or\n * `<input type=\"number\">`\n *\n * @example\n * Default Implementation\n * ```tsx\n * import { TextField, useNumberField } from \"@react-md/core\";\n * import type { ReactElement } from \"react\";\n *\n * function Example(): ReactElement {\n *   const { fieldProps, value } = useNumberField({\n *     name: \"someName\",\n *   });\n *\n *   // `value` will be `undefined` until the user enters a valid value once\n *   // there is a valid value, `value` will be a `number`. So this might cause\n *   // `computed` to be `NaN | number`\n *   //\n *   // const computed = value * 10;\n *\n *   // whenever there is an error, an error message will be displayed below the\n *   // `TextField`\n *   return <TextField {...fieldProps} label=\"Label\" />;\n * }\n * ```\n *\n * @example\n * Adding Constraints\n * ```tsx\n * import { TextField, useNumberField } from \"@react-md/core\";\n * import type { ReactElement } from \"react\";\n *\n * function Example(): ReactElement {\n *   const { fieldProps, value } = useNumberField({\n *     name: \"someName\",\n *     min: 0,\n *     max: 100,\n *     step: 2,\n *     required: true,\n *   });\n *\n *   return <TextField {...fieldProps} label=\"Label\" />;\n * }\n * ```\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5/Constraint_validation\n * @see {@link useTextField}\n */\nexport function useNumberField(\n  options: NumberFieldHookOptions\n): NumberFieldWithMessageImplementation;\n\n/**\n * @internal\n * @see {@link useTextField}\n * @see {@link useNumberField} overrides for other examples.\n */\nexport function useNumberField(\n  options: NumberFieldHookOptions\n): ValidatedNumberFieldImplementation {\n  const {\n    min,\n    max,\n    step,\n    onBlur = noop,\n    onChange = noop,\n    updateValue = \"change\",\n    updateValueOnBlur = true,\n    defaultValue,\n    ...textOptions\n  } = options;\n\n  const [number, setNumber] = useState(defaultValue);\n  const initial = useRef(number);\n  const {\n    value: _value,\n    reset: resetTextField,\n    fieldProps,\n    setState: setTextFieldState,\n    ...remaining\n  } = useTextField({\n    ...textOptions,\n    isNumber: true,\n    defaultValue: `${number ?? \"\"}`,\n    onBlur(event) {\n      onBlur(event);\n      if (event.isPropagationStopped()) {\n        return;\n      }\n\n      const input = event.currentTarget;\n      input.setCustomValidity(\"\");\n      input.checkValidity();\n      if (\n        !updateValueOnBlur ||\n        // do nothing else since it's a weird value like: `\"--0\"` which causes\n        // the value to be `\"\"` and `numberAsValue` to be `NaN`\n        input.validity.badInput\n      ) {\n        return;\n      }\n\n      let value = input.valueAsNumber;\n      if (input.value === \"\" && typeof initial.current === \"number\") {\n        value = min ?? initial.current;\n      }\n\n      // can't have both rangeUnderflow and rangeOverflow at the same time, so\n      // it's \"safe\" to always provide both\n      value = withinRange({ min, max, value });\n      if (!Number.isNaN(value)) {\n        setNumber(value);\n        input.value = `${value}`;\n      } else if (typeof initial.current === \"undefined\") {\n        setNumber(undefined);\n      }\n    },\n    onChange(event) {\n      onChange(event);\n      if (event.isPropagationStopped() || updateValue === \"blur\") {\n        return;\n      }\n\n      const input = event.currentTarget;\n      input.checkValidity();\n      const value = withinRange({\n        min,\n        max,\n        value: event.currentTarget.valueAsNumber,\n      });\n      if (\n        !input.validity.valid &&\n        !input.validity.rangeUnderflow &&\n        !input.validity.rangeOverflow\n      ) {\n        return;\n      }\n\n      if (!Number.isNaN(value)) {\n        setNumber(value);\n      } else if (initial.current === undefined) {\n        setNumber(undefined);\n      }\n    },\n  });\n\n  const reset = useCallback(() => {\n    resetTextField();\n    setNumber(initial.current);\n  }, [resetTextField]);\n  const setState = useCallback<UseStateSetter<NumberFieldHookState>>(\n    (nextState) => {\n      if (typeof nextState === \"function\") {\n        setNumber((prevNumber) => {\n          let nextNumber: number | undefined = prevNumber;\n          setTextFieldState((prevState) => {\n            const updated = nextState({\n              ...prevState,\n              value: prevNumber,\n            });\n\n            nextNumber = updated.value;\n\n            return {\n              ...updated,\n              value: `${nextNumber ?? \"\"}`,\n            };\n          });\n\n          return nextNumber;\n        });\n        return;\n      }\n\n      const { value, error, errorMessage } = nextState;\n      setNumber(value);\n      setTextFieldState({\n        value: `${value ?? \"\"}`,\n        error,\n        errorMessage,\n      });\n    },\n    [setTextFieldState]\n  );\n\n  return {\n    ...remaining,\n    reset,\n    value: number,\n    setState,\n    fieldProps: {\n      ...fieldProps,\n      min,\n      max,\n      step,\n      type: \"number\",\n    },\n  };\n}\n"],"names":["useCallback","useRef","useState","withinRange","useTextField","noop","useNumberField","options","min","max","step","onBlur","onChange","updateValue","updateValueOnBlur","defaultValue","textOptions","number","setNumber","initial","value","_value","reset","resetTextField","fieldProps","setState","setTextFieldState","remaining","isNumber","event","isPropagationStopped","input","currentTarget","setCustomValidity","checkValidity","validity","badInput","valueAsNumber","current","Number","isNaN","undefined","valid","rangeUnderflow","rangeOverflow","nextState","prevNumber","nextNumber","prevState","updated","error","errorMessage","type"],"mappings":"AAAA;AACA,SAASA,WAAW,EAAEC,MAAM,EAAEC,QAAQ,QAAQ,QAAQ;AAEtD,SAASC,WAAW,QAAQ,0BAA0B;AACtD,SACEC,YAAY,QAOP,oBAAoB;AAE3B,MAAMC,OAAO;AACX,aAAa;AACf;AAyUA;;;;CAIC,GACD,OAAO,SAASC,eACdC,OAA+B;IAE/B,MAAM,EACJC,GAAG,EACHC,GAAG,EACHC,IAAI,EACJC,SAASN,IAAI,EACbO,WAAWP,IAAI,EACfQ,cAAc,QAAQ,EACtBC,oBAAoB,IAAI,EACxBC,YAAY,EACZ,GAAGC,aACJ,GAAGT;IAEJ,MAAM,CAACU,QAAQC,UAAU,GAAGhB,SAASa;IACrC,MAAMI,UAAUlB,OAAOgB;IACvB,MAAM,EACJG,OAAOC,MAAM,EACbC,OAAOC,cAAc,EACrBC,UAAU,EACVC,UAAUC,iBAAiB,EAC3B,GAAGC,WACJ,GAAGvB,aAAa;QACf,GAAGY,WAAW;QACdY,UAAU;QACVb,cAAc,CAAC,EAAEE,UAAU,GAAG,CAAC;QAC/BN,QAAOkB,KAAK;YACVlB,OAAOkB;YACP,IAAIA,MAAMC,oBAAoB,IAAI;gBAChC;YACF;YAEA,MAAMC,QAAQF,MAAMG,aAAa;YACjCD,MAAME,iBAAiB,CAAC;YACxBF,MAAMG,aAAa;YACnB,IACE,CAACpB,qBACD,sEAAsE;YACtE,uDAAuD;YACvDiB,MAAMI,QAAQ,CAACC,QAAQ,EACvB;gBACA;YACF;YAEA,IAAIhB,QAAQW,MAAMM,aAAa;YAC/B,IAAIN,MAAMX,KAAK,KAAK,MAAM,OAAOD,QAAQmB,OAAO,KAAK,UAAU;gBAC7DlB,QAAQZ,OAAOW,QAAQmB,OAAO;YAChC;YAEA,wEAAwE;YACxE,qCAAqC;YACrClB,QAAQjB,YAAY;gBAAEK;gBAAKC;gBAAKW;YAAM;YACtC,IAAI,CAACmB,OAAOC,KAAK,CAACpB,QAAQ;gBACxBF,UAAUE;gBACVW,MAAMX,KAAK,GAAG,CAAC,EAAEA,MAAM,CAAC;YAC1B,OAAO,IAAI,OAAOD,QAAQmB,OAAO,KAAK,aAAa;gBACjDpB,UAAUuB;YACZ;QACF;QACA7B,UAASiB,KAAK;YACZjB,SAASiB;YACT,IAAIA,MAAMC,oBAAoB,MAAMjB,gBAAgB,QAAQ;gBAC1D;YACF;YAEA,MAAMkB,QAAQF,MAAMG,aAAa;YACjCD,MAAMG,aAAa;YACnB,MAAMd,QAAQjB,YAAY;gBACxBK;gBACAC;gBACAW,OAAOS,MAAMG,aAAa,CAACK,aAAa;YAC1C;YACA,IACE,CAACN,MAAMI,QAAQ,CAACO,KAAK,IACrB,CAACX,MAAMI,QAAQ,CAACQ,cAAc,IAC9B,CAACZ,MAAMI,QAAQ,CAACS,aAAa,EAC7B;gBACA;YACF;YAEA,IAAI,CAACL,OAAOC,KAAK,CAACpB,QAAQ;gBACxBF,UAAUE;YACZ,OAAO,IAAID,QAAQmB,OAAO,KAAKG,WAAW;gBACxCvB,UAAUuB;YACZ;QACF;IACF;IAEA,MAAMnB,QAAQtB,YAAY;QACxBuB;QACAL,UAAUC,QAAQmB,OAAO;IAC3B,GAAG;QAACf;KAAe;IACnB,MAAME,WAAWzB,YACf,CAAC6C;QACC,IAAI,OAAOA,cAAc,YAAY;YACnC3B,UAAU,CAAC4B;gBACT,IAAIC,aAAiCD;gBACrCpB,kBAAkB,CAACsB;oBACjB,MAAMC,UAAUJ,UAAU;wBACxB,GAAGG,SAAS;wBACZ5B,OAAO0B;oBACT;oBAEAC,aAAaE,QAAQ7B,KAAK;oBAE1B,OAAO;wBACL,GAAG6B,OAAO;wBACV7B,OAAO,CAAC,EAAE2B,cAAc,GAAG,CAAC;oBAC9B;gBACF;gBAEA,OAAOA;YACT;YACA;QACF;QAEA,MAAM,EAAE3B,KAAK,EAAE8B,KAAK,EAAEC,YAAY,EAAE,GAAGN;QACvC3B,UAAUE;QACVM,kBAAkB;YAChBN,OAAO,CAAC,EAAEA,SAAS,GAAG,CAAC;YACvB8B;YACAC;QACF;IACF,GACA;QAACzB;KAAkB;IAGrB,OAAO;QACL,GAAGC,SAAS;QACZL;QACAF,OAAOH;QACPQ;QACAD,YAAY;YACV,GAAGA,UAAU;YACbhB;YACAC;YACAC;YACA0C,MAAM;QACR;IACF;AACF"}
+{"version":3,"sources":["../../src/form/useNumberField.ts"],"sourcesContent":["\"use client\";\n\nimport { useCallback, useRef, useState } from \"react\";\n\nimport { type UseStateInitializer, type UseStateSetter } from \"../types.js\";\nimport { withinRange } from \"../utils/withinRange.js\";\nimport {\n  type ProvidedTextFieldMessageProps,\n  type ProvidedTextFieldProps,\n  type TextFieldHookOptions,\n  type TextFieldHookState,\n  type TextFieldImplementation,\n  type ValidatedTextFieldImplementation,\n  useTextField,\n} from \"./useTextField.js\";\n\nconst noop = (): void => {\n  // do nothing\n};\n\n/** @since 2.5.0 */\nexport interface NumberFieldConstraints {\n  /**\n   * An optional min value for the number field.\n   */\n  min?: number;\n\n  /**\n   * An optional max value for the number field.\n   */\n  max?: number;\n\n  /**\n   * An optional step amount to use.\n   *\n   * Note: The `min` and `max` values must be divisible by this value when any\n   * are defined.\n   */\n  step?: number;\n}\n\n/**\n * @since 2.5.0\n * @since 6.0.0\n * - Removed `updateOnChange` in favor of `updateValue`\n * - Renamed `fixOnBlur` to `updateValueOnBlur`\n */\nexport interface NumberFieldHookOptions\n  extends Omit<\n      TextFieldHookOptions<HTMLInputElement>,\n      \"defaultValue\" | \"isNumber\"\n    >,\n    NumberFieldConstraints {\n  /**\n   * @defaultValue `undefined`\n   */\n  defaultValue?: UseStateInitializer<number>;\n\n  /**\n   * This controls the behavior for the `value` returned by this hook. If you\n   * need access to the current value immediately as the user types to update\n   * other components, keep this as the default of `\"change\"`. Otherwise, set\n   * this to `\"blur\"`.\n   *\n   * @example Deferring Updates on Blur\n   * ```tsx\n   * import { TextField } from \"@react-md/core/form/TextField\";\n   * import { useNumberField } from \"@react-md/core/form/useNumberField\";\n   * import type { ReactElement } from \"react\";\n   *\n   * function Example(): ReactElement {\n   *   const { fieldProps, value } = useNumberField({\n   *     min: 0,\n   *     max: 100,\n   *     name: \"someName\",\n   *     defaultValue: 0,\n   *     updateValue: \"blur\",\n   *   });\n   *\n   *   const result = useMemo(() => someExpensiveComputation(value), [value]);\n   *\n   *   return <TextField {...fieldProps} label=\"Label\" />;\n   * }\n   * ```\n   *\n   * @defaultValue `\"change\"`\n   */\n  updateValue?: \"blur\" | \"change\";\n\n  /**\n   * This option is used to update the `number` value and text field value to be\n   * within the `min` and `max` range or just format the text field value when\n   * the input is blurred. This update will only be applied if the text field\n   * contains a valid number. Using `min = 0` and `max = 10`:\n   *\n   * | text value | updated value |\n   * | ---------- | ------------- |\n   * | 000001     | 1             |\n   * | -1         | 0             |\n   * | 20         | 10            |\n   * | -12        | 0             |\n   * | --1        | --1           |\n   * | fjdka      | fjdka         |\n   *\n   *\n   * Set this to `false` if no changed should be applied and force the user to\n   * fix any min/max errors manually and maintain weird formatting.\n   *\n   * @defaultValue `true`\n   * @since 6.0.0 This was renamed from `fixOnBlur` and removed the\n   * `\"min\"` and `\"max\"` behavior.\n   */\n  updateValueOnBlur?: boolean;\n}\n\n/** @since 6.0.0 */\nexport interface NumberFieldHookState\n  extends Omit<TextFieldHookState, \"value\"> {\n  value: number | undefined;\n}\n\n/** @since 2.5.6 */\nexport interface ProvidedNumberFieldProps\n  extends ProvidedTextFieldProps<HTMLInputElement>,\n    NumberFieldConstraints {\n  type: \"number\";\n}\n\n/** @since 2.5.6 */\nexport interface ProvidedNumberFieldMessageProps\n  extends ProvidedTextFieldMessageProps<HTMLInputElement>,\n    NumberFieldConstraints {\n  type: \"number\";\n}\n\n/** @since 6.0.0 */\nexport interface NumberFieldImplementation\n  extends Omit<\n    TextFieldImplementation<HTMLInputElement>,\n    \"value\" | \"setState\"\n  > {\n  value: number | undefined;\n  setState: UseStateSetter<NumberFieldHookState>;\n  fieldProps: ProvidedNumberFieldProps;\n}\n\n/** @since 6.0.0 */\nexport interface NumberFieldWithMessageImplementation\n  extends NumberFieldImplementation {\n  fieldProps: ProvidedNumberFieldMessageProps;\n}\n\n/** @since 6.0.0 */\nexport interface ValidatedNumberFieldImplementation\n  extends Omit<\n    ValidatedTextFieldImplementation<HTMLInputElement>,\n    \"value\" | \"setState\"\n  > {\n  value: number | undefined;\n  setState: UseStateSetter<NumberFieldHookState>;\n  fieldProps: ProvidedNumberFieldProps | ProvidedNumberFieldMessageProps;\n}\n\n/**\n * @example Enforce Number Value and No Error Messages\n * ```tsx\n * import { TextField } from \"@react-md/core/form/TextField\";\n * import { useNumberField } from \"@react-md/core/form/useNumberField\";\n * import type { ReactElement } from \"react\";\n *\n * function Example(): ReactElement {\n *   const { fieldProps, value } = useNumberField({\n *     min: 0,\n *     max: 100,\n *     name: \"someName\",\n *     defaultValue: 0,\n *     disableMessage: true,\n *   });\n *\n *   // this is safe since `value` will always be a number even if there is a\n *   // validation error. since the min and max options were provided as well,\n *   // number will be between that range as well.\n *   const computed = value * 10;\n *\n *   return <TextField {...fieldProps} label=\"Label\" />;\n * }\n * ```\n *\n * @see {@link useTextField}\n * @see {@link useNumberField} overrides for other examples.\n * ```\n */\nexport function useNumberField(\n  options: NumberFieldHookOptions & {\n    disableMessage: true;\n    defaultValue: UseStateInitializer<number>;\n  }\n): NumberFieldImplementation & {\n  value: number;\n  setState: UseStateSetter<NumberFieldHookState & { value: number }>;\n};\n\n/**\n * @example No Error Messages\n * ```tsx\n * import { TextField } from \"@react-md/core/form/TextField\";\n * import { useNumberField } from \"@react-md/core/form/useNumberField\";\n * import type { ReactElement } from \"react\";\n *\n * function Example(): ReactElement {\n *   const { fieldProps, value } = useNumberField({\n *     min: 0,\n *     max: 100,\n *     name: \"someName\",\n *     disableMessage: true,\n *   });\n *\n *   // `value` will be `undefined` until the user enters a valid value once\n *   // there is a valid value, `value` will be a `number`. So this might cause\n *   // `computed` to be `NaN | number`\n *   //\n *   // const computed = value * 10;\n *\n *   return <TextField {...fieldProps} label=\"Label\" />;\n * }\n * ```\n *\n * @see {@link useTextField}\n * @see {@link useNumberField} overrides for other examples.\n */\nexport function useNumberField(\n  options: NumberFieldHookOptions & { disableMessage: true }\n): NumberFieldImplementation;\n\n/**\n * @example Enforce Number Value\n * ```tsx\n * import { TextField } from \"@react-md/core/form/TextField\";\n * import { useNumberField } from \"@react-md/core/form/useNumberField\";\n * import type { ReactElement } from \"react\";\n *\n * function Example(): ReactElement {\n *   const { fieldProps, value } = useNumberField({\n *     min: 0,\n *     max: 100,\n *     name: \"someName\",\n *     defaultValue: 0,\n *   });\n *\n *   // this is safe since `value` will always be a number even if there is a\n *   // validation error. since the min and max options were provided as well,\n *   // number will be between that range as well.\n *   const computed = value * 10;\n *\n *   return <TextField {...fieldProps} label=\"Label\" />;\n * }\n * ```\n *\n * @example Enforce Number Value and Deferring Updates\n * ```tsx\n * import { TextField } from \"@react-md/core/form/TextField\";\n * import { useNumberField } from \"@react-md/core/form/useNumberField\";\n * import type { ReactElement } from \"react\";\n *\n * function Example(): ReactElement {\n *   const { fieldProps, value } = useNumberField({\n *     min: 0,\n *     max: 100,\n *     name: \"someName\",\n *     defaultValue: 0,\n *     updateValue: \"blur\",\n *   });\n *\n *   // the `value` will only be updated whenever the `TextField` is blurred.\n *   // This is helpful if the `value` is used in expensive computations or\n *   // updates that do not need to be updated as the user types\n *   const computed = value * 10;\n *\n *   return <TextField {...fieldProps} label=\"Label\" />;\n * }\n * ```\n *\n * @see {@link useTextField}\n * @see {@link useNumberField} overrides for other examples.\n */\nexport function useNumberField(\n  options: NumberFieldHookOptions & {\n    defaultValue: UseStateInitializer<number>;\n  }\n): NumberFieldWithMessageImplementation & {\n  value: number;\n  setState: UseStateSetter<NumberFieldHookState & { value: number }>;\n};\n\n/**\n * The `useNumberField` hook is used to control the state of a `TextField` or\n * `<input type=\"number\">`\n *\n * @example Default Implementation\n * ```tsx\n * import { TextField } from \"@react-md/core/form/TextField\";\n * import { useNumberField } from \"@react-md/core/form/useNumberField\";\n * import type { ReactElement } from \"react\";\n *\n * function Example(): ReactElement {\n *   const { fieldProps, value } = useNumberField({\n *     name: \"someName\",\n *   });\n *\n *   // `value` will be `undefined` until the user enters a valid value once\n *   // there is a valid value, `value` will be a `number`. So this might cause\n *   // `computed` to be `NaN | number`\n *   //\n *   // const computed = value * 10;\n *\n *   // whenever there is an error, an error message will be displayed below the\n *   // `TextField`\n *   return <TextField {...fieldProps} label=\"Label\" />;\n * }\n * ```\n *\n * @example Adding Constraints\n * ```tsx\n * import { TextField } from \"@react-md/core/form/TextField\";\n * import { useNumberField } from \"@react-md/core/form/useNumberField\";\n * import type { ReactElement } from \"react\";\n *\n * function Example(): ReactElement {\n *   const { fieldProps, value } = useNumberField({\n *     name: \"someName\",\n *     min: 0,\n *     max: 100,\n *     step: 2,\n *     required: true,\n *   });\n *\n *   return <TextField {...fieldProps} label=\"Label\" />;\n * }\n * ```\n *\n * @see https://developer.mozilla.org/en-US/docs/Web/Guide/HTML/HTML5/Constraint_validation\n * @see {@link https://next.react-md.dev/components/text-field#number | Number TextField Demos}\n * @see {@link https://next.react-md.dev/hooks/use-number-field | useNumberField Demos}\n * @see {@link useTextField}\n */\nexport function useNumberField(\n  options: NumberFieldHookOptions\n): NumberFieldWithMessageImplementation;\n\n/**\n * @internal\n * @see {@link https://next.react-md.dev/components/text-field#number | Number TextField Demos}\n * @see {@link https://next.react-md.dev/hooks/use-number-field | useNumberField Demos}\n * @see {@link useTextField}\n * @see {@link useNumberField} overrides for other examples.\n */\nexport function useNumberField(\n  options: NumberFieldHookOptions\n): ValidatedNumberFieldImplementation {\n  const {\n    min,\n    max,\n    step,\n    onBlur = noop,\n    onChange = noop,\n    updateValue = \"change\",\n    updateValueOnBlur = true,\n    defaultValue,\n    ...textOptions\n  } = options;\n\n  const [number, setNumber] = useState(defaultValue);\n  const initial = useRef(number);\n  const {\n    value: _value,\n    reset: resetTextField,\n    fieldProps,\n    setState: setTextFieldState,\n    ...remaining\n  } = useTextField({\n    ...textOptions,\n    isNumber: true,\n    defaultValue: `${number ?? \"\"}`,\n    onBlur(event) {\n      onBlur(event);\n      if (event.isPropagationStopped()) {\n        return;\n      }\n\n      const input = event.currentTarget;\n      input.setCustomValidity(\"\");\n      input.checkValidity();\n      if (\n        !updateValueOnBlur ||\n        // do nothing else since it's a weird value like: `\"--0\"` which causes\n        // the value to be `\"\"` and `numberAsValue` to be `NaN`\n        input.validity.badInput\n      ) {\n        return;\n      }\n\n      let value = input.valueAsNumber;\n      if (input.value === \"\" && typeof initial.current === \"number\") {\n        value = min ?? initial.current;\n      }\n\n      // can't have both rangeUnderflow and rangeOverflow at the same time, so\n      // it's \"safe\" to always provide both\n      value = withinRange({ min, max, value });\n      if (!Number.isNaN(value)) {\n        setNumber(value);\n        input.value = `${value}`;\n      } else if (typeof initial.current === \"undefined\") {\n        setNumber(undefined);\n      }\n    },\n    onChange(event) {\n      onChange(event);\n      if (event.isPropagationStopped() || updateValue === \"blur\") {\n        return;\n      }\n\n      const input = event.currentTarget;\n      input.checkValidity();\n      const value = withinRange({\n        min,\n        max,\n        value: event.currentTarget.valueAsNumber,\n      });\n      if (\n        !input.validity.valid &&\n        !input.validity.rangeUnderflow &&\n        !input.validity.rangeOverflow\n      ) {\n        return;\n      }\n\n      if (!Number.isNaN(value)) {\n        setNumber(value);\n      } else if (initial.current === undefined) {\n        setNumber(undefined);\n      }\n    },\n  });\n\n  const reset = useCallback(() => {\n    resetTextField();\n    setNumber(initial.current);\n  }, [resetTextField]);\n  const setState = useCallback<UseStateSetter<NumberFieldHookState>>(\n    (nextState) => {\n      if (typeof nextState === \"function\") {\n        setNumber((prevNumber) => {\n          let nextNumber: number | undefined = prevNumber;\n          setTextFieldState((prevState) => {\n            const updated = nextState({\n              ...prevState,\n              value: prevNumber,\n            });\n\n            nextNumber = updated.value;\n\n            return {\n              ...updated,\n              value: `${nextNumber ?? \"\"}`,\n            };\n          });\n\n          return nextNumber;\n        });\n        return;\n      }\n\n      const { value, error, errorMessage } = nextState;\n      setNumber(value);\n      setTextFieldState({\n        value: `${value ?? \"\"}`,\n        error,\n        errorMessage,\n      });\n    },\n    [setTextFieldState]\n  );\n\n  return {\n    ...remaining,\n    reset,\n    value: number,\n    setState,\n    fieldProps: {\n      ...fieldProps,\n      min,\n      max,\n      step,\n      type: \"number\",\n    },\n  };\n}\n"],"names":["useCallback","useRef","useState","withinRange","useTextField","noop","useNumberField","options","min","max","step","onBlur","onChange","updateValue","updateValueOnBlur","defaultValue","textOptions","number","setNumber","initial","value","_value","reset","resetTextField","fieldProps","setState","setTextFieldState","remaining","isNumber","event","isPropagationStopped","input","currentTarget","setCustomValidity","checkValidity","validity","badInput","valueAsNumber","current","Number","isNaN","undefined","valid","rangeUnderflow","rangeOverflow","nextState","prevNumber","nextNumber","prevState","updated","error","errorMessage","type"],"mappings":"AAAA;AAEA,SAASA,WAAW,EAAEC,MAAM,EAAEC,QAAQ,QAAQ,QAAQ;AAGtD,SAASC,WAAW,QAAQ,0BAA0B;AACtD,SAOEC,YAAY,QACP,oBAAoB;AAE3B,MAAMC,OAAO;AACX,aAAa;AACf;AA2UA;;;;;;CAMC,GACD,OAAO,SAASC,eACdC,OAA+B;IAE/B,MAAM,EACJC,GAAG,EACHC,GAAG,EACHC,IAAI,EACJC,SAASN,IAAI,EACbO,WAAWP,IAAI,EACfQ,cAAc,QAAQ,EACtBC,oBAAoB,IAAI,EACxBC,YAAY,EACZ,GAAGC,aACJ,GAAGT;IAEJ,MAAM,CAACU,QAAQC,UAAU,GAAGhB,SAASa;IACrC,MAAMI,UAAUlB,OAAOgB;IACvB,MAAM,EACJG,OAAOC,MAAM,EACbC,OAAOC,cAAc,EACrBC,UAAU,EACVC,UAAUC,iBAAiB,EAC3B,GAAGC,WACJ,GAAGvB,aAAa;QACf,GAAGY,WAAW;QACdY,UAAU;QACVb,cAAc,GAAGE,UAAU,IAAI;QAC/BN,QAAOkB,KAAK;YACVlB,OAAOkB;YACP,IAAIA,MAAMC,oBAAoB,IAAI;gBAChC;YACF;YAEA,MAAMC,QAAQF,MAAMG,aAAa;YACjCD,MAAME,iBAAiB,CAAC;YACxBF,MAAMG,aAAa;YACnB,IACE,CAACpB,qBACD,sEAAsE;YACtE,uDAAuD;YACvDiB,MAAMI,QAAQ,CAACC,QAAQ,EACvB;gBACA;YACF;YAEA,IAAIhB,QAAQW,MAAMM,aAAa;YAC/B,IAAIN,MAAMX,KAAK,KAAK,MAAM,OAAOD,QAAQmB,OAAO,KAAK,UAAU;gBAC7DlB,QAAQZ,OAAOW,QAAQmB,OAAO;YAChC;YAEA,wEAAwE;YACxE,qCAAqC;YACrClB,QAAQjB,YAAY;gBAAEK;gBAAKC;gBAAKW;YAAM;YACtC,IAAI,CAACmB,OAAOC,KAAK,CAACpB,QAAQ;gBACxBF,UAAUE;gBACVW,MAAMX,KAAK,GAAG,GAAGA,OAAO;YAC1B,OAAO,IAAI,OAAOD,QAAQmB,OAAO,KAAK,aAAa;gBACjDpB,UAAUuB;YACZ;QACF;QACA7B,UAASiB,KAAK;YACZjB,SAASiB;YACT,IAAIA,MAAMC,oBAAoB,MAAMjB,gBAAgB,QAAQ;gBAC1D;YACF;YAEA,MAAMkB,QAAQF,MAAMG,aAAa;YACjCD,MAAMG,aAAa;YACnB,MAAMd,QAAQjB,YAAY;gBACxBK;gBACAC;gBACAW,OAAOS,MAAMG,aAAa,CAACK,aAAa;YAC1C;YACA,IACE,CAACN,MAAMI,QAAQ,CAACO,KAAK,IACrB,CAACX,MAAMI,QAAQ,CAACQ,cAAc,IAC9B,CAACZ,MAAMI,QAAQ,CAACS,aAAa,EAC7B;gBACA;YACF;YAEA,IAAI,CAACL,OAAOC,KAAK,CAACpB,QAAQ;gBACxBF,UAAUE;YACZ,OAAO,IAAID,QAAQmB,OAAO,KAAKG,WAAW;gBACxCvB,UAAUuB;YACZ;QACF;IACF;IAEA,MAAMnB,QAAQtB,YAAY;QACxBuB;QACAL,UAAUC,QAAQmB,OAAO;IAC3B,GAAG;QAACf;KAAe;IACnB,MAAME,WAAWzB,YACf,CAAC6C;QACC,IAAI,OAAOA,cAAc,YAAY;YACnC3B,UAAU,CAAC4B;gBACT,IAAIC,aAAiCD;gBACrCpB,kBAAkB,CAACsB;oBACjB,MAAMC,UAAUJ,UAAU;wBACxB,GAAGG,SAAS;wBACZ5B,OAAO0B;oBACT;oBAEAC,aAAaE,QAAQ7B,KAAK;oBAE1B,OAAO;wBACL,GAAG6B,OAAO;wBACV7B,OAAO,GAAG2B,cAAc,IAAI;oBAC9B;gBACF;gBAEA,OAAOA;YACT;YACA;QACF;QAEA,MAAM,EAAE3B,KAAK,EAAE8B,KAAK,EAAEC,YAAY,EAAE,GAAGN;QACvC3B,UAAUE;QACVM,kBAAkB;YAChBN,OAAO,GAAGA,SAAS,IAAI;YACvB8B;YACAC;QACF;IACF,GACA;QAACzB;KAAkB;IAGrB,OAAO;QACL,GAAGC,SAAS;QACZL;QACAF,OAAOH;QACPQ;QACAD,YAAY;YACV,GAAGA,UAAU;YACbhB;YACAC;YACAC;YACA0C,MAAM;QACR;IACF;AACF"}

package/dist/form/useRadioGroup.d.ts

@@ -1,6 +1,6 @@
 import { type ChangeEventHandler, type FormEventHandler } from "react";
 import { type UseStateInitializer, type UseStateSetter } from "../types.js";
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface RadioGroupOptions<T extends string | number> {
     /**
      * A `name` to apply to all the radios within the group. This is required if
@@ -34,7 +34,7 @@ export interface RadioGroupOptions<T extends string | number> {
     required?: boolean;
     /**
      * If you need to prevent the default behavior in a radio group for some
-     * reason, you can provide a custom `onCHange` event handler and call
+     * reason, you can provide a custom `onChange` event handler and call
      * `event.stopPropagation()`. This will be called whenever a new radio button
      * is checked.
      *
@@ -55,7 +55,7 @@ export interface RadioGroupOptions<T extends string | number> {
      */
     onInvalid?: FormEventHandler<HTMLInputElement>;
 }
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface ProvidedRadioGroupProps<V extends string | number> {
     name: string;
     value: V;
@@ -65,45 +65,44 @@ export interface ProvidedRadioGroupProps<V extends string | number> {
     required: boolean;
     onInvalid: FormEventHandler<HTMLInputElement>;
 }
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export type GetRadioGroupProps<V extends string | number> = (value: V) => Readonly<ProvidedRadioGroupProps<V>>;
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface RadioGroupImplementation<V extends string | number> {
-    reset(): void;
+    reset: () => void;
     value: V;
     setValue: UseStateSetter<V>;
     getRadioProps: GetRadioGroupProps<V>;
 }
 export type GetMenuItemRadioGroupProps<V extends string | number> = (value: V) => Readonly<{
     checked: boolean;
-    onCheckedChange(): void;
+    onCheckedChange: () => void;
 }>;
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface MenuItemRadioGroupImplementation<V extends string | number> {
-    reset(): void;
+    reset: () => void;
     value: V;
     setValue: UseStateSetter<V>;
     getRadioProps: GetMenuItemRadioGroupProps<V>;
 }
-/** @remarks \@since 6.0.0 */
+/** @since 6.0.0 */
 export interface CombinedRadioGroupReturnValue<V extends string | number> {
-    reset(): void;
+    reset: () => void;
     value: V;
     setValue: UseStateSetter<V>;
-    getRadioProps?(value: V): {
+    getRadioProps: (value: V) => {
         name?: string;
         value?: V;
         checked: boolean;
         error?: boolean;
         required?: boolean;
         onChange?: ChangeEventHandler<HTMLInputElement>;
-        onCheckedChange?(): void;
+        onCheckedChange?: () => void;
         onInvalid?: FormEventHandler<HTMLInputElement>;
     };
 }
 /**
- * @example
- * Generic Number Example
+ * @example Generic Number Example
  * ```tsx
  * const { value, getRadioProps } = useRadioGroup<number>({
  *   name: "group",
@@ -119,7 +118,10 @@ export interface CombinedRadioGroupReturnValue<V extends string | number> {
  *   </>
  * );
  * ```
- * @remarks \@since 6.0.0
+ *
+ * @see {@link https://next.react-md.dev/components/radio | Radio Demos}
+ * @see {@link https://next.react-md.dev/hooks/use-radio-group | useRadioGroup Demos}
+ * @since 6.0.0
  */
 export declare function useRadioGroup<V extends number>(options: RadioGroupOptions<V> & {
     menu?: false;
@@ -135,8 +137,7 @@ export declare function useRadioGroup<V extends number>(options: RadioGroupOptio
     defaultValue: UseStateInitializer<V>;
 }): MenuItemRadioGroupImplementation<V>;
 /**
- * @example
- * Generic String Example
+ * @example Generic String Example
  * ```tsx
  * const { value, getRadioProps } = useRadioGroup({ name: "group" });
  *
@@ -149,8 +150,7 @@ export declare function useRadioGroup<V extends number>(options: RadioGroupOptio
  * );
  * ```
  *
- * @example
- * String Union Example
+ * @example String Union Example
  * ```tsx
  * const values = [
  *   { label: "First", value: "a" },
@@ -175,7 +175,10 @@ export declare function useRadioGroup<V extends number>(options: RadioGroupOptio
  *   </>
  * );
  * ```
- * @remarks \@since 6.0.0
+ *
+ * @see {@link https://next.react-md.dev/components/radio | Radio Demos}
+ * @see {@link https://next.react-md.dev/hooks/use-radio-group | useRadioGroup Demos}
+ * @since 6.0.0
  */
 export declare function useRadioGroup<V extends string>(options: RadioGroupOptions<V> & {
     menu?: false;

package/dist/form/useRadioGroup.js

@@ -4,8 +4,7 @@ const noop = ()=>{
 // do nothing
 };
 /**
- * @example
- * Strict Union Example
+ * @example Strict Union Example
  * ```tsx
  * type ValidValues = 1 | 2 | 3 | 4 | "" | "a" | "b";
  *
@@ -27,7 +26,10 @@ const noop = ()=>{
  *   </>
  * );
  * ```
- * @remarks \@since 6.0.0
+ *
+ * @see {@link https://next.react-md.dev/components/radio | Radio Demos}
+ * @see {@link https://next.react-md.dev/hooks/use-radio-group | useRadioGroup Demos}
+ * @since 6.0.0
  */ export function useRadioGroup(options) {
     const { name, defaultValue, menu = false, required, onChange = noop, onInvalid = noop } = options;
     const [value, setValue] = useState(()=>{

package/dist/form/useRadioGroup.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/form/useRadioGroup.ts"],"sourcesContent":["\"use client\";\nimport {\n  useCallback,\n  useRef,\n  useState,\n  type ChangeEventHandler,\n  type FormEventHandler,\n} from \"react\";\nimport { type UseStateInitializer, type UseStateSetter } from \"../types.js\";\n\nconst noop = (): void => {\n  // do nothing\n};\n\n/** @remarks \\@since 6.0.0 */\nexport interface RadioGroupOptions<T extends string | number> {\n  /**\n   * A `name` to apply to all the radios within the group. This is required if\n   * unless {@link menu} is set to `true`.\n   */\n  name?: string;\n\n  /**\n   * Set this to `true` if using the `MenuItemRadio` component instead of the\n   * `Radio` so the correct props can be provided.\n   *\n   * @defaultValue `false`\n   */\n  menu?: boolean;\n\n  /**\n   * The value of a radio that should be checked by default. If you want to\n   * force the user to select one of the radios, keep this as the empty string\n   * or set it to a string or number that does not represent a valid radio\n   * value.\n   *\n   * @defaultValue `\"\"`\n   */\n  defaultValue?: UseStateInitializer<T>;\n\n  /**\n   * Set this to `true` if one of the radios within the group must be checked before\n   * a form can be submitted.\n   *\n   * This option is invalid and will be ignored if {@link menu} is `true`.\n   *\n   * @defaultValue `false`\n   */\n  required?: boolean;\n\n  /**\n   * If you need to prevent the default behavior in a radio group for some\n   * reason, you can provide a custom `onCHange` event handler and call\n   * `event.stopPropagation()`. This will be called whenever a new radio button\n   * is checked.\n   *\n   * This option is invalid and will be ignored if {@link menu} is `true`.\n   *\n   * @defaultValue `() => {}`\n   */\n  onChange?: ChangeEventHandler<HTMLInputElement>;\n\n  /**\n   * If the radio group has {@link required} set to `true`, the radios will gain\n   * the `error` state if a form is submitted without a checked radio. If you\n   * want to prevent that behavior for some reason, you can provide this\n   * function and call `event.stopPropagation()`.\n   *\n   * This option is invalid and will be ignored if {@link menu} is `true`.\n   *\n   * @defaultValue `() => {}`\n   */\n  onInvalid?: FormEventHandler<HTMLInputElement>;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport interface ProvidedRadioGroupProps<V extends string | number> {\n  name: string;\n  value: V;\n  checked: boolean;\n  onChange: ChangeEventHandler<HTMLInputElement>;\n  error: boolean;\n  required: boolean;\n  onInvalid: FormEventHandler<HTMLInputElement>;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport type GetRadioGroupProps<V extends string | number> = (\n  value: V\n) => Readonly<ProvidedRadioGroupProps<V>>;\n\n/** @remarks \\@since 6.0.0 */\nexport interface RadioGroupImplementation<V extends string | number> {\n  reset(): void;\n  value: V;\n  setValue: UseStateSetter<V>;\n  getRadioProps: GetRadioGroupProps<V>;\n}\n\nexport type GetMenuItemRadioGroupProps<V extends string | number> = (\n  value: V\n) => Readonly<{ checked: boolean; onCheckedChange(): void }>;\n\n/** @remarks \\@since 6.0.0 */\nexport interface MenuItemRadioGroupImplementation<V extends string | number> {\n  reset(): void;\n  value: V;\n  setValue: UseStateSetter<V>;\n  getRadioProps: GetMenuItemRadioGroupProps<V>;\n}\n\n/** @remarks \\@since 6.0.0 */\nexport interface CombinedRadioGroupReturnValue<V extends string | number> {\n  reset(): void;\n  value: V;\n  setValue: UseStateSetter<V>;\n  getRadioProps?(value: V): {\n    name?: string;\n    value?: V;\n    checked: boolean;\n    error?: boolean;\n    required?: boolean;\n    onChange?: ChangeEventHandler<HTMLInputElement>;\n    onCheckedChange?(): void;\n    onInvalid?: FormEventHandler<HTMLInputElement>;\n  };\n}\n\n// Note: These overrides are set up so that the value will default to any\n// string.\n\n/**\n * @example\n * Generic Number Example\n * ```tsx\n * const { value, getRadioProps } = useRadioGroup<number>({\n *   name: \"group\",\n *   defaultValue: -1\n * });\n *\n *\n * return (\n *   <>\n *     <Radio {...getRadioProps(0)} label=\"First\" />\n *     <Radio {...getRadioProps(1)} label=\"Second\" />\n *     <Radio {...getRadioProps(2)} label=\"Third\" />\n *   </>\n * );\n * ```\n * @remarks \\@since 6.0.0\n */\nexport function useRadioGroup<V extends number>(\n  options: RadioGroupOptions<V> & {\n    menu?: false;\n    name: string;\n    defaultValue: UseStateInitializer<V>;\n  }\n): RadioGroupImplementation<V>;\nexport function useRadioGroup<V extends number>(\n  options: RadioGroupOptions<V> & {\n    menu: true;\n    name?: never;\n    required?: never;\n    onChange?: never;\n    onInvalid?: never;\n    defaultValue: UseStateInitializer<V>;\n  }\n): MenuItemRadioGroupImplementation<V>;\n/**\n * @example\n * Generic String Example\n * ```tsx\n * const { value, getRadioProps } = useRadioGroup({ name: \"group\" });\n *\n * return (\n *   <>\n *     <Radio {...getRadioProps(\"a\")} label=\"First\" />\n *     <Radio {...getRadioProps(\"b\")} label=\"Second\" />\n *     <Radio {...getRadioProps(\"c\")} label=\"Third\" />\n *   </>\n * );\n * ```\n *\n * @example\n * String Union Example\n * ```tsx\n * const values = [\n *   { label: \"First\", value: \"a\" },\n *   { label: \"Second\", value: \"b\" },\n *   { label: \"Third\", value: \"c\" },\n * ] as const;\n *\n * type Values = typeof values[number][\"value\"];\n * //   ^ \"a\" | \"b\" | \"c\"\n *\n * const { value, getRadioProps } = useRadioGroup<Values | \"\">({\n *   name: \"group\",\n *   defaultValue: \"\",\n * });\n *\n *\n * return (\n *   <>\n *     {values.map(({ label, value }) => (\n *       <Radio {...getRadioProps(value)} key={value} label={label} />\n *     ))}\n *   </>\n * );\n * ```\n * @remarks \\@since 6.0.0\n */\nexport function useRadioGroup<V extends string>(\n  options: RadioGroupOptions<V> & {\n    menu?: false;\n    name: string;\n    defaultValue?: UseStateInitializer<V>;\n  }\n): RadioGroupImplementation<V>;\nexport function useRadioGroup<V extends string>(\n  options: RadioGroupOptions<V> & {\n    menu: true;\n    name?: never;\n    required?: never;\n    onChange?: never;\n    onInvalid?: never;\n    defaultValue?: UseStateInitializer<V>;\n  }\n): MenuItemRadioGroupImplementation<V>;\n/**\n * @example\n * Strict Union Example\n * ```tsx\n * type ValidValues = 1 | 2 | 3 | 4 | \"\" | \"a\" | \"b\";\n *\n * const { value, getRadioProps } = useRadioGroup<ValidValues>({\n *   name: \"group\",\n *   defaultValue: \"\"\n * });\n *\n *\n * return (\n *   <>\n *     <Radio {...getRadioProps(1)} label=\"First\" />\n *     <Radio {...getRadioProps(2)} label=\"Second\" />\n *     <Radio {...getRadioProps(3)} label=\"Third\" />\n *     <Radio {...getRadioProps(4)} label=\"Forth\" />\n *     <Radio {...getRadioProps(\"a\")} label=\"Fifth\" />\n *     <Radio {...getRadioProps(\"b\")} label=\"Sixth\" />\n *     <Radio {...getRadioProps(\"c\")} label=\"Seventh\" />\n *   </>\n * );\n * ```\n * @remarks \\@since 6.0.0\n */\nexport function useRadioGroup<V extends string | number>(\n  options: RadioGroupOptions<V>\n): CombinedRadioGroupReturnValue<V> {\n  const {\n    name,\n    defaultValue,\n    menu = false,\n    required,\n    onChange = noop,\n    onInvalid = noop,\n  } = options;\n  const [value, setValue] = useState<V>(() => {\n    if (typeof defaultValue === \"function\") {\n      return defaultValue();\n    }\n\n    return defaultValue ?? (\"\" as V);\n  });\n  const initial = useRef(value);\n  const [error, setError] = useState(false);\n\n  return {\n    reset: useCallback(() => {\n      setError(false);\n      setValue(initial.current);\n    }, []),\n    value,\n    setValue,\n    getRadioProps(radioValue) {\n      const checked = value === radioValue;\n      if (menu) {\n        return {\n          checked,\n          onCheckedChange() {\n            setValue(radioValue);\n          },\n        };\n      }\n\n      return {\n        name,\n        value: radioValue,\n        error,\n        checked,\n        required,\n        onChange(event) {\n          onChange(event);\n          setError(false);\n          setValue(radioValue);\n        },\n        onInvalid(event) {\n          onInvalid(event);\n          setError(true);\n        },\n      };\n    },\n  };\n}\n"],"names":["useCallback","useRef","useState","noop","useRadioGroup","options","name","defaultValue","menu","required","onChange","onInvalid","value","setValue","initial","error","setError","reset","current","getRadioProps","radioValue","checked","onCheckedChange","event"],"mappings":"AAAA;AACA,SACEA,WAAW,EACXC,MAAM,EACNC,QAAQ,QAGH,QAAQ;AAGf,MAAMC,OAAO;AACX,aAAa;AACf;AAwNA;;;;;;;;;;;;;;;;;;;;;;;;;CAyBC,GACD,OAAO,SAASC,cACdC,OAA6B;IAE7B,MAAM,EACJC,IAAI,EACJC,YAAY,EACZC,OAAO,KAAK,EACZC,QAAQ,EACRC,WAAWP,IAAI,EACfQ,YAAYR,IAAI,EACjB,GAAGE;IACJ,MAAM,CAACO,OAAOC,SAAS,GAAGX,SAAY;QACpC,IAAI,OAAOK,iBAAiB,YAAY;YACtC,OAAOA;QACT;QAEA,OAAOA,gBAAiB;IAC1B;IACA,MAAMO,UAAUb,OAAOW;IACvB,MAAM,CAACG,OAAOC,SAAS,GAAGd,SAAS;IAEnC,OAAO;QACLe,OAAOjB,YAAY;YACjBgB,SAAS;YACTH,SAASC,QAAQI,OAAO;QAC1B,GAAG,EAAE;QACLN;QACAC;QACAM,eAAcC,UAAU;YACtB,MAAMC,UAAUT,UAAUQ;YAC1B,IAAIZ,MAAM;gBACR,OAAO;oBACLa;oBACAC;wBACET,SAASO;oBACX;gBACF;YACF;YAEA,OAAO;gBACLd;gBACAM,OAAOQ;gBACPL;gBACAM;gBACAZ;gBACAC,UAASa,KAAK;oBACZb,SAASa;oBACTP,SAAS;oBACTH,SAASO;gBACX;gBACAT,WAAUY,KAAK;oBACbZ,UAAUY;oBACVP,SAAS;gBACX;YACF;QACF;IACF;AACF"}
+{"version":3,"sources":["../../src/form/useRadioGroup.ts"],"sourcesContent":["\"use client\";\n\nimport {\n  type ChangeEventHandler,\n  type FormEventHandler,\n  useCallback,\n  useRef,\n  useState,\n} from \"react\";\n\nimport { type UseStateInitializer, type UseStateSetter } from \"../types.js\";\n\nconst noop = (): void => {\n  // do nothing\n};\n\n/** @since 6.0.0 */\nexport interface RadioGroupOptions<T extends string | number> {\n  /**\n   * A `name` to apply to all the radios within the group. This is required if\n   * unless {@link menu} is set to `true`.\n   */\n  name?: string;\n\n  /**\n   * Set this to `true` if using the `MenuItemRadio` component instead of the\n   * `Radio` so the correct props can be provided.\n   *\n   * @defaultValue `false`\n   */\n  menu?: boolean;\n\n  /**\n   * The value of a radio that should be checked by default. If you want to\n   * force the user to select one of the radios, keep this as the empty string\n   * or set it to a string or number that does not represent a valid radio\n   * value.\n   *\n   * @defaultValue `\"\"`\n   */\n  defaultValue?: UseStateInitializer<T>;\n\n  /**\n   * Set this to `true` if one of the radios within the group must be checked before\n   * a form can be submitted.\n   *\n   * This option is invalid and will be ignored if {@link menu} is `true`.\n   *\n   * @defaultValue `false`\n   */\n  required?: boolean;\n\n  /**\n   * If you need to prevent the default behavior in a radio group for some\n   * reason, you can provide a custom `onChange` event handler and call\n   * `event.stopPropagation()`. This will be called whenever a new radio button\n   * is checked.\n   *\n   * This option is invalid and will be ignored if {@link menu} is `true`.\n   *\n   * @defaultValue `() => {}`\n   */\n  onChange?: ChangeEventHandler<HTMLInputElement>;\n\n  /**\n   * If the radio group has {@link required} set to `true`, the radios will gain\n   * the `error` state if a form is submitted without a checked radio. If you\n   * want to prevent that behavior for some reason, you can provide this\n   * function and call `event.stopPropagation()`.\n   *\n   * This option is invalid and will be ignored if {@link menu} is `true`.\n   *\n   * @defaultValue `() => {}`\n   */\n  onInvalid?: FormEventHandler<HTMLInputElement>;\n}\n\n/** @since 6.0.0 */\nexport interface ProvidedRadioGroupProps<V extends string | number> {\n  name: string;\n  value: V;\n  checked: boolean;\n  onChange: ChangeEventHandler<HTMLInputElement>;\n  error: boolean;\n  required: boolean;\n  onInvalid: FormEventHandler<HTMLInputElement>;\n}\n\n/** @since 6.0.0 */\nexport type GetRadioGroupProps<V extends string | number> = (\n  value: V\n) => Readonly<ProvidedRadioGroupProps<V>>;\n\n/** @since 6.0.0 */\nexport interface RadioGroupImplementation<V extends string | number> {\n  reset: () => void;\n  value: V;\n  setValue: UseStateSetter<V>;\n  getRadioProps: GetRadioGroupProps<V>;\n}\n\nexport type GetMenuItemRadioGroupProps<V extends string | number> = (\n  value: V\n) => Readonly<{ checked: boolean; onCheckedChange: () => void }>;\n\n/** @since 6.0.0 */\nexport interface MenuItemRadioGroupImplementation<V extends string | number> {\n  reset: () => void;\n  value: V;\n  setValue: UseStateSetter<V>;\n  getRadioProps: GetMenuItemRadioGroupProps<V>;\n}\n\n/** @since 6.0.0 */\nexport interface CombinedRadioGroupReturnValue<V extends string | number> {\n  reset: () => void;\n  value: V;\n  setValue: UseStateSetter<V>;\n  getRadioProps: (value: V) => {\n    name?: string;\n    value?: V;\n    checked: boolean;\n    error?: boolean;\n    required?: boolean;\n    onChange?: ChangeEventHandler<HTMLInputElement>;\n    onCheckedChange?: () => void;\n    onInvalid?: FormEventHandler<HTMLInputElement>;\n  };\n}\n\n// Note: These overrides are set up so that the value will default to any\n// string.\n\n/**\n * @example Generic Number Example\n * ```tsx\n * const { value, getRadioProps } = useRadioGroup<number>({\n *   name: \"group\",\n *   defaultValue: -1\n * });\n *\n *\n * return (\n *   <>\n *     <Radio {...getRadioProps(0)} label=\"First\" />\n *     <Radio {...getRadioProps(1)} label=\"Second\" />\n *     <Radio {...getRadioProps(2)} label=\"Third\" />\n *   </>\n * );\n * ```\n *\n * @see {@link https://next.react-md.dev/components/radio | Radio Demos}\n * @see {@link https://next.react-md.dev/hooks/use-radio-group | useRadioGroup Demos}\n * @since 6.0.0\n */\nexport function useRadioGroup<V extends number>(\n  options: RadioGroupOptions<V> & {\n    menu?: false;\n    name: string;\n    defaultValue: UseStateInitializer<V>;\n  }\n): RadioGroupImplementation<V>;\nexport function useRadioGroup<V extends number>(\n  options: RadioGroupOptions<V> & {\n    menu: true;\n    name?: never;\n    required?: never;\n    onChange?: never;\n    onInvalid?: never;\n    defaultValue: UseStateInitializer<V>;\n  }\n): MenuItemRadioGroupImplementation<V>;\n/**\n * @example Generic String Example\n * ```tsx\n * const { value, getRadioProps } = useRadioGroup({ name: \"group\" });\n *\n * return (\n *   <>\n *     <Radio {...getRadioProps(\"a\")} label=\"First\" />\n *     <Radio {...getRadioProps(\"b\")} label=\"Second\" />\n *     <Radio {...getRadioProps(\"c\")} label=\"Third\" />\n *   </>\n * );\n * ```\n *\n * @example String Union Example\n * ```tsx\n * const values = [\n *   { label: \"First\", value: \"a\" },\n *   { label: \"Second\", value: \"b\" },\n *   { label: \"Third\", value: \"c\" },\n * ] as const;\n *\n * type Values = typeof values[number][\"value\"];\n * //   ^ \"a\" | \"b\" | \"c\"\n *\n * const { value, getRadioProps } = useRadioGroup<Values | \"\">({\n *   name: \"group\",\n *   defaultValue: \"\",\n * });\n *\n *\n * return (\n *   <>\n *     {values.map(({ label, value }) => (\n *       <Radio {...getRadioProps(value)} key={value} label={label} />\n *     ))}\n *   </>\n * );\n * ```\n *\n * @see {@link https://next.react-md.dev/components/radio | Radio Demos}\n * @see {@link https://next.react-md.dev/hooks/use-radio-group | useRadioGroup Demos}\n * @since 6.0.0\n */\nexport function useRadioGroup<V extends string>(\n  options: RadioGroupOptions<V> & {\n    menu?: false;\n    name: string;\n    defaultValue?: UseStateInitializer<V>;\n  }\n): RadioGroupImplementation<V>;\nexport function useRadioGroup<V extends string>(\n  options: RadioGroupOptions<V> & {\n    menu: true;\n    name?: never;\n    required?: never;\n    onChange?: never;\n    onInvalid?: never;\n    defaultValue?: UseStateInitializer<V>;\n  }\n): MenuItemRadioGroupImplementation<V>;\n/**\n * @example Strict Union Example\n * ```tsx\n * type ValidValues = 1 | 2 | 3 | 4 | \"\" | \"a\" | \"b\";\n *\n * const { value, getRadioProps } = useRadioGroup<ValidValues>({\n *   name: \"group\",\n *   defaultValue: \"\"\n * });\n *\n *\n * return (\n *   <>\n *     <Radio {...getRadioProps(1)} label=\"First\" />\n *     <Radio {...getRadioProps(2)} label=\"Second\" />\n *     <Radio {...getRadioProps(3)} label=\"Third\" />\n *     <Radio {...getRadioProps(4)} label=\"Forth\" />\n *     <Radio {...getRadioProps(\"a\")} label=\"Fifth\" />\n *     <Radio {...getRadioProps(\"b\")} label=\"Sixth\" />\n *     <Radio {...getRadioProps(\"c\")} label=\"Seventh\" />\n *   </>\n * );\n * ```\n *\n * @see {@link https://next.react-md.dev/components/radio | Radio Demos}\n * @see {@link https://next.react-md.dev/hooks/use-radio-group | useRadioGroup Demos}\n * @since 6.0.0\n */\nexport function useRadioGroup<V extends string | number>(\n  options: RadioGroupOptions<V>\n): CombinedRadioGroupReturnValue<V> {\n  const {\n    name,\n    defaultValue,\n    menu = false,\n    required,\n    onChange = noop,\n    onInvalid = noop,\n  } = options;\n  const [value, setValue] = useState<V>(() => {\n    if (typeof defaultValue === \"function\") {\n      return defaultValue();\n    }\n\n    return defaultValue ?? (\"\" as V);\n  });\n  const initial = useRef(value);\n  const [error, setError] = useState(false);\n\n  return {\n    reset: useCallback(() => {\n      setError(false);\n      setValue(initial.current);\n    }, []),\n    value,\n    setValue,\n    getRadioProps(radioValue) {\n      const checked = value === radioValue;\n      if (menu) {\n        return {\n          checked,\n          onCheckedChange() {\n            setValue(radioValue);\n          },\n        };\n      }\n\n      return {\n        name,\n        value: radioValue,\n        error,\n        checked,\n        required,\n        onChange(event) {\n          onChange(event);\n          setError(false);\n          setValue(radioValue);\n        },\n        onInvalid(event) {\n          onInvalid(event);\n          setError(true);\n        },\n      };\n    },\n  };\n}\n"],"names":["useCallback","useRef","useState","noop","useRadioGroup","options","name","defaultValue","menu","required","onChange","onInvalid","value","setValue","initial","error","setError","reset","current","getRadioProps","radioValue","checked","onCheckedChange","event"],"mappings":"AAAA;AAEA,SAGEA,WAAW,EACXC,MAAM,EACNC,QAAQ,QACH,QAAQ;AAIf,MAAMC,OAAO;AACX,aAAa;AACf;AA2NA;;;;;;;;;;;;;;;;;;;;;;;;;;;CA2BC,GACD,OAAO,SAASC,cACdC,OAA6B;IAE7B,MAAM,EACJC,IAAI,EACJC,YAAY,EACZC,OAAO,KAAK,EACZC,QAAQ,EACRC,WAAWP,IAAI,EACfQ,YAAYR,IAAI,EACjB,GAAGE;IACJ,MAAM,CAACO,OAAOC,SAAS,GAAGX,SAAY;QACpC,IAAI,OAAOK,iBAAiB,YAAY;YACtC,OAAOA;QACT;QAEA,OAAOA,gBAAiB;IAC1B;IACA,MAAMO,UAAUb,OAAOW;IACvB,MAAM,CAACG,OAAOC,SAAS,GAAGd,SAAS;IAEnC,OAAO;QACLe,OAAOjB,YAAY;YACjBgB,SAAS;YACTH,SAASC,QAAQI,OAAO;QAC1B,GAAG,EAAE;QACLN;QACAC;QACAM,eAAcC,UAAU;YACtB,MAAMC,UAAUT,UAAUQ;YAC1B,IAAIZ,MAAM;gBACR,OAAO;oBACLa;oBACAC;wBACET,SAASO;oBACX;gBACF;YACF;YAEA,OAAO;gBACLd;gBACAM,OAAOQ;gBACPL;gBACAM;gBACAZ;gBACAC,UAASa,KAAK;oBACZb,SAASa;oBACTP,SAAS;oBACTH,SAASO;gBACX;gBACAT,WAAUY,KAAK;oBACbZ,UAAUY;oBACVP,SAAS;gBACX;YACF;QACF;IACF;AACF"}

package/dist/form/useRangeSlider.d.ts

@@ -1,34 +1,37 @@
 import { type UseStateInitializer, type UseStateSetter } from "../types.js";
 import { type SliderValueOptions } from "./useSlider.js";
 /**
- * @remarks
- * \@since 2.5.0
- * \@since 6.0.0 Updated to use labeled tuple.
+ * @since 2.5.0
+ * @since 6.0.0 Updated to use labeled tuple.
  */
 export type RangeSliderValue = readonly [minValue: number, maxValue: number];
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface RangeSliderState {
     rangeValue: RangeSliderValue;
     setRangeValue: UseStateSetter<RangeSliderValue>;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface RangeSliderOptions extends SliderValueOptions {
+    /** @defaultValue `[min, max]` */
     defaultValue?: UseStateInitializer<RangeSliderValue>;
 }
 /**
- * @remarks \@since 6.0.0
+ * @since 6.0.0
  */
 export interface RangeSliderImplementation extends Required<SliderValueOptions>, RangeSliderState {
 }
 /**
- * @example
- * Range Slider Example
+ * @example Range Slider Example
  * ```tsx
- * import { Fieldset, Form, Legend, Slider, useRangeSlider } from "@react-md/core";
+ * import { Fieldset } from "@react-md/core/form/Fieldset";
+ * import { Form } from "@react-md/core/form/Form";
+ * import { Legend } from "@react-md/core/form/Legend";
+ * import { Slider } from "@react-md/core/form/Slider";
+ * import { useRangeSlider } from "@react-md/core/form/useRangeSlider";
  * import type { ReactElement } from "react";
  * import { useId } from "react";
  *
@@ -57,10 +60,10 @@ export interface RangeSliderImplementation extends Required<SliderValueOptions>,
  * }
  * ```
  *
+ * @see {@link https://next.react-md.dev/components/slider | Slider Demos}
  * @see The `Slider` component for additional examples.
- * @remarks
- * \@since 2.5.0
- * \@since 6.0.0 Now returns an object instead of an ordered tuple and only
+ * @since 2.5.0
+ * @since 6.0.0 Now returns an object instead of an ordered tuple and only
  * return the `rangeValue` and `setRangeValue` instead of all the slider
  * functionality. In addition, the hook only accepts a single object argument.
  */