Dynamic filters ​

The Dynamic filters make it so easy to add multiple, composable, and dynamic filters to the Index view.

The only thing you need to do is add the filterable: true attribute to the fields you need to filter through.

class Avo::Resources::Project < Avo::BaseResource
  self.title = :name

  def fields
    field :name, as: :text
    field :status, as: :status, filterable: true
    field :stage, as: :badge, filterable: true
    field :country, as: :country, filterable: true
  end
end

This will make Avo add this new "Filters" button to the Index view of your resource.

When the user clicks the button, a new filters bar will appear below enabling them to add filters based on the attributes you marked as filterable. The user can add multiple filters for the same attribute if they desire so.

Filter types ​

There are a few types of filters available for you to use out of the box.

-> Boolean

-> Date

-> Has many

-> Number

-> Select

-> Text

Options ​

You can have a few customization options available that you can add in your avo.rb initializer file.

Avo.configure do |config|
  # Other Avo configurations
end

if defined?(AvoFilters)
  AvoFilters.configure do |config|
    config.button_label = "Advanced filters"
    config.always_expanded = true
  end
end

-> button_label

-> always_expanded

Field to filter matching ​

At the moment the filters are not configurable so each field will have a dedicated filter type. We will have a more advanced configuration in the future.

The current field-to-filter matching is done like so:

def field_to_filter(type)
  case type.to_sym
  when :boolean
    :boolean
  when :date, :date_time, :time
    :date
  when :id, :number, :progress_bar
    :number
  when :select, :badge, :country, :status
    :select
  when :text, :textarea, :code, :markdown, :password, :trix
    :text
  else
    :text
  end
end

Caveats ​

At some point we'll integrate the Basic filters into the dynamic filters bar. Until then, if you have both basic and dynamic filters on your resource you'll have two Filters buttons on your Index view.

To mitigate that you can toggle the always_expanded option to true.