Skip to content

Commit 436fbff

Browse files
committed
docs(form): Updated hook overrides so documentation appears correctly
1 parent 2637a6f commit 436fbff

File tree

3 files changed

+59
-62
lines changed

3 files changed

+59
-62
lines changed

packages/form/src/text-field/useNumberField.ts

Lines changed: 42 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -124,49 +124,6 @@ export type NumberFieldHookReturnType = [
124124
// all the overloads for the `useNumberField` -- not sure if there's an easier
125125
// way to type these...
126126

127-
export function useNumberField(
128-
options: NumberFieldHookOptions & {
129-
defaultValue: number | (() => number);
130-
disableMessage: true;
131-
}
132-
): [number, ProvidedNumberFieldProps, NumberFieldHookControls];
133-
export function useNumberField(
134-
options: NumberFieldHookOptions & {
135-
defaultValue: number | (() => number);
136-
disableMessage: false;
137-
}
138-
): [number, ProvidedNumberFieldMessageProps, NumberFieldHookControls];
139-
export function useNumberField(
140-
options: NumberFieldHookOptions & {
141-
defaultValue: number | (() => number);
142-
disableMessage?: boolean;
143-
}
144-
): [number, ProvidedNumberFieldMessageProps, NumberFieldHookControls];
145-
146-
export function useNumberField(
147-
options: NumberFieldHookOptions & {
148-
disableMessage: true;
149-
}
150-
): [number | undefined, ProvidedNumberFieldProps, NumberFieldHookControls];
151-
export function useNumberField(
152-
options: NumberFieldHookOptions & {
153-
disableMessage: false;
154-
}
155-
): [
156-
number | undefined,
157-
ProvidedNumberFieldMessageProps,
158-
NumberFieldHookControls
159-
];
160-
export function useNumberField(
161-
options: NumberFieldHookOptions & {
162-
disableMessage?: boolean;
163-
}
164-
): [
165-
number | undefined,
166-
ProvidedNumberFieldMessageProps,
167-
NumberFieldHookControls
168-
];
169-
170127
/**
171128
* This hook is used to control the value for the `TextField` component acting
172129
* as an `<input type="number">` and ensuring that a "valid" `number` is
@@ -209,6 +166,48 @@ export function useNumberField(
209166
* @returns @see {@link NumberFieldHookReturnType}
210167
* @remarks \@since 2.5.0
211168
*/
169+
export function useNumberField(
170+
options: NumberFieldHookOptions & {
171+
defaultValue: number | (() => number);
172+
disableMessage: true;
173+
}
174+
): [number, ProvidedNumberFieldProps, NumberFieldHookControls];
175+
export function useNumberField(
176+
options: NumberFieldHookOptions & {
177+
defaultValue: number | (() => number);
178+
disableMessage: false;
179+
}
180+
): [number, ProvidedNumberFieldMessageProps, NumberFieldHookControls];
181+
export function useNumberField(
182+
options: NumberFieldHookOptions & {
183+
defaultValue: number | (() => number);
184+
disableMessage?: boolean;
185+
}
186+
): [number, ProvidedNumberFieldMessageProps, NumberFieldHookControls];
187+
188+
export function useNumberField(
189+
options: NumberFieldHookOptions & {
190+
disableMessage: true;
191+
}
192+
): [number | undefined, ProvidedNumberFieldProps, NumberFieldHookControls];
193+
export function useNumberField(
194+
options: NumberFieldHookOptions & {
195+
disableMessage: false;
196+
}
197+
): [
198+
number | undefined,
199+
ProvidedNumberFieldMessageProps,
200+
NumberFieldHookControls
201+
];
202+
export function useNumberField(
203+
options: NumberFieldHookOptions & {
204+
disableMessage?: boolean;
205+
}
206+
): [
207+
number | undefined,
208+
ProvidedNumberFieldMessageProps,
209+
NumberFieldHookControls
210+
];
212211
export function useNumberField({
213212
id,
214213
defaultValue,

packages/form/src/text-field/useTextField.ts

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -238,16 +238,6 @@ export type TextFieldHookReturnType = [
238238
TextFieldHookControls
239239
];
240240

241-
export function useTextField(
242-
options: TextFieldHookOptions & { disableMessage: true }
243-
): [string, ProvidedTextFieldProps, TextFieldHookControls];
244-
export function useTextField(
245-
options: TextFieldHookOptions & { disableMessage: false }
246-
): [string, ProvidedTextFieldMessageProps, TextFieldHookControls];
247-
export function useTextField(
248-
options: TextFieldHookOptions & { disableMessage?: boolean }
249-
): [string, ProvidedTextFieldMessageProps, TextFieldHookControls];
250-
251241
/**
252242
* This hook is used to control the `value` for a `TextField` or `TextArea`
253243
* component along with some simple validation checks using the browser validity
@@ -264,6 +254,15 @@ export function useTextField(
264254
* @returns @see {@link TextFieldHookReturnType}
265255
* @remarks \@since 2.5.0
266256
*/
257+
export function useTextField(
258+
options: TextFieldHookOptions & { disableMessage: true }
259+
): [string, ProvidedTextFieldProps, TextFieldHookControls];
260+
export function useTextField(
261+
options: TextFieldHookOptions & { disableMessage: false }
262+
): [string, ProvidedTextFieldMessageProps, TextFieldHookControls];
263+
export function useTextField(
264+
options: TextFieldHookOptions & { disableMessage?: boolean }
265+
): [string, ProvidedTextFieldMessageProps, TextFieldHookControls];
267266
export function useTextField({
268267
id,
269268
defaultValue = "",

packages/form/src/useIndeterminateChecked.ts

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -191,15 +191,6 @@ export interface CombinedIndeterminateCheckedHookReturnValue<V extends string>
191191
getProps(value: V): ProvidedCombinedIndeterminateControlledProps<V>;
192192
}
193193

194-
export function useIndeterminateChecked<V extends string>(
195-
values: readonly V[],
196-
options?: IndeterminateCheckedHookOptions<V> & { menu?: false }
197-
): OnChangeReturnValue<V>;
198-
export function useIndeterminateChecked<V extends string>(
199-
values: readonly V[],
200-
options: IndeterminateCheckedHookOptions<V> & { menu: true }
201-
): OnCheckedChangeReturnValue<V>;
202-
203194
/**
204195
* This hook allows you to toggle the state of multiple checkboxes in a single
205196
* place along with an indeterminate checkbox that can check/uncheck all
@@ -328,6 +319,14 @@ export function useIndeterminateChecked<V extends string>(
328319
* additional `values` in the checkbox list, a list of `checkedValues`, and a
329320
* `setCheckedValues` function to manually override the state if needed.
330321
*/
322+
export function useIndeterminateChecked<V extends string>(
323+
values: readonly V[],
324+
options?: IndeterminateCheckedHookOptions<V> & { menu?: false }
325+
): OnChangeReturnValue<V>;
326+
export function useIndeterminateChecked<V extends string>(
327+
values: readonly V[],
328+
options: IndeterminateCheckedHookOptions<V> & { menu: true }
329+
): OnCheckedChangeReturnValue<V>;
331330
export function useIndeterminateChecked<V extends string>(
332331
values: readonly V[],
333332
{

0 commit comments

Comments
 (0)