You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
100 lines
3.4 KiB
100 lines
3.4 KiB
import { Control, DeepPartialSkipArrayKey, FieldPath, FieldPathValue, FieldPathValues, FieldValues, UnpackNestedValue } from './types'; |
|
/** |
|
* Subscribe to the entire form values change and re-render at the hook level. |
|
* |
|
* @remarks |
|
* |
|
* [API](https://react-hook-form.com/api/usewatch) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-usewatch-h9i5e) |
|
* |
|
* @param props - defaultValue, disable subscription and match exact name. |
|
* |
|
* @example |
|
* ```tsx |
|
* const { watch } = useForm(); |
|
* const values = useWatch({ |
|
* control, |
|
* defaultValue: { |
|
* name: "data" |
|
* }, |
|
* exact: false, |
|
* }) |
|
* ``` |
|
*/ |
|
export declare function useWatch<TFieldValues extends FieldValues = FieldValues>(props: { |
|
defaultValue?: DeepPartialSkipArrayKey<TFieldValues>; |
|
control?: Control<TFieldValues>; |
|
disabled?: boolean; |
|
exact?: boolean; |
|
}): DeepPartialSkipArrayKey<TFieldValues>; |
|
/** |
|
* Custom hook to subscribe to field change and isolate re-rendering at the component level. |
|
* |
|
* @remarks |
|
* |
|
* [API](https://react-hook-form.com/api/usewatch) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-usewatch-h9i5e) |
|
* |
|
* @param props - defaultValue, disable subscription and match exact name. |
|
* |
|
* @example |
|
* ```tsx |
|
* const { watch } = useForm(); |
|
* const values = useWatch({ |
|
* control, |
|
* name: "fieldA", |
|
* defaultValue: "default value", |
|
* exact: false, |
|
* }) |
|
* ``` |
|
*/ |
|
export declare function useWatch<TFieldValues extends FieldValues = FieldValues, TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>>(props: { |
|
name: TFieldName; |
|
defaultValue?: FieldPathValue<TFieldValues, TFieldName>; |
|
control?: Control<TFieldValues>; |
|
disabled?: boolean; |
|
exact?: boolean; |
|
}): FieldPathValue<TFieldValues, TFieldName>; |
|
/** |
|
* Custom hook to subscribe to field change and isolate re-rendering at the component level. |
|
* |
|
* @remarks |
|
* |
|
* [API](https://react-hook-form.com/api/usewatch) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-usewatch-h9i5e) |
|
* |
|
* @param props - defaultValue, disable subscription and match exact name. |
|
* |
|
* @example |
|
* ```tsx |
|
* const { watch } = useForm(); |
|
* const values = useWatch({ |
|
* control, |
|
* name: ["fieldA", "fieldB"], |
|
* defaultValue: { |
|
* fieldA: "data", |
|
* fieldB: "data" |
|
* }, |
|
* exact: false, |
|
* }) |
|
* ``` |
|
*/ |
|
export declare function useWatch<TFieldValues extends FieldValues = FieldValues, TFieldNames extends readonly FieldPath<TFieldValues>[] = readonly FieldPath<TFieldValues>[]>(props: { |
|
name: readonly [...TFieldNames]; |
|
defaultValue?: UnpackNestedValue<DeepPartialSkipArrayKey<TFieldValues>>; |
|
control?: Control<TFieldValues>; |
|
disabled?: boolean; |
|
exact?: boolean; |
|
}): FieldPathValues<TFieldValues, TFieldNames>; |
|
/** |
|
* Custom hook to subscribe to field change and isolate re-rendering at the component level. |
|
* |
|
* @remarks |
|
* |
|
* [API](https://react-hook-form.com/api/usewatch) • [Demo](https://codesandbox.io/s/react-hook-form-v7-ts-usewatch-h9i5e) |
|
* |
|
* @example |
|
* ```tsx |
|
* // can skip passing down the control into useWatch if the form is wrapped with the FormProvider |
|
* const values = useWatch() |
|
* ``` |
|
*/ |
|
export declare function useWatch<TFieldValues extends FieldValues = FieldValues, TFieldNames extends FieldPath<TFieldValues>[] = FieldPath<TFieldValues>[]>(): FieldPathValues<TFieldValues, TFieldNames>; |
|
//# sourceMappingURL=useWatch.d.ts.map
|