Skip to content

Commit b8056d9

Browse files
author
Erik Rasmussen
committed
docs: add React compatibility section to README
Addresses CodeRabbit feedback to document supported React versions. The library supports React 16.8+, 17.x, 18.x, and 19.x as declared in the peerDependencies. CI currently tests against React 18.x only.
1 parent 12bb439 commit b8056d9

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,18 @@ yarn add react-final-form-html5-validation react-final-form final-form
3535

3636
[![Edit 🏁 React Final Form - HTML5 Validation Example](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/14r018yjp4)
3737

38+
## React Compatibility
39+
40+
This library supports React 16.8+ (with Hooks), React 17, React 18, and React 19.
41+
42+
**Supported versions:**
43+
- React 16.8.0 or higher
44+
- React 17.x
45+
- React 18.x
46+
- React 19.x
47+
48+
**Note:** CI currently tests against React 18.x. While the library is compatible with React 16.8+, 17.x, and 19.x based on the peer dependency declaration, full automated test coverage across all versions is not yet implemented.
49+
3850
## Usage
3951

4052
The way you specify rules and error messages in HTML5 is by giving first a rule prop, e.g. `required`, `min`, `maxLength`, and then an error message prop, e.g. `valueMissing`, `rangeUnderflow`, or `tooLong`, respectively. This library comes with built-in English defaults for the error messages, but you will probably want to override those by passing in your own.

0 commit comments

Comments
 (0)