Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ const {
Field,
FieldsListener,
getFieldValue,
getFieldRef,
setFieldValue,
setFieldError,
focusField,
Expand Down Expand Up @@ -199,6 +200,14 @@ type getFieldValue = (
) => Value;
```

#### getFieldRef

Return the field stable `ref`.

```tsx
type getFieldRef = <T>(name: FieldName) => MutableRefObject<T>;
```

#### setFieldValue

By setting `validate: true`, you will enforce validation. It has no effect if the field is already _talkative_.
Expand Down
1 change: 1 addition & 0 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ export type Form<Values extends Required<Values>, ErrorMessage = string> = {
};

getFieldValue: <N extends keyof Values>(name: N, options?: { sanitize?: boolean }) => Values[N];
getFieldRef: <T>(name: keyof Values) => MutableRefObject<T>;
setFieldValue: <N extends keyof Values>(
name: N,
value: Values[N],
Expand Down
7 changes: 7 additions & 0 deletions src/useForm.ts
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,11 @@ export const useForm = <Values extends Required<Values>, ErrorMessage = string>(
return sanitize ? getSanitize(name)(value) : value;
};

const getFieldRef = <T>(name: Name) => {
const { ref } = fields.current[name];
return ref as MutableRefObject<T>;
};

const focusField: Contract["focusField"] = (name) => {
const { ref } = fields.current[name];

Expand Down Expand Up @@ -347,6 +352,7 @@ export const useForm = <Values extends Required<Values>, ErrorMessage = string>(

return {
getFieldValue,
getFieldRef,
setFieldValue,
setFieldError,
focusField,
Expand Down Expand Up @@ -475,6 +481,7 @@ export const useForm = <Values extends Required<Values>, ErrorMessage = string>(
FieldsListener: fieldsListener.current,

getFieldValue: api.getFieldValue,
getFieldRef: api.getFieldRef,
setFieldValue: api.setFieldValue,
setFieldError: api.setFieldError,
focusField: api.focusField,
Expand Down