Incant.Filter behaviour (incant v0.1.0)

Behaviour and dispatcher for Incant table filters.

Summary

context()

queryable()

row()

value()

Applies a list of filters to a queryable using submitted filter values.

Applies a filter value to a queryable.

Renders a filter control.

Returns whether an in-memory row matches a filter value.

module(filter)

Resolves the module responsible for a filter.

@type context() :: term()

@type queryable() :: term()

@type row() :: map()

@type value() :: term()

@callback apply_query(Incant.Table.Filter.t(), queryable(), value(), context()) ::
  queryable()

@callback control(Incant.Table.Filter.t(), value(), map()) ::
  Phoenix.LiveView.Rendered.t()

@callback match?(Incant.Table.Filter.t(), row(), value()) :: boolean()

Applies a list of filters to a queryable using submitted filter values.

Applies a filter value to a queryable.

Renders a filter control.

Returns whether an in-memory row matches a filter value.

Resolves the module responsible for a filter.