HTML5 form tags module for Play 2

for Java and Scala

This module brings client side validation attributes (required, max|min length, ...) and formats support (date, number, email, ...) to Play 2.2 templates. The provided tags can also display forms with special input controls, like a numeric keypad to enter numbers on a smartphone, a calendar for date selection and so on.

Attributes are generated from the constraints defined in the model or in a form mapping.

How to install it

In your application, add this configuration to the project/Build.scala file :

For Play 2.2.x+

val appDependencies = Seq(
  //your dependencies
  "com.github.krzysztofkowalski" %% "html5tags" % "1.2.0"
)

val main = play.Project(appName, appVersion, appDependencies).settings(
  //your settings
  resolvers += Resolver.url("k@github repo for html5tags", url("http://krzysztofkowalski.github.io/releases/"))(Resolver.ivyStylePatterns)
)

For play 2.1.x use

val appDependencies = Seq(
  //your dependencies
  "com.loicdescotte.coffeebean" %% "html5tags" % "1.1.2-SNAPSHOT"
)

val main = play.Project(appName, appVersion, appDependencies).settings(
  //your settings
  resolvers += Resolver.url("k@github repo for html5tags", url("http://krzysztofkowalski.github.io/releases/"))(Resolver.ivyStylePatterns)
)

Code examples

With this view template :

@import html5.tags.html._

@text(form("name"), 'label -> "Your name : ")
@number(form("age"), 'label -> "Your age : ") 

If your form mapping is defined like this (Scala) :

mapping(          
  "name" -> nonEmptyText(maxLength=10),
  "age" -> number
)

Or if your model contains this (Java) :

@Constraints.Required
@Constraints.MaxLength(10)
public String name;

public Integer age;

The generated output will be :

<input type="text" id="name" name="name" value="" label="Your name : " required maxlength="10">
<input type="number" id="age" name="age" value="" label="Your age : ">

Then the browser will check that the name field is not empty and the age input is a number, before sending to server. It will also limit the length of the name input.

A few examples with pictures

Email validation :

Telephone number keyboard (on Safari mobile) :

Available tags and formats

You can use the following tags :

• @checkbox
• @date
• @email
• @number
• @password
• @radioGroup
• @search
• @select
• @tel
• @text
• @textarea
• @url

And the following constraint values on models/mappings :

• required (or nonEmpty or nonEmptyText)
• maxLength
• minLength
• max
• min
• pattern (regular expressions)

Note : you can check features and browsers compatibility for this new attributes on [wufoo] (http://wufoo.com/html5/).

Magic tag

The text tag is able to change the input type if a specific format is detected.

For example, using the email constraint :

@Constraints.Email
public String contactMail;

And this tag :

@text(form("contactMail"), 'label -> "Your mail : ")

The generated output will be :

<input type="email" id="contactMail" name="contactMail" value="">

And the browser will check that the field contains an email address.

The same trick is working with number input type if you use max/min constraints.

Important notes

MinLength behavior

As minLength does not exist in HTML5 specification, a regular expression pattern will be used to simulate it. If you need both 'minLength' and 'pattern' on a field, write the min length constraint directly in your regex pattern. Example : add {2,} to your pattern for minLength=2.

Browser regex patterns

You can check pattern compatibility with Javascript regular expressions (used by browsers) on [regexpal] (http://regexpal.com/) (check the 'Dot matches all' option).

License

This project is published under the Apache License v2.0.

You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0] (http://www.apache.org/licenses/LICENSE-2.0).

History

Forked from https://github.com/loicdescotte/Play2-HTML5Tags and added support to Play 2.1.x and 2.2.x