Blame view

天文台pc/tianwentai-ui/node_modules/react-hook-form/dist/useFormContext.d.ts 2.33 KB
bc518174   王天杨   提交两个项目文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
  import React from 'react';
  import { FieldValues, FormProviderProps, UseFormReturn } from './types';
  /**
   * This custom hook allows you to access the form context. useFormContext is intended to be used in deeply nested structures, where it would become inconvenient to pass the context as a prop. To be used with {@link FormProvider}.
   *
   * @remarks
   * [API](https://react-hook-form.com/docs/useformcontext) • [Demo](https://codesandbox.io/s/react-hook-form-v7-form-context-ytudi)
   *
   * @returns return all useForm methods
   *
   * @example
   * ```tsx
   * function App() {
   *   const methods = useForm();
   *   const onSubmit = data => console.log(data);
   *
   *   return (
   *     <FormProvider {...methods} >
   *       <form onSubmit={methods.handleSubmit(onSubmit)}>
   *         <NestedInput />
   *         <input type="submit" />
   *       </form>
   *     </FormProvider>
   *   );
   * }
   *
   *  function NestedInput() {
   *   const { register } = useFormContext(); // retrieve all hook methods
   *   return <input {...register("test")} />;
   * }
   * ```
   */
  export declare const useFormContext: <TFieldValues extends FieldValues, TContext = any, TTransformedValues = TFieldValues>() => UseFormReturn<TFieldValues, TContext, TTransformedValues>;
  /**
   * A provider component that propagates the `useForm` methods to all children components via [React Context](https://reactjs.org/docs/context.html) API. To be used with {@link useFormContext}.
   *
   * @remarks
   * [API](https://react-hook-form.com/docs/useformcontext) • [Demo](https://codesandbox.io/s/react-hook-form-v7-form-context-ytudi)
   *
   * @param props - all useForm methods
   *
   * @example
   * ```tsx
   * function App() {
   *   const methods = useForm();
   *   const onSubmit = data => console.log(data);
   *
   *   return (
   *     <FormProvider {...methods} >
   *       <form onSubmit={methods.handleSubmit(onSubmit)}>
   *         <NestedInput />
   *         <input type="submit" />
   *       </form>
   *     </FormProvider>
   *   );
   * }
   *
   *  function NestedInput() {
   *   const { register } = useFormContext(); // retrieve all hook methods
   *   return <input {...register("test")} />;
   * }
   * ```
   */
  export declare const FormProvider: <TFieldValues extends FieldValues, TContext = any, TTransformedValues = TFieldValues>(props: FormProviderProps<TFieldValues, TContext, TTransformedValues>) => React.JSX.Element;
  //# sourceMappingURL=useFormContext.d.ts.map