API Reference / @gtkx/forms / ControllerProps

Type Alias: ControllerProps<TFieldValues, TName, TTransformedValues>

ControllerProps<TFieldValues, TName, TTransformedValues> = object & UseControllerProps<TFieldValues, TName, TTransformedValues>

Defined in: node_modules/.pnpm/react-hook-form@7.86.0_react@19.2.8/node_modules/react-hook-form/dist/types/controller.d.ts:54

Render function to provide the control for the field.

Type Declaration

render

render: ({ field, fieldState, formState, }) => React.ReactElement

Parameters

{ field, fieldState, formState, }

field

ControllerRenderProps<TFieldValues, TName>

fieldState

ControllerFieldState

formState

UseFormStateReturn<TFieldValues>

Returns

React.ReactElement

Type Parameters

TFieldValues

TFieldValues extends FieldValues = FieldValues

TName

TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>

TTransformedValues

TTransformedValues = TFieldValues

Returns

all the event handlers, and relevant field and form state.

Example

const { field, fieldState, formState } = useController();

<Controller
  render={({ field, formState, fieldState }) => ({
    <input
      onChange={field.onChange}
      onBlur={field.onBlur}
      name={field.name}
      ref={field.ref} // optional for focus management
    />
  })}
/>