Filterrific

Filterrific is a Rails Engine plugin that makes it easy to filter, search, and sort your ActiveRecord lists:

Features

• Makes heavy use of ActiveRecord Scopes
• ActionController helpers to shuttle filter params from ActionView forms to ActiveRecord based models, and to return matching records back from ActiveRecord to ActionView.
• Form helpers to build powerful search and filter forms with ease.
• Javascript assets to auto-submit filter form on change via AJAX.
• Image asset to show a spinner in the Filterrific form when new records are being loaded via AJAX.
• API option to use Filterrific with Rails API mode. Just use gem 'filterrific', require: 'filterrific_api' in your Gemfile.

---

---

Installation

gem install filterrific

or with bundler in your Gemfile:

gem 'filterrific'

Usage

Make sure to go to the fantastic Filterrific documentation to find out more!

Compatibility

Every commit to Filterrific is automatically tested against the following scenarios:

|Filterrific version | Rails version | Ruby environments | Database adapters | Build status | |--------------------|---------------------|--------------------------------|------------------------------------|--------------| | 5.x | Rails 5.x, 6.x, 7.x, 8.x | MRI 2.0.0, 2.1.7, 2.2.3, 2.3.1 | mysql2, postgresql || | 4.x | Rails 4.x | MRI 2.0.0, 2.1.7, 2.2.3, 2.3.1 | mysql, mysql2, postgresql, sqlite3 || | 3.x | Rails 3.2 | MRI 2.0.0, 2.1.7 | mysql, mysql2, postgresql, sqlite3 | Not tested| | 2.x | Rails 3.2 | MRI 1.9.3 | mysql, mysql2, postgresql, sqlite3 | Not tested| | 1.x | < 3.2 | MRI <= 1.9.3 | mysql, mysql2, postgresql, sqlite3 | Not tested|

Guidelines for submitting issues

Please post questions related to usage at StackOverflow under the filterrific tag.

If you think you've found a bug, or have a feature request, then create an issue here on Github. You'll make my job easier if you follow these guidelines:

• Please keep in mind that I do this in my spare time. To you this software is free as in beer, to me it's free as in baby. I appreciate it if you first do everything you can on your own: read the detailed Filterrific documentation, look for similar issues on StackOverflow, search the internets, etc.
• If you're stuck, give me sufficient context so that I have a chance to identify the issue:
  • what version of filterrific are you using? (look in your Gemfile.lock)
  • what version of Rails are you using? (look in your Gemfile.lock)
  • what version of Ruby are you using? (run ruby -v in your app root)
• If you get an exception, include the entire stack trace, including the error message.
• Include any relevant code snippets (your model, controller, and view code).
• When pasting code, please use markdown code formatting. It will be much easier to read.

Resources

• Documentation
• Demo App using classic Rails views.
• API Demo App using React and Mobx.
• Changelog
• Source code (github)
• Issues
• Questions on Stack Overflow (tagged filterrific)
• Rubygems.org

License

MIT licensed.

Copyright

Copyright (c) 2010 - 2023 Jo Hund. See (MIT) LICENSE for details.