Skip to content

Commit 8013954

Browse files
committed
Release first version
1 parent 9b8b351 commit 8013954

File tree

3 files changed

+14
-4
lines changed

3 files changed

+14
-4
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44
/lib/
55
/dist/
66
/demo/
7+
npm-debug.log

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,16 @@
44
`react-hoc-form-validatable` is a library has a higher order form and input components that help validate form easily,
55
especially with asynchronous validate come from the server with the help of Promise ES6.
66

7-
[DEMO](https://gndplayground.github.io/react-hoc-form-validatable)
7+
The library aim to create a validatable component that easy to work with any other input components.
8+
So you can make your own form components with your own styling.
89

10+
Install
11+
12+
`npm i react-hoc-form-validatable`
13+
14+
15+
[Demo online](https://gndplayground.github.io/react-hoc-form-validatable)
916

10-
# Source code is processing.
1117

1218
The library requires Promise polyfill by your app if you want to use asynchronous validation (It mean the
1319
Promise polyfill is not shipped with the library). Your Promise polyfill has to support Promise.cancel().
@@ -18,3 +24,6 @@ The library uses `Higher Order Component` technique and React context to make it
1824
Before use this library you should have knowledge about Higher Order Component.
1925

2026
About React context you should understand it to know how the input states flow through the form and custom your own higher order input component, but it's not mandatory. Higher Order Component should be enough.
27+
28+
You should check [the docs](https://github.com/gndplayground/react-hoc-form-validatable/tree/master/docs) and [the demo source](https://github.com/gndplayground/react-hoc-form-validatable/tree/master/dev/examples)
29+
to see how to use it

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
"description": "React higher order components for validate form. Can use with Promise",
55
"main": "lib/index.js",
66
"author": "giang.nguyen.dev@gmail.com",
7+
"repository": "https://github.com/gndplayground/react-hoc-form-validatable",
78
"license": "MIT",
89
"scripts": {
910
"dev": "webpack-dev-server --hot --history-api-fallback --env.dev --config webpack.config.dev.babel.js",
@@ -81,6 +82,5 @@
8182
"\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$": "<rootDir>/__mocks__/fileMock.js",
8283
"\\.(css|less)$": "<rootDir>/__mocks__/styleMock.js"
8384
}
84-
},
85-
"private": true
85+
}
8686
}

0 commit comments

Comments
 (0)