# `LiveFilter.SortField`
[🔗](https://github.com/agoodway/livefilter/blob/v0.2.0/lib/live_filter/sort_field.ex#L1)

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).

# `t`

```elixir
@type t() :: %LiveFilter.SortField{
  default_direction: :asc | :desc,
  field: atom(),
  label: String.t(),
  nulls: nil | :first | :last,
  query_field: atom() | nil
}
```

---

*Consult [api-reference.md](api-reference.md) for complete listing*