PhoenixLiveViewExt.Listilled.Helpers (phoenix_live_view_ext v1.2.2) View Source

Provides helper functions intended for use in LiveView and LiveComponent templates relying on Listilled assign lists.

Link to this section Summary

Functions

assign_list(socket, arg)

Assigns the listilled list assigns, list update and state version to the socket.

phx_update(atom)

Returns container phx-update attribute string based on the type of list update.

updated_sort(arg1)

Returns the sort instruction string (or nil if sorting not required).

Link to this section Types

listilled()

Specs

listilled() :: module()

Link to this section Functions

assign_list(socket, arg)

Specs

assign_list(
  Phoenix.LiveView.Socket.t(),
  {[PhoenixLiveViewExt.Listilled.assigns()],
   PhoenixLiveViewExt.Listiller.list_meta()}
) :: Phoenix.LiveView.Socket.t()

Assigns the listilled list assigns, list update and state version to the socket.

Uses the listilled name (a value return by Listilled.component_name/0 if defined, otherwise the last name of the module with the truncated "Component" suffix if any) and appends the following to form the atom keys:

<component_name>_list_assigns
<component_name>_list_update
<component_name>_list_version

phx_update(atom)

Specs

phx_update(PhoenixLiveViewExt.Listiller.list_update()) :: String.t()

Returns container phx-update attribute string based on the type of list update.

updated_sort(arg1)

Specs

updated_sort(PhoenixLiveViewExt.Listilled.updated()) :: String.t()

Returns the sort instruction string (or nil if sorting not required).