Function Form

  • Form<Values>(props): ReactElement<any, string | JSXElementConstructor<any>>

  • Type Parameters

    • Values = any

    Parameters

    Returns ReactElement<any, string | JSXElementConstructor<any>>

Properties

ErrorList Item List Provider create displayName? useForm useFormInstance useWatch

Properties

ErrorList

ErrorList: FC<ErrorListProps>

Item

Item: CompoundedComponent

List

List: FC<FormListProps>

Provider

Provider: FC<FormProviderProps>

create

create: (() => void)

Type declaration

    • (): void

    • Returns void

      Deprecated

      Only for warning usage. Do not use.

Deprecated

Only for warning usage. Do not use.

Optional displayName

displayName?: string

Used in debugging messages. You might want to set it explicitly if you want to display a different name for debugging purposes.

See

Legacy React Docs

Example


const MyComponent: FC = () => {
  return <div>Hello!</div>
}

MyComponent.displayName = 'MyAwesomeComponent'

useForm

useForm: (<Values>(form?) => [FormInstance<Values>])

Type declaration

useFormInstance

useFormInstance: (<Value>() => FormInstance<Value>)

Type declaration

useWatch

useWatch: {
    <TDependencies1, TForm, TDependencies2, TDependencies3, TDependencies4>(dependencies, form?): GetGeneric<TForm>[TDependencies1][TDependencies2][TDependencies3][TDependencies4];
    <TDependencies1, TForm, TDependencies2, TDependencies3>(dependencies, form?): GetGeneric<TForm>[TDependencies1][TDependencies2][TDependencies3];
    <TDependencies1, TForm, TDependencies2>(dependencies, form?): GetGeneric<TForm>[TDependencies1][TDependencies2];
    <TDependencies, TForm>(dependencies, form?): GetGeneric<TForm>[TDependencies];
    <TForm>(dependencies, form?): GetGeneric<TForm>;
    <TForm, TSelected>(selector, form?): TSelected;
    <ValueType, TSelected>(selector, form?): TSelected;
    <TForm>(dependencies, form?): any;
    <ValueType>(dependencies, form?): ValueType;
}

Type declaration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc