LiveFilter.SortField (LiveFilter v0.2.0)

Copy Markdown View Source

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

Summary

Types

t()

Types

t()

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