View Source Backpex.Filters.Range behaviour (Backpex v0.8.1)
The range filter renders two input fields of the same type. Backpex offers the :date
, :datetime
and the number
type.
See the following example for an implementation of a date range filter.
defmodule MyAppWeb.Filters.DateRange do
use Backpex.Filters.Range
@impl Backpex.Filters.Range
def type, do: :date
@impl Backpex.Filter
def label, do: "Date Range (begins at)"
end
Information
Note that the query function is already implemented via
Backpex.Filters.Range
.
use Backpex.Filters.Range
When you
use Backpex.Filters.Range
, theBackpex.Filters.Range
module will set@behavior Backpex.Filters.Range
. In addition it will add arender
andrender_form
function in order to display the corresponding filter. It will also implement theBackpex.Filter.query
function to define a range query.
Summary
Functions
Attributes
form
(:any
) (required)type
(:atom
) (required)value
(:any
) (required)
Attributes
value
(:map
) (required)
Attributes
form
(:any
) (required)field
(:atom
) (required)value
(:any
) (required)type
(:atom
) (required)
Callbacks
@callback type() :: :date | :datetime | :number
The type return value defines the rendered input fields of the range filter.