Skip to content

Commit ca78514

Browse files
authored
[Docs] SetValue documentation (#4911)
- setValue is a cleaner alternative to changing `field.value.value` but was never documented
1 parent 5f4aa74 commit ca78514

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/src/pages/api/use-field.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,20 @@ You can also bind it with `v-model` to get two-way value binding with validation
122122

123123
<CodeTitle level="4">
124124

125+
`setValue: Ref<TValue = unknown>`
126+
127+
</CodeTitle>
128+
129+
A method to update the fields value.
130+
131+
```js
132+
const { setValue } = useField('field', value => !!value);
133+
134+
setValue('hello world') // sets the value and validates the field
135+
```
136+
137+
<CodeTitle level="4">
138+
125139
`meta: FieldMeta<TValue = unknown>`
126140

127141
</CodeTitle>

0 commit comments

Comments
 (0)