Skip to content

Commit 7da6644

Browse files
committed
added hero image to documentation
1 parent a089f80 commit 7da6644

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/K3K0J5VAD)
22

3+
![hero](https://i.postimg.cc/8kXtR7QM/Screenshot-2023-03-02-at-10-53-56-AM.png)
4+
35
# Form-Validation-React
46

57
### form-validation-react is an easy-to-use npm library that enables developers to add validation rules to form inputs in React. It supports required fields, email formats, and custom rules with various validation functions and options that can be tailored to specific needs.
@@ -12,7 +14,7 @@
1214
- [Validate Required Inputs](#validate-required-inputs)
1315
- [Validate Min & Max](#validate-min-and-max)
1416
- [Example Reactjs Code](#example-reactjs-code)
15-
- [Licence](#licence)
17+
- [Licence](#license)
1618
## Installation
1719

1820
You can install the package using npm or yarn:
@@ -79,13 +81,13 @@ validateRequired: {
7981
If a required input is not filled, the rule will return a callback with an array of the not-filled inputs. You can add the action `input_red_border` to change the border color of the not-filled inputs to red.
8082

8183

82-
| Parameter | Type | Parameter | Optional |
84+
| Key | Type | Parameter | Optional |
8385
| --- | --- | --- | --- |
8486
| `action` | `string` | `input_red_border`,`show_error_message`,`both` | `no` |
8587
| `message` | `string` | Message | `yes` |
8688
| `applyOnly` | `array ` | **Name** of the inputs | `yes` |
8789
| `notvalidated` | `callback function` | notFilledInputs | `yes` |
88-
| `onsuccess` | `callback function` | no values | `yes` |
90+
| `onsuccess` | `callback function` | no params | `yes` |
8991

9092

9193
#
@@ -128,7 +130,7 @@ the `min` in message object is when exceeded minimum the message will show.
128130
the `max` in message object is when exceeded maximum the message will show
129131

130132

131-
| Parameter | Type | Value | Optional |
133+
| Key | Type | Parameter | Optional |
132134
| --- | --- | --- | --- |
133135
| `when` | `string ` | `typing`,`onblur` | `no` |
134136
| `message` | `object ` | Messages | `yes` |

0 commit comments

Comments
 (0)