docs(form): Updated hook overrides so documentation appears correctly

mlaursen · Nov 24, 2021 · 436fbff · 436fbff
1 parent 2637a6f
commit 436fbff
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 62 deletions.
diff --git a/packages/form/src/text-field/useNumberField.ts b/packages/form/src/text-field/useNumberField.ts
@@ -124,49 +124,6 @@ export type NumberFieldHookReturnType = [
 // all the overloads for the `useNumberField` -- not sure if there's an easier
 // way to type these...
 
-export function useNumberField(
-  options: NumberFieldHookOptions & {
-    defaultValue: number | (() => number);
-    disableMessage: true;
-  }
-): [number, ProvidedNumberFieldProps, NumberFieldHookControls];
-export function useNumberField(
-  options: NumberFieldHookOptions & {
-    defaultValue: number | (() => number);
-    disableMessage: false;
-  }
-): [number, ProvidedNumberFieldMessageProps, NumberFieldHookControls];
-export function useNumberField(
-  options: NumberFieldHookOptions & {
-    defaultValue: number | (() => number);
-    disableMessage?: boolean;
-  }
-): [number, ProvidedNumberFieldMessageProps, NumberFieldHookControls];
-
-export function useNumberField(
-  options: NumberFieldHookOptions & {
-    disableMessage: true;
-  }
-): [number | undefined, ProvidedNumberFieldProps, NumberFieldHookControls];
-export function useNumberField(
-  options: NumberFieldHookOptions & {
-    disableMessage: false;
-  }
-): [
-  number | undefined,
-  ProvidedNumberFieldMessageProps,
-  NumberFieldHookControls
-];
-export function useNumberField(
-  options: NumberFieldHookOptions & {
-    disableMessage?: boolean;
-  }
-): [
-  number | undefined,
-  ProvidedNumberFieldMessageProps,
-  NumberFieldHookControls
-];
-
 /**
  * This hook is used to control the value for the `TextField` component acting
  * as an `<input type="number">` and ensuring that a "valid" `number` is
@@ -209,6 +166,48 @@ export function useNumberField(
  * @returns @see {@link NumberFieldHookReturnType}
  * @remarks \@since 2.5.0
  */
+export function useNumberField(
+  options: NumberFieldHookOptions & {
+    defaultValue: number | (() => number);
+    disableMessage: true;
+  }
+): [number, ProvidedNumberFieldProps, NumberFieldHookControls];
+export function useNumberField(
+  options: NumberFieldHookOptions & {
+    defaultValue: number | (() => number);
+    disableMessage: false;
+  }
+): [number, ProvidedNumberFieldMessageProps, NumberFieldHookControls];
+export function useNumberField(
+  options: NumberFieldHookOptions & {
+    defaultValue: number | (() => number);
+    disableMessage?: boolean;
+  }
+): [number, ProvidedNumberFieldMessageProps, NumberFieldHookControls];
+
+export function useNumberField(
+  options: NumberFieldHookOptions & {
+    disableMessage: true;
+  }
+): [number | undefined, ProvidedNumberFieldProps, NumberFieldHookControls];
+export function useNumberField(
+  options: NumberFieldHookOptions & {
+    disableMessage: false;
+  }
+): [
+  number | undefined,
+  ProvidedNumberFieldMessageProps,
+  NumberFieldHookControls
+];
+export function useNumberField(
+  options: NumberFieldHookOptions & {
+    disableMessage?: boolean;
+  }
+): [
+  number | undefined,
+  ProvidedNumberFieldMessageProps,
+  NumberFieldHookControls
+];
 export function useNumberField({
   id,
   defaultValue,

diff --git a/packages/form/src/text-field/useTextField.ts b/packages/form/src/text-field/useTextField.ts
@@ -238,16 +238,6 @@ export type TextFieldHookReturnType = [
   TextFieldHookControls
 ];
 
-export function useTextField(
-  options: TextFieldHookOptions & { disableMessage: true }
-): [string, ProvidedTextFieldProps, TextFieldHookControls];
-export function useTextField(
-  options: TextFieldHookOptions & { disableMessage: false }
-): [string, ProvidedTextFieldMessageProps, TextFieldHookControls];
-export function useTextField(
-  options: TextFieldHookOptions & { disableMessage?: boolean }
-): [string, ProvidedTextFieldMessageProps, TextFieldHookControls];
-
 /**
  * This hook is used to control the `value` for a `TextField` or `TextArea`
  * component along with some simple validation checks using the browser validity
@@ -264,6 +254,15 @@ export function useTextField(
  * @returns @see {@link TextFieldHookReturnType}
  * @remarks \@since 2.5.0
  */
+export function useTextField(
+  options: TextFieldHookOptions & { disableMessage: true }
+): [string, ProvidedTextFieldProps, TextFieldHookControls];
+export function useTextField(
+  options: TextFieldHookOptions & { disableMessage: false }
+): [string, ProvidedTextFieldMessageProps, TextFieldHookControls];
+export function useTextField(
+  options: TextFieldHookOptions & { disableMessage?: boolean }
+): [string, ProvidedTextFieldMessageProps, TextFieldHookControls];
 export function useTextField({
   id,
   defaultValue = "",

diff --git a/packages/form/src/useIndeterminateChecked.ts b/packages/form/src/useIndeterminateChecked.ts
@@ -191,15 +191,6 @@ export interface CombinedIndeterminateCheckedHookReturnValue<V extends string>
   getProps(value: V): ProvidedCombinedIndeterminateControlledProps<V>;
 }
 
-export function useIndeterminateChecked<V extends string>(
-  values: readonly V[],
-  options?: IndeterminateCheckedHookOptions<V> & { menu?: false }
-): OnChangeReturnValue<V>;
-export function useIndeterminateChecked<V extends string>(
-  values: readonly V[],
-  options: IndeterminateCheckedHookOptions<V> & { menu: true }
-): OnCheckedChangeReturnValue<V>;
-
 /**
  * This hook allows you to toggle the state of multiple checkboxes in a single
  * place along with an indeterminate checkbox that can check/uncheck all
@@ -328,6 +319,14 @@ export function useIndeterminateChecked<V extends string>(
  * additional `values` in the checkbox list, a list of `checkedValues`, and a
  * `setCheckedValues` function to manually override the state if needed.
  */
+export function useIndeterminateChecked<V extends string>(
+  values: readonly V[],
+  options?: IndeterminateCheckedHookOptions<V> & { menu?: false }
+): OnChangeReturnValue<V>;
+export function useIndeterminateChecked<V extends string>(
+  values: readonly V[],
+  options: IndeterminateCheckedHookOptions<V> & { menu: true }
+): OnCheckedChangeReturnValue<V>;
 export function useIndeterminateChecked<V extends string>(
   values: readonly V[],
   {