memEx/lib/memex_web/components/table_component.ex

112 lines
3.4 KiB
Elixir
Raw Normal View History

2022-07-25 19:31:54 -04:00
defmodule MemexWeb.Components.TableComponent do
2022-03-05 23:13:37 -05:00
@moduledoc """
Livecomponent that presents a resortable table
It takes the following required assigns:
- `:columns`: An array of maps containing the following keys
- `:label`: A gettext'd or otherwise user-facing string label for the
column. Can be nil
2022-11-16 23:05:59 -05:00
- `:key`: An atom key used for sorting
2022-03-05 23:13:37 -05:00
- `:class`: Extra classes to be applied to the column element, if desired.
Optional
- `:sortable`: If false, will prevent the user from sorting with it.
Optional
- `:values`: An array of maps containing data for each row. Each map is
string-keyed with the associated column key to the following values:
- A single element, like string, integer or Phoenix.LiveView.Rendered
object, like returned from the ~H sigil
- A tuple, containing a custom value used for sorting, and the displayed
content.
"""
2022-07-25 19:31:54 -04:00
use MemexWeb, :live_component
2022-03-05 23:13:37 -05:00
alias Phoenix.LiveView.Socket
2022-11-16 23:05:59 -05:00
require Integer
2022-03-05 23:13:37 -05:00
@impl true
@spec update(
%{
required(:columns) =>
list(%{
required(:label) => String.t() | nil,
2022-11-16 23:05:59 -05:00
required(:key) => atom() | nil,
2022-03-05 23:13:37 -05:00
optional(:class) => String.t(),
2022-11-16 23:05:59 -05:00
optional(:row_class) => String.t(),
optional(:alternate_row_class) => String.t(),
2022-03-05 23:13:37 -05:00
optional(:sortable) => false
}),
required(:rows) =>
list(%{
2022-11-16 23:05:59 -05:00
(key :: atom()) => any() | {custom_sort_value :: String.t(), value :: any()}
2022-03-05 23:13:37 -05:00
}),
2022-11-16 23:05:59 -05:00
optional(:inital_key) => atom(),
optional(:initial_sort_mode) => atom(),
2022-03-05 23:13:37 -05:00
optional(any()) => any()
},
Socket.t()
) :: {:ok, Socket.t()}
def update(%{columns: columns, rows: rows} = assigns, socket) do
2022-11-16 23:05:59 -05:00
initial_key =
if assigns |> Map.has_key?(:initial_key) do
assigns.initial_key
else
columns |> List.first(%{}) |> Map.get(:key)
end
initial_sort_mode =
if assigns |> Map.has_key?(:initial_sort_mode) do
assigns.initial_sort_mode
else
:asc
end
rows = rows |> sort_by_custom_sort_value_or_value(initial_key, initial_sort_mode)
2022-03-05 23:13:37 -05:00
socket =
socket
|> assign(assigns)
2022-11-16 23:05:59 -05:00
|> assign(
columns: columns,
rows: rows,
last_sort_key: initial_key,
sort_mode: initial_sort_mode
)
2022-11-17 22:24:28 -05:00
|> assign_new(:row_class, fn -> "bg-primary-900" end)
|> assign_new(:alternate_row_class, fn -> "bg-primary-900" end)
2022-03-05 23:13:37 -05:00
{:ok, socket}
end
@impl true
def handle_event(
"sort_by",
%{"sort-key" => key},
2022-11-16 23:05:59 -05:00
%{assigns: %{rows: rows, last_sort_key: last_sort_key, sort_mode: sort_mode}} = socket
2022-03-05 23:13:37 -05:00
) do
2022-11-16 23:05:59 -05:00
key = key |> String.to_existing_atom()
2022-03-05 23:13:37 -05:00
2022-11-16 23:05:59 -05:00
sort_mode =
case {key, sort_mode} do
{^last_sort_key, :asc} -> :desc
{^last_sort_key, :desc} -> :asc
{_new_sort_key, _last_sort_mode} -> :asc
end
rows = rows |> sort_by_custom_sort_value_or_value(key, sort_mode)
{:noreply, socket |> assign(last_sort_key: key, sort_mode: sort_mode, rows: rows)}
2022-03-05 23:13:37 -05:00
end
defp sort_by_custom_sort_value_or_value(rows, key, sort_mode) do
rows
|> Enum.sort_by(
fn row ->
case row |> Map.get(key) do
{custom_sort_key, _value} -> custom_sort_key
value -> value
end
end,
sort_mode
)
end
end