Attributes

• id (:string) (required)
• label (:string) (required)
• unsaved_changes (:boolean) - Whether the filter is newly applied or updated and hasnt been saved. Defaults to false.
• filter_key (:string) (required) - A unique identifier for the filter.
• selected (:boolean) - Whether the filter is selected or not. Defaults to false.
• initial_active (:boolean) - Whether the Popover will be initially open or not. Defaults to false.
• hide_clear_button (:boolean) - Defaults to false.
• disabled (:boolean) - Whether filtering is disabled. Defaults to false.
• close_on_child_overlay_click (:boolean) - Whether the filter should close when clicking inside another Popover.
• on_remove (:any) - Callback invoked when the filter is removed. Defaults to nil.

Slots

• filter

Filters is a composite component that filters the items of a list or table.

Examples

</.skeleton_display_text>

See

• https://polaris.shopify.com/components/selection-and-input/filters
• https://github.com/Shopify/polaris/blob/main/polaris-react/src/components/Filters/Filters.tsx
• https://github.com/Shopify/polaris/blob/main/polaris-react/src/components/Filters/components/FiltersBar/FiltersBar.tsx
• https://github.com/Shopify/polaris/blob/main/polaris-react/src/components/Filters/components/FilterPill/FilterPill.tsx

Attributes

• id (:string) (required)
• query_form (Phoenix.HTML.Form) - The form that controls the query field. Defaults to nil.
• query_placeholder (:string) - Placeholder text for the query field. Defaults to nil.
• focused (:boolean) - Whether the query field is focused. Defaults to false.
• filters (:list) - Available filters added to the filter bar. Shortcut filters are pinned to the front of the bar. Defaults to [].
• on_query_change (:any) - Callback when the query field is changed. Defaults to nil.
• on_query_clear (:any) - Callback when the clear button is triggered. Defaults to nil.
• on_clear_all (:any) - Callback when the reset all button is pressed. Defaults to nil.
• on_toggle_filter (:any) - Callback for when a filter is applied or unapplied. Defaults to nil.
• on_query_blur (:any) - Callback when the query field is blurred. Defaults to nil.
• on_query_focus (:any) - Callback when the query field is focused. Defaults to nil.
• disabled (:boolean) - Disable all filters. Defaults to false.
• hide_filters (:boolean) - Hide filter bar for applied filters. Defaults to false.
• hide_query_field (:boolean) - Hide the query field. Defaults to false.
• disable_query_field (:boolean) - Disable the query field. Defaults to false.
• disable_filters (:boolean) - Disable the filters. Defaults to false.
• borderless_query_field (:boolean) - Whether the text field should be borderless. Should be true when used as part of the IndexFilters component. Defaults to false.
• loading (:boolean) - Whether an asyncronous task is currently being run. Defaults to false.

Slots

• query_bar
• filter_bar

Attributes

• id (:string) (required)
• filters (:list) - Available filters added to the filter bar. Shortcut filters are pinned to the front of the bar. Defaults to [].
• on_clear_all (:any) - Callback when the reset all button is pressed. Defaults to nil.
• on_toggle_filter (:any) - Callback for when a filter is applied or unapplied. Defaults to nil.
• disabled (:boolean) - Disable all filters. Defaults to false.
• hide_query_field (:boolean) - Hide the query field. Defaults to false.
• disable_filters (:boolean) - Disable the filters. Defaults to false.
• on_add_filter_click (:any) - Callback when the add filter button is clicked. Defaults to nil.
• close_on_child_overlay_click (:boolean) - Whether the filter should close when clicking inside another Popover. Defaults to false.

Slots

• inner_block

Attributes

• id (:string) - Defaults to nil.
• query_form (Phoenix.HTML.Form) - Defaults to nil.
• phx_submit (:any) - Defaults to nil.
• phx_change (:any) - Defaults to nil.
• phx_focus (:any) - Defaults to nil.
• phx_blur (:any) - Defaults to nil.
• on_clear (:any) - Defaults to nil.
• focused (:boolean) - Defaults to false.
• placeholder (:string) - Defaults to nil.
• disabled (:boolean) - Defaults to false.
• borderless_query_field (:boolean) - Defaults to false.
• loading (:boolean) - Show a loading spinner to the right of the input. Defaults to false.

Slots

• inner_block