Skip to content

Latest commit

 

History

History
180 lines (138 loc) · 6.83 KB

README.md

File metadata and controls

180 lines (138 loc) · 6.83 KB
Raw

play-jqvalidate Build Status Dependency Status

Client-side form validation based on your Play model validation annotations.

Quick Demo

http://xael-fry-play-jqvalidate.appspot.com/ is an example form using this module for client-side validation. The source code is available in the samples-and-tests folder.

Dependencies

The play-jqvalidate JavaScript components depend on the jQuery library.

Installation

Install the module

Install the jqvalidate module from the modules repository:

play install jqvalidate

Enable the module

After installing the module, add the following to your application.conf to enable it:

module.jqvalidate=${play.path}/modules/jqvalidate

Usage

Include the module JavaScript

The module JavaScript file is at lib/play-jqvalidate.min.js. This script needs to be copied to your static directory or CDN and included anywhere on your page. The module JavaScript contains compressed copies of the jQuery Validation Plugin and the jQuery Metadata Plugin.

Use the jqvalid.form tag in your view

The jqvalid.form tag is identical to the built-in Play form tag except it outputs some JavaScript that prepares the form to be validated by the jQuery validation plugin.

Use the jqvalid.field tag in your view

The jqvalid.field tag is identical to the built-in Play field tag except it puts an extra property on the field, field.validationData. You need to put this data (rules and messages) as attribute called on your input, select, or textarea element.

#{jqvalid.field 'task.details'}
	<p>
  		<label>&{field.name}</label>
  		<input type="text" ${field.validationData.rules.asAttr()} ${field.validationData.messages.asAttr()} id="${field.id}" name="${field.name}" value="${field.value}" class="${field.errorClass}">
  		<span class="error">${field.error}</span>
	</p>
#{/}

Supported Annotations

The module currently supports the following annotations:

  • Email
  • IPv4Address
  • IPv6Address
  • Match
  • Min
  • Max
  • MinSize
  • MaxSize
  • Phone
  • Range
  • Required
  • URL
  • HexColor

Example

Model

@Entity
public class Task extends Model {
    @Required @Range(max=10,min=1) public int priority;
    @Required @Email public String authorEmail;
    @Required @URL public String authorUrl;
    @Required public String details;
	
	@IPv4Address public String authorIPv4;
	@IPv6Address public String authorIPv6;
	
	@Phone public String authorPhone;
	
	@Match("[A-Z]{3}") 
	public String countryAbbreviation;
    
    @Match("^[0-9]{10,19}$")
    public String creditCardNumber;
    
    @HexColor
    public String color;
}

View

#{jqvalid.form @Tasks.save()}
  	#{jqvalid.field 'task.details'}
		<p>
		  <label>&{field.name}</label>
		  <input type="text" ${field.validationData.rules.asAttr()} ${field.validationData.messages.asAttr()} id="${field.id}" name="${field.name}" value="${field.value}" class="${field.errorClass}">
		  <span class="error">${field.error}</span>
		</p>
	#{/}
	#{jqvalid.field 'task.priority'}
		<p>
		  <label>&{field.name}</label>
		  <input type="text" ${field.validationData.rules.asAttr()} ${field.validationData.messages.asAttr()} id="${field.id}" name="${field.name}" value="${field.value}" class="${field.errorClass}">
		  <span class="error">${field.error}</span>
		</p>
	#{/}
	#{jqvalid.field 'task.authorEmail'}
		<p>
		  <label>&{field.name}</label>
		  <input type="text" ${field.validationData.rules.asAttr()} ${field.validationData.messages.asAttr()} id="${field.id}" name="${field.name}" value="${field.value}" class="${field.errorClass}">
		  <span class="error">${field.error}</span>
		</p>
	#{/}
	#{jqvalid.field 'task.authorUrl'}
		<p>
		  <label>&{field.name}</label>
		  <input type="text" ${field.validationData.rules.asAttr()} ${field.validationData.messages.asAttr()} id="${field.id}" name="${field.name}" value="${field.value}" class="${field.errorClass}">
		  <span class="error">${field.error}</span>
		</p>
	#{/}
	#{jqvalid.field 'task.authorIPv4'}
		<p>
		  <label>&{field.name}</label>
		  <input type="text" ${field.validationData.rules.asAttr()} ${field.validationData.messages.asAttr()} id="${field.id}" name="${field.name}" value="${field.value}" class="${field.errorClass}">
		  <label class="error">${field.error}</label>
	</p>
	#{/}
	#{jqvalid.field 'task.authorIPv6'}
		<p>
		  <label>&{field.name}</label>
		  <input type="text" ${field.validationData.rules.asAttr()} ${field.validationData.messages.asAttr()} id="${field.id}" name="${field.name}" value="${field.value}" class="${field.errorClass}">
		  <label class="error">${field.error}</label>
		</p>
	#{/}  
	#{jqvalid.field 'task.authorPhone'}
		<p>
		  <label>&{field.name}</label>
		  <input type="text" ${field.validationData.rules.asAttr()} ${field.validationData.messages.asAttr()} id="${field.id}" name="${field.name}" value="${field.value}" class="${field.errorClass}">
		  <label class="error">${field.error}</label>
		</p>
	#{/}	  
	#{jqvalid.field 'task.countryAbbreviation'}
		<p>
		  <label>&{field.name}</label>
		  <input type="text" ${field.validationData.rules.asAttr()} ${field.validationData.messages.asAttr()} id="${field.id}" name="${field.name}" value="${field.value}" class="${field.errorClass}">
		  <label class="error">${field.error}</label>
		</p>
	#{/} 
    #{jqvalid.field 'task.creditCardNumber'}
        <p>
          <label>&{field.name}</label>
          <input type="text" ${field.validationData.rules.asAttr()} ${field.validationData.messages.asAttr()} id="${field.id}" name="${field.name}" value="${field.value}" class="${field.errorClass}">
          <label class="error">${field.error}</label>
        </p>
    #{/jqvalid.field}
  
    #{jqvalid.field 'task.color'}
        <p>
          <label>&{field.name}</label>
          <input type="text" ${field.validationData.rules.asAttr()} ${field.validationData.messages.asAttr()} id="${field.id}" name="${field.name}" value="${field.value}" class="${field.errorClass}">
          <label class="error">${field.error}</label>
        </p>
    #{/jqvalid.field}

	<p>
		<input type="submit" value='Create Task'>
	</p>
#{/jqvalid.form}

Result

You can view the example form live at http://play-jqvalidate.appspot.com/. The complete source code is available in this module's samples-and-tests folder.