https://github.com/amatsuda/html5_validators
A gem/plugin for Rails 3, Rails 4, Rails 5, and Rails 6 that enables client-side validation using ActiveModel + HTML5 Form Validation
https://github.com/amatsuda/html5_validators
activemodel activerecord html5 rails ruby validations
Last synced: about 1 month ago
JSON representation
A gem/plugin for Rails 3, Rails 4, Rails 5, and Rails 6 that enables client-side validation using ActiveModel + HTML5 Form Validation
- Host: GitHub
- URL: https://github.com/amatsuda/html5_validators
- Owner: amatsuda
- License: mit
- Created: 2011-05-16T10:02:00.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2025-04-29T11:02:13.000Z (about 2 months ago)
- Last Synced: 2025-05-13T23:53:06.950Z (about 1 month ago)
- Topics: activemodel, activerecord, html5, rails, ruby, validations
- Language: Ruby
- Homepage:
- Size: 368 KB
- Stars: 304
- Watchers: 10
- Forks: 37
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# HTML5Validators
Automatic client-side validation using HTML5 Form Validation
## What is this?
html5_validators is a gem/plugin for Rails 3+ that enables automatic client-side
validation using ActiveModel + HTML5. Once you bundle this gem on your app,
the gem will automatically translate your model validation code into HTML5
validation attributes on every `form_for` invocation unless you explicitly
cancel it.
## Features
### PresenceValidator => required
* Model
```ruby
class User
include ActiveModel::Validations
validates_presence_of :name
end
```
* View
```erb
<%= f.text_field :name %>
```
other `text_field`ish helpers, `text_area`, `radio_button`, and `check_box` are also available
* HTML
```html
```
* SPEC
http://dev.w3.org/html5/spec/Overview.html#attr-input-required
### LengthValidator => maxlength
* Model
```ruby
class User
include ActiveModel::Validations
validates_length_of :name, maximum: 10
end
```
* View
```erb
<%= f.text_field :name %>
```
`text_area` is also available
* HTML
```html
```
* SPEC
http://dev.w3.org/html5/spec/Overview.html#attr-input-maxlength
### NumericalityValidator => max, min
* Model
```ruby
class User
include ActiveModel::Validations
validates_numericality_of :age, greater_than_or_equal_to: 20
end
```
* View (be sure to use number_field)
```erb
<%= f.number_field :age %>
```
* HTML
```html
```
* SPEC
http://dev.w3.org/html5/spec/Overview.html#attr-input-max
http://dev.w3.org/html5/spec/Overview.html#attr-input-min
### And more (coming soon...?)
:construction:
## Disabling automatic client-side validation
There are four ways to cancel the automatic HTML5 validation.
### 1. Per form (via form_for option)
Set `auto_html5_validation: false` to `form_for` parameter.
* View
```erb
<%= form_for @user, auto_html5_validation: false do |f| %>
...
<% end %>
```
### 2. Per model instance (via model attribute)
Set `auto_html5_validation = false` attribute to ActiveModelish object.
* Controller
```ruby
@user = User.new auto_html5_validation: false
```
* View
```erb
<%= form_for @user do |f| %>
...
<% end %>
```
### 3. Per model class (via model class attribute)
Set `auto_html5_validation = false` to ActiveModelish class' class variable.
This configuration will never be propagated to inherited children classes.
* Model
```ruby
class User < ActiveRecord::Base
self.auto_html5_validation = false
end
```
* Controller
```ruby
@user = User.new
```
* View
```erb
<%= form_for @user do |f| %>
...
<% end %>
```
### 4. Globally (via HTML5Validators module configuration)
Set `config.enabled = false` to Html5Validators module.
Maybe you want to put this in your test_helper, or add a controller filter as
follows for development mode.
* Controller
```ruby
# an example filter that disables the validator if the request has {h5v: 'disable'} params
around_action do |controller, block|
h5v_enabled_was = Html5Validators.enabled
Html5Validators.enabled = false if params[:h5v] == 'disable'
block.call
Html5Validators.enabled = h5v_enabled_was
end
```
## Supported versions
* Ruby 2.1, 2.2, 2.3, 2.4, 2.5, 2.6, 2.7, 3.0, 3.1, 3.2, 3.3 (trunk)
* Rails 3.2.x, 4.0.x, 4.1, 4.2, 5.0, 5.1, 5.2, 6.0, 6.1, 7.0, 7.1 (edge)
* HTML5 compatible browsers
## Installation
Put this line into your Gemfile:
```ruby
gem 'html5_validators'
```
Then bundle:
```
% bundle
```
## Notes
When accessed by an HTML5 incompatible legacy browser, these extra attributes
will just be ignored.
## Todo
* more validations
## Copyright
Copyright (c) 2011 Akira Matsuda. See MIT-LICENSE for further details.