Skip to content

Commit 04f1377

Browse files
authored
docs(README.md): fix inaccuracy in example [ci skip]
1 parent ccda328 commit 04f1377

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,11 @@ const { NumericField } = require('redux-form-numeric-field/immutable')
2929

3030
## Example
3131

32-
The following field will trim its text when it loses focus:
32+
The following field will normalize its value to a number when it loses focus
33+
(unless the text is not a valid number, in which case it will just trim the text when it loses focus).
3334

3435
```js
35-
<NumericField name="name" component={YourInputComponent} />
36+
<NumericField name="value" component={YourInputComponent} />
3637
```
3738

3839
## API

0 commit comments

Comments
 (0)