Type Alias UseFormSetFocus<TFieldValues>

UseFormSetFocus: <
    TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>,
>(
    name: TFieldName,
    options?: SetFocusOptions,
) => void

Set focus on a registered field. You can start to invoke this method after all fields are mounted to the DOM.

Type Parameters

TFieldValues extends FieldValues

Type Declaration

- <TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>>(
  name: TFieldName,
  options?: SetFocusOptions,
  ): void
- Type Parameters
  - TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>
  Parameters
  - name: TFieldName
    the path name to the form field value.
  - Optionaloptions: SetFocusOptions
    input focus behavior options
  Returns void

Remarks

Example

useEffect(() => {
  setFocus("name");
}, [setFocus])
// shouldSelect allows to select input's content on focus
<button onClick={() => setFocus("name", { shouldSelect: true })}>Focus</button>