From fd4fdcc36bfa6d4b04155361e2e195be7db88bd3 Mon Sep 17 00:00:00 2001 From: shibao Date: Sat, 5 Mar 2022 23:13:37 -0500 Subject: [PATCH] add table component --- lib/lokal_web/components/table_component.ex | 87 +++++++++++++++++++ .../components/table_component.html.heex | 52 +++++++++++ 2 files changed, 139 insertions(+) create mode 100644 lib/lokal_web/components/table_component.ex create mode 100644 lib/lokal_web/components/table_component.html.heex diff --git a/lib/lokal_web/components/table_component.ex b/lib/lokal_web/components/table_component.ex new file mode 100644 index 00000000..cdd0d6c9 --- /dev/null +++ b/lib/lokal_web/components/table_component.ex @@ -0,0 +1,87 @@ +defmodule LokalWeb.Components.TableComponent do + @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 + - `:key`: A string key used for sorting + - `: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. + """ + + use LokalWeb, :live_component + alias Phoenix.LiveView.Socket + + @impl true + @spec update( + %{ + required(:columns) => + list(%{ + required(:label) => String.t() | nil, + required(:key) => String.t() | nil, + optional(:class) => String.t(), + optional(:sortable) => false + }), + required(:rows) => + list(%{ + (key :: String.t()) => any() | {custom_sort_value :: String.t(), value :: any()} + }), + optional(any()) => any() + }, + Socket.t() + ) :: {:ok, Socket.t()} + def update(%{columns: columns, rows: rows} = assigns, socket) do + initial_key = columns |> List.first() |> Map.get(:key) + rows = rows |> Enum.sort_by(fn row -> row |> Map.get(initial_key) end, :asc) + + socket = + socket + |> assign(assigns) + |> assign(columns: columns, rows: rows, last_sort_key: initial_key, sort_mode: :asc) + + {:ok, socket} + end + + @impl true + def handle_event( + "sort_by", + %{"sort-key" => key}, + %{assigns: %{rows: rows, last_sort_key: key, sort_mode: sort_mode}} = socket + ) do + sort_mode = if sort_mode == :asc, do: :desc, else: :asc + rows = rows |> sort_by_custom_sort_value_or_value(key, sort_mode) + {:noreply, socket |> assign(sort_mode: sort_mode, rows: rows)} + end + + def handle_event( + "sort_by", + %{"sort-key" => key}, + %{assigns: %{rows: rows}} = socket + ) do + rows = rows |> sort_by_custom_sort_value_or_value(key, :asc) + {:noreply, socket |> assign(last_sort_key: key, sort_mode: :asc, rows: rows)} + 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 diff --git a/lib/lokal_web/components/table_component.html.heex b/lib/lokal_web/components/table_component.html.heex new file mode 100644 index 00000000..dadf158f --- /dev/null +++ b/lib/lokal_web/components/table_component.html.heex @@ -0,0 +1,52 @@ +
+ + + + <%= for %{key: key, label: label} = column <- @columns do %> + <%= if column |> Map.get(:sortable, true) do %> + + <% else %> + + <% end %> + <% end %> + + + + <%= for values <- @rows do %> + + <%= for %{key: key} = value <- @columns do %> + + <% end %> + + <% end %> + +
+ + <%= label %> + <%= if @last_sort_key == key do %> + <%= case @sort_mode do %> + <% :asc -> %> + + <% :desc -> %> + + <% end %> + <% else %> + + <% end %> + + + <%= label %> +
+ <%= case values |> Map.get(key) do %> + <% {_custom_sort_value, value} -> %> + <%= value %> + <% value -> %> + <%= value %> + <% end %> +
+