1.9.4 • Published 5 years ago

live-form-validation-es6 v1.9.4

Weekly downloads
10
License
BSD-3-Clause
Repository
github
Last release
5 years ago

Live Form Validation ES6

This is modified version of Live Form Validation for usage in ES6 syntax as module.

:no_entry: Nice client-side live form validation for Nette Forms 2.4.


Build Status Licence Downloads total Latest stable

Discussion / Help

Join the chat

Install

NPM

npm install --save live-form-validation

Manually

All you need is to link live-form-validation.js file from to your HTML document. That's it!

The script already contains the netteForms.js file, so don't use it again and remove it from your HTML document.

Rawgit

  • Dev: https://rawgit.com/contributte/live-form-validation/master/live-form-validation.js
  • Stable: https://cdn.rawgit.com/contributte/live-form-validation/v1.8.1/live-form-validation.js

Versions

StateVersionBranch
development^1.9.4master
stable^1.8.1master

Usage

Script by default works nicely with Twitter Bootstrap 3, but you can customize the options to fit your exact needs.

ES6 usage

Script can be used in standard way described bellow or as ES6 module.

First you need to import module and link it to the window context like this:

import LiveFormValidation from 'live-form-validation-es6';

window.LiveForm = LiveFormValidation.LiveForm;
window.Nette = LiveFormValidation.Nette;

or

const liveFormValidation = require('live-form-validation-es6');

window.LiveForm = liveFormValidation.LiveForm;
window.Nette = liveFormValidation.Nette;

Then you need to run initialization of validation when DOM is ready. For example:

document.addEventListener('DOMContentLoaded', () => {
   window.Nette.init(); 
});

or with jQuery

$(() => {
   window.Nette.init();  
});

Options

You can change default options by calling LiveForm.setOptions({ ... }); after including the script. Give only options that you want to change. For example:

<script src="/js/live-form-validation.js"></script> 
<script>
	LiveForm.setOptions({
		messageErrorPrefix: 'Error: ',
		wait: 500
	});
</script> 

Alternatively, if you want to set options before the script is loaded, create LiveFormOptions = { ... }; with options that you want to change. For example:

<script>
	LiveFormOptions = {
		messageErrorPrefix: 'Error: ',
		wait: 500
	};
</script> 
<script src="/js/live-form-validation.js"></script> 

Available options

OptionDescription
showMessageClassOnParentCSS class of control's parent where error/valid class should be added; or "false" to use control directly
messageParentClassCSS class of control's parent where error/valid message should be added (fallback to direct parent if not found); or "false" to use control's direct parent
controlErrorClassCSS class for an invalid control
controlValidClassCSS class for a valid control
messageErrorClassCSS class for an error message
enableHiddenMessageClasscontrol with this CSS class will show error/valid message even when control itself is hidden (useful for controls which are hidden and wrapped into special component)
disableLiveValidationClasscontrol with this CSS class will have disabled live validation
disableShowValidClasscontrol with this CSS class will not show valid message
messageTagtag that will hold the error/valid message
messageIdPostfixmessage element id = control id + this postfix
messageErrorPrefixshow this html before error message itself
showAllErrorsshow all errors when submitting form; or use "false" to show only first error
showValidshow message when valid
waitdelay in ms before validating on keyup/keydown; or use "false" to disable it
focusScreenOffsetYvertical 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.

Maintainers

Authors

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

Thank you all!


Thank you for testing, reporting and contributing.

1.9.4

5 years ago

1.9.3

5 years ago

1.9.2

5 years ago

1.9.0

5 years ago