Skip to content

Commit

Permalink
Readme++
Browse files Browse the repository at this point in the history
  • Loading branch information
@f3l1x
f3l1x committed Dec 9, 2020
1 parent e402bbd commit 9f98281
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 57 deletions.
6 changes: 6 additions & 0 deletions .docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,13 @@ Option | Description
**focusScreenOffsetY** | vertical screen offset in px to scroll after focusing element with error (useful when using fixed navbar menu which may otherwise obscure the element in focus); or use "false" for default behavior

#### Special features

* **Form on load validation** - Adding class `validate-on-load` to form element will execute its validation immediately after page is loaded.

### Advanced

You can edit/replace methods `LiveForm.addError` (shows error message), `LiveForm.removeError` (hides error message), `LiveForm.showValid` (show message if input is correctly filled), `LiveForm.setupHandlers` (sets handlers up for inputs, like focus, blur, onkeyup). These methods can be altered to support some JS framework, ie. jQuery.

### Authors

This script is based on work of **Robert Pösel**, **zakrava**, **Radek Ježdík**, **MartyIX** and **David Grudl**. Thank you guys.
71 changes: 14 additions & 57 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
![](https://heatbadger.now.sh/github/readme/contributte/live-form-validation/)

<p align=center>
<a href="https://travis-ci.org/contributte/live-form-validation"><img src="https://img.shields.io/travis/contributte/live-form-validation.svg?style=flat-square"></a>
<a href="https://www.npmjs.com/package/live-form-validation"><img src="https://img.shields.io/npm/dt/live-form-validation.svg?style=flat-square"></a>
<a href="http://bit.ly/ctteg"><img src="https://img.shields.io/gitter/room/contributte/contributte.svg?style=flat-square"></a>
<a href="https://github.com/contributte/live-form-validation/actions"><img src="https://badgen.net/github/checks/contributte/live-form-validation/master?cache=300"></a>
<a href="https://packagist.org/packages/contributte/live-form-validation"><img src="https://badgen.net/npm/dm/live-form-validation"></a>
<a href="https://packagist.org/packages/contributte/live-form-validation"><img src="https://badgen.net/npm/v/live-form-validation"></a>
</p>
<p align=center>
<a href="https://github.com/contributte/live-form-validation/LICENSE"><img src="https://badgen.net/github/license/contributte/live-form-validation"></a>
<a href="https://packagist.org/packages/contributte/live-form-validation"><img src="https://badgen.net/npm/node/live-form-validation"></a>
<a href="https://github.com/contributte/live-form-validation"><img src="https://badgen.net/github/license/contributte/live-form-validation"></a>
<a href="https://bit.ly/ctteg"><img src="https://badgen.net/badge/support/gitter/cyan"></a>
<a href="https://bit.ly/cttfo"><img src="https://badgen.net/badge/support/forum/yellow"></a>
<a href="https://contributte.org/partners.html"><img src="https://badgen.net/badge/sponsor/donations/F96854"></a>
Expand All @@ -16,16 +17,20 @@
Website 🚀 <a href="https://contributte.org">contributte.org</a> | Contact 👨🏻‍💻 <a href="https://f3l1x.io">f3l1x.io</a> | Twitter 🐦 <a href="https://twitter.com/contributte">@contributte</a>
</p>

<p align=center>
Website 🚀 <a href="https://contributte.org">contributte.org</a> | Contact 👨🏻‍💻 <a href="https://f3l1x.io">f3l1x.io</a> | Twitter 🐦 <a href="https://twitter.com/contributte">@contributte</a>
</p>

## Documentation

For details on how to use this package, check out our [documentation](.docs).

## Versions

| State | Version | Branch | Nette | PHP |
|-------------|---------------|----------|-------|---------|
| dev | `dev-master` | `master` | 3.0+ | `^7.4` |
| stable | `^0.1` | `master` | 3.0+ | `^7.3` |
| State | Version | Branch |
|-------------|---------------|----------|
| dev | `dev-master` | `master` |
| stable | `^1.9.0` | `master` |

## Development

Expand All @@ -34,57 +39,9 @@ See [how to contribute](https://contributte.org/contributing.html) to this packa
This package is currently maintaining by these authors.

<a href="https://github.com/f3l1x">
<img width="150" height="150" src="https://avatars2.githubusercontent.com/u/538058?v=3&s=80">
<img width="80" height="80" src="https://avatars2.githubusercontent.com/u/538058?v=3&s=80">
</a>

### Authors

This script is based on work of **Robert Pösel**, **zakrava**, **Radek Ježdík**, **MartyIX** and **David Grudl**.

**Thank you all!**

<table>
<tbody>
<tr>
<td align="center">
<a href="https://github.com/Robyer">
<img width="150" height="150" src="https://avatars2.githubusercontent.com/u/359173?v=3&s=150">
</a>
</br>
<a href="https://github.com/Robyer">Robert Pösel</a>
</td>
<td align="center">
<a href="https://github.com/zakrava">
<img width="150" height="150" src="https://avatars2.githubusercontent.com/u/9878014?v=3&s=150">
</a>
</br>
<a href="https://github.com/zakrava">Zakrava</a>
</td>
<td align="center">
<a href="https://github.com/redhead">
<img width="150" height="150" src="https://avatars2.githubusercontent.com/u/158482?v=3&s=150">
</a>
</br>
<a href="https://github.com/redhead">Radek Ježdík</a>
</td>
<td align="center">
<a href="https://github.com/MartyIX">
<img width="150" height="150" src="https://avatars2.githubusercontent.com/u/203266?v=3&s=150">
</a>
</br>
<a href="https://github.com/MartyIX">Martin Vseticka</a>
</td>
<td align="center">
<a href="https://github.com/dg">
<img width="150" height="150" src="https://avatars2.githubusercontent.com/u/194960?v=3&s=150">
</a>
</br>
<a href="https://github.com/dg">David Grudl</a>
</td>
</tr>
</tbody>
</table>

-----

Consider to [support](https://contributte.org/partners.html) **contributte** development team.
Expand Down

0 comments on commit 9f98281

Please sign in to comment.