Search

Provide a search box that filters table rows. The search query is read from the request and applied via the registered search filter. The Search extension is provided by RapidUI::Datatable::Search.

Settings#

Class settings#

class UsersTable < RapidUI::Datatable::Base
  self.skip_search = false
  self.search_param = :q
end

The current query is available as table.search_query (from params[search_param]). Filtering is applied by the extension that implements filter_search(scope) (e.g. an adapter).

Instance settings#

You can override the class settings when building the table.

UsersTable.new(
  @users,
  skip_search: false,
  search_param: :q
)

Adapters#

Support for search is available through these adapters:

• ActiveRecord
• Array

Controls#

The extension registers one control for use in the table UI.

Search field form#

Renders a form with a single search input. Submitting it sends the table’s param (e.g. table) plus search_param (e.g. q) and resets page to 1. Place it in a header group alongside other filters.

table.build_header do |header|
  group.build_search_field_form
  # Or with options:
  # group.build_search_field_form(url: some_path, form_method: :get)
end

Placeholder text is taken from I18n: t("rapid_ui.datatable.search.placeholder") (e.g. "Search...").