Skip to content
This repository was archived by the owner on Aug 23, 2022. It is now read-only.

Commit 52631d5

Browse files
committed
Added documentation
1 parent 075f930 commit 52631d5

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/api/Control.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ const length = (val) => val.length > 8;
156156
```
157157

158158
## `debounce={...}` {#prop-debounce}
159-
_(Number)_: The time in milliseconds, by which the change action will be debounced.
159+
_(Number)_: The time in milliseconds, by which the change action will be debounced.
160160

161161
## `validateOn="..."` {#prop-validateOn}
162162
_(String | Array)_: A string/array of strings specifying when validation should occur. By default, validation happens with whatever `updateOn` is set to. The `validateOn` property can have these values:
@@ -388,4 +388,9 @@ For `<Control.checkbox />`, the default `getValue` function is:
388388
_(Boolean)_: Signifies that the control is a toggle (e.g., a checkbox or a radio). If `true`, then some optimizations are made.
389389

390390
Default: `true` for `<Control.radio>` and `<Control.checkbox>`, `false` for all other controls.
391+
392+
## `withFieldValue={false}` {#prop-withFieldValue}
393+
_(Boolean)_: When `true` the `fieldValue` prop is mapped on to the child component. This prop contains information about the field's state such as its validity and whether it has been touched. This is particularly useful when using a custom component as it allows you to dynamically alter the component based on the field's state.
394+
395+
Default: `false`
391396
{% endraw %}

0 commit comments

Comments
 (0)