Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/willnet/ajax_error_renderer
a validation error renderer for ajax request
https://github.com/willnet/ajax_error_renderer
Last synced: 2 months ago
JSON representation
a validation error renderer for ajax request
- Host: GitHub
- URL: https://github.com/willnet/ajax_error_renderer
- Owner: willnet
- License: mit
- Created: 2018-11-29T09:05:35.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-11-03T06:51:46.000Z (about 5 years ago)
- Last Synced: 2024-10-07T10:11:08.722Z (3 months ago)
- Language: Ruby
- Homepage:
- Size: 46.9 KB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# AjaxErrorRenderer
[](https://badge.fury.io/rb/ajax_error_renderer) [](https://circleci.com/gh/willnet/ajax_error_renderer/tree/master)
AjaxErrorRenderer is a validation error renderer for ajax request.
If you use turbolinks and form_with, you may need SJR(Server-generated JavaScript Responses) on validation errors. But it's a pain to add similar SJR code with every forms. AjaxErrorRenderer gives you render_ajax_error method to remove duplicated SJR.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'ajax_error_renderer'
```
And then execute:
```bash
$ bundle
```
## Usage
First, `include AjaxErrorRenderer` in your controller like following.
```ruby
class ApplicationController < ActionController::Base
include AjaxErrorRenderer
end
```
Then you can use render_ajax_error method like following.
```ruby
class UsersController < ApplicationController
def new
@user = User.new
end
def create
@user = User.new(params.require(:user).permit(:name))
if @user.save
redirect_to users_path, notice: 'You created a user successfully!'
else
render_ajax_error model: @user
end
end
end
```
So error messages display within `#error` by default.
```erb
<%= form_with(model: @user) do |form| %>
<%# Error Messages display here! %>
<%= form.label :name %>
<%= form.text_field :name %>
<%= form.submit %>
<% end %>
```
If you want to display the messages in other place, you can do it by passing `location` option to `render_ajax_error` with css like following.
```ruby
render_ajax_error model: @user, location: '.error_messages'
```
### Scroll to error messages
If you have a large form, users can miss validation error messages because the messages display above user screen. To solve the problem, render_ajax_error method has move option to scroll to error messages. It defaults to true.
If you won't scroll, you can write like following.
```ruby
render_ajax_error model: @user, move: false
```
### Custom Template
You can create custome template with a generator like following.
```sh
./bin/rails g ajax_error_renderer:view
```
This generator command generates `app/views/ajax_errors/_error.html.erb`, and you can customize it freely.
To use another templates, you can use `template` argument.
```ruby
render_ajax_error model: @user, template: 'critical_error'
```
Template `app/views/ajax_errors/_critical_error.html.erb` will use.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).