Aurora.Uix.Templates.Basic.Components.FilteringComponents (Aurora UIX v0.1.5)

Copy Markdown

Provides filter input components with standardized styling and behavior.

Key features:

  • Automatically handles filterable? fields with consistent styling
  • Falls back to empty render for non-filterable? fields
  • Applies standardized focus styles and responsive sizing

Components in this module can be overridden at runtime by configuring config :aurora_uix, :basic_filtering_components, MyApp.MyFilteringComponents.

Summary

Functions

Renders a styled filter input field for filterable? fields.

Functions

components_override()

filter_field(assigns)

@spec filter_field(map()) :: Phoenix.LiveView.Rendered.t()
@spec filter_field(map()) :: Phoenix.LiveView.Rendered.t()

Renders a styled filter input field for filterable? fields.

Parameters

  • assigns (map): Phoenix LiveView assigns containing:
    • field (map): Field configuration with:
      • :filterable? (boolean): Required flag to enable filtering
      • Other field attributes are passed through to input

Returns

Only renders when field.filterable? is true, otherwise returns empty content.

Attributes

  • field (:map) (required)
  • filter (:any) - Defaults to nil.
  • auix (:map) - Defaults to %{}.
  • infix (:string) - Defaults to "".
  • host_components (:any)