Add documentation for Ransack configuration options
[skip ci]
This commit is contained in:
parent
95d45915fd
commit
d4daf64e74
|
@ -62,14 +62,28 @@ module Ransack
|
||||||
self.options[:search_key] = name
|
self.options[:search_key] = name
|
||||||
end
|
end
|
||||||
|
|
||||||
# Raise an error if an unknown predicate, condition or attribute is passed
|
# By default Ransack ignores errors if an unknown predicate, condition or
|
||||||
# into a search.
|
# attribute is passed into a search. The default may be overridden in an
|
||||||
|
# initializer file like `config/initializers/ransack.rb` as follows:
|
||||||
|
#
|
||||||
|
# Ransack.configure do |config|
|
||||||
|
# # Raise if an unknown predicate, condition or attribute is passed
|
||||||
|
# config.ignore_unknown_conditions = false
|
||||||
|
# end
|
||||||
|
#
|
||||||
def ignore_unknown_conditions=(boolean)
|
def ignore_unknown_conditions=(boolean)
|
||||||
self.options[:ignore_unknown_conditions] = boolean
|
self.options[:ignore_unknown_conditions] = boolean
|
||||||
end
|
end
|
||||||
|
|
||||||
# Globally hide `sort_link` order indicator arrows if passed `true`.
|
# By default, Ransack displays sort order indicator arrows in sort links.
|
||||||
# Defaults to `false`.
|
# The default may be globally overridden in an initializer file like
|
||||||
|
# `config/initializers/ransack.rb` as follows:
|
||||||
|
#
|
||||||
|
# Ransack.configure do |config|
|
||||||
|
# # Hide sort link order indicators globally across the application
|
||||||
|
# config.hide_sort_order_indicators = true
|
||||||
|
# end
|
||||||
|
#
|
||||||
def hide_sort_order_indicators=(boolean)
|
def hide_sort_order_indicators=(boolean)
|
||||||
self.options[:hide_sort_order_indicators] = boolean
|
self.options[:hide_sort_order_indicators] = boolean
|
||||||
end
|
end
|
||||||
|
|
Loading…
Reference in New Issue