# LiveFilter v0.2.0 - Table of Contents

> Composable, URL-driven filtering for Phoenix LiveView with Linear/Notion-style filters and PostgREST-compatible parameters.

## Pages

- [LiveFilter](readme.md)

## Modules

- [LiveFilter](LiveFilter.md): Composable filter UI library for Phoenix LiveView.
- [LiveFilter.Bar](LiveFilter.Bar.md): LiveComponent that renders the filter bar UI.
- [LiveFilter.Components.AsyncSelect](LiveFilter.Components.AsyncSelect.md): Dropdown async select component with server-side search.
- [LiveFilter.Components.Boolean](LiveFilter.Components.Boolean.md): Boolean dropdown component with three options: Any, Yes, No.
- [LiveFilter.Components.Calendar](LiveFilter.Components.Calendar.md): Two-month calendar picker for custom date range selection.
- [LiveFilter.Components.DateRange](LiveFilter.Components.DateRange.md): Date range dropdown component with presets.
- [LiveFilter.Components.Datetime](LiveFilter.Components.Datetime.md): Datetime picker component with calendar and time selection.
- [LiveFilter.Components.Helpers](LiveFilter.Components.Helpers.md): Shared helper functions and icons for LiveFilter components.

- [LiveFilter.Components.MultiSelect](LiveFilter.Components.MultiSelect.md): Multi-select dropdown component with search support.
- [LiveFilter.Components.RadioGroup](LiveFilter.Components.RadioGroup.md): Radio group dropdown component supporting pills and radio button styles.
- [LiveFilter.Components.Select](LiveFilter.Components.Select.md): Dropdown select component with search support.
- [LiveFilter.DateUtils](LiveFilter.DateUtils.md): Date utility functions for LiveFilter.
Handles date range calculations for presets and custom ranges.

- [LiveFilter.Filter](LiveFilter.Filter.md): Represents an active filter instance with a unique ID, field, operator, value, and config reference.

- [LiveFilter.FilterConfig](LiveFilter.FilterConfig.md): Defines a filterable field — its type, allowed operators, label, and options.
- [LiveFilter.Operators](LiveFilter.Operators.md): Human-readable labels and per-type operator option lists for UI display.

- [LiveFilter.OptionHelpers](LiveFilter.OptionHelpers.md): Shared helpers for resolving and formatting filter options.
- [LiveFilter.Pagination](LiveFilter.Pagination.md): Pagination state with PostgREST-compatible limit/offset.
- [LiveFilter.Paginator](LiveFilter.Paginator.md): LiveComponent that renders pagination controls.
- [LiveFilter.Params.Parser](LiveFilter.Params.Parser.md): Converts PostgREST URL query params into a list of Filter structs,
matched against a provided filter config list.
- [LiveFilter.Params.Serializer](LiveFilter.Params.Serializer.md): Converts a list of active Filter structs into a PostgREST-compatible query param map.

- [LiveFilter.Params.Validator](LiveFilter.Params.Validator.md): Validates parsed filters for operator validity, value length limits, and list size limits.

- [LiveFilter.QueryBuilder](LiveFilter.QueryBuilder.md): Thin query builder that converts LiveFilter structs to PgRest AST maps
and delegates to `PgRest.Filter.apply_all/2`.

- [LiveFilter.Sort](LiveFilter.Sort.md): Sort state — a list of `LiveFilter.Sort.Entry` ordered by priority.
- [LiveFilter.Sort.Entry](LiveFilter.Sort.Entry.md): One sort rule: a public field, direction, optional DB column + nulls placement.
- [LiveFilter.SortComponents](LiveFilter.SortComponents.md): Styled, overridable sort UI over the headless `LiveFilter.Sort` helpers.
- [LiveFilter.SortField](LiveFilter.SortField.md): A declaration of a sortable field: the allow-list item the sort dropdown
lists and that `LiveFilter.sort_from_params/3` validates incoming `order=`
params against. Pass a static or runtime-built list (e.g. driven by a user's
table-column settings).

- [LiveFilter.Theme](LiveFilter.Theme.md): Theme definitions for LiveFilter command-style filter chips.
- [LiveFilter.Types](LiveFilter.Types.md): Type definitions for LiveFilter.