Filter
Narrows a list or table with filters people add, edit, and remove.
Filter dropdown
Lists the filters people can add.
Status
Branch
Duration
Filter
<.filter_dropdown
id="filter-add"
available_filters={[
%Noora.Filter.Filter{
id: "status",
display_name: "Status",
type: :option,
options: ["success", "failure"],
operator: :==
},
%Noora.Filter.Filter{id: "git_branch", display_name: "Branch", type: :text, operator: :=~},
%Noora.Filter.Filter{id: "duration", display_name: "Duration", type: :number, operator: :>}
]}
active_filters={[]}
/>
Option filter
Option filters pick a value from a menu.
Status
is
is
is not
Failed
Passed
Failed
Skipped
<.active_filter filter={
%Noora.Filter.Filter{
id: "status",
display_name: "Status",
type: :option,
options: ["success", "failure", "skipped"],
options_display_names: %{"success" => "Passed", "failure" => "Failed", "skipped" => "Skipped"},
operator: :==,
value: "failure"
}
} />
Text filter
Text filters take a value in a popover. Without a value, the filter shows Enter value.
Branch
contains
is
contains
does not contain
main
Filter by Branch
Module
is
is
contains
does not contain
Enter value
Filter by Module
<.active_filter filter={
%Noora.Filter.Filter{
id: "git_branch",
display_name: "Branch",
type: :text,
operator: :=~,
value: "main"
}
} />
<.active_filter filter={
%Noora.Filter.Filter{
id: "module_name",
display_name: "Module",
type: :text,
operator: :==,
value: nil
}
} />
Number filter
Number filters compare the value with operators such as greater than.
Duration (s)
greater than
is
less than
greater than
less than or equal to
greater than or equal to
300
Filter by Duration (s)
<.active_filter filter={
%Noora.Filter.Filter{
id: "duration_seconds",
display_name: "Duration (s)",
type: :number,
operator: :>,
value: "300"
}
} />
With active filters
The dropdown hides filters that are already active. This scheme filter sets
searchable: true
, so its value menu has a search input.
Scheme
is
is
is not
AppTests
App
AppTests
Core
CoreTests
Networking
NetworkingTests
Xcode version
Environment
Filter
<.active_filter filter={
%Noora.Filter.Filter{
id: "scheme",
display_name: "Scheme",
type: :option,
options: ["App", "AppTests", "Core", "CoreTests", "Networking", "NetworkingTests"],
options_display_names: %{},
operator: :==,
value: "AppTests",
searchable: true
}
} />
<.filter_dropdown
id="filter-with-active-filters"
available_filters={[
%Noora.Filter.Filter{
id: "scheme",
display_name: "Scheme",
type: :option,
options: [],
operator: :==
},
%Noora.Filter.Filter{
id: "xcode_version",
display_name: "Xcode version",
type: :text,
operator: :==
},
%Noora.Filter.Filter{
id: "is_ci",
display_name: "Environment",
type: :option,
options: ["ci", "local"],
operator: :==
}
]}
active_filters={[%Noora.Filter.Filter{id: "scheme"}]}
/>
Guidelines
-
Describe each filter with a
Noora.Filter.Filterstruct. Itstypesets the operators::optionoffers is and is not,:textadds contains and does not contain, and:numbercompares values. -
Pass the same
available_filtersandactive_filtersto the filter dropdown. It lists only filters that are not active yet, and renders nothing once all of them are. -
Render an
active_filterfor each active filter, next to the dropdown or in a row above the table they filter. -
Keep filters in the URL.
Noora.Filter.Operationsencodes them asfilter_<id>_opandfilter_<id>_valquery parameters and decodes them back into structs. -
Handle the
add_filterevent from the dropdown, or the event you pass ason_select, and theupdate_filterevent that active filters send when their operator or value changes or when they are removed. -
Set
searchable: trueon option filters with many options to add a search input to the value menu.
API reference
<.filter_dropdown>
| Attribute | Type | Default | Description |
|---|---|---|---|
|
active_filters
Required
|
list
|
–
|
List of currently active filters
|
|
available_filters
Required
|
list
|
–
|
List of available filters to choose from
|
|
id
Required
|
string
|
–
|
Unique ID for the dropdown
|
|
label
|
string
|
"Filter"
|
Label for the dropdown
|
|
on_select
|
string
|
"add_filter"
|
Event to trigger when a filter is selected
|
Also accepts global attributes.
<.active_filter>
| Attribute | Type | Default | Description |
|---|---|---|---|
|
filter
Required
|
Noora.Filter.Filter
|
–
|
|