PhoenixKitDashboards.Web.Helpers (PhoenixKitDashboards v0.2.0)

Copy Markdown View Source

Cross-cutting helpers shared by the Dashboards LiveViews.

actor_opts/1 is the canonical way to thread the acting user's uuid into context mutations that accept a trailing opts \ [] (for activity logging).

Summary

Functions

Keyword opts threading the acting user's uuid into context mutations.

The current user's uuid from socket assigns, or nil.

All roles (for pickers); [] when the roles API is unavailable.

Translated label for a dashboard scope enum value.

Dynamic translation for catalog DATA (widget names, descriptions, view names, settings labels — plain strings from the provider contract). Falls back to the input when no translation exists, so provider strings pass through.

The current user's role uuids, mapped from the scope's cached role names — used by both LiveViews to resolve role-scoped dashboard visibility. Reuses a @roles assign if present, else queries core once. [] when roles are unavailable.

Functions

actor_opts(socket)

@spec actor_opts(Phoenix.LiveView.Socket.t()) :: keyword()

Keyword opts threading the acting user's uuid into context mutations.

Returns [actor_uuid: uuid], or [] when there is no current user (so the context call is unaffected).

actor_uuid(socket)

@spec actor_uuid(Phoenix.LiveView.Socket.t()) :: String.t() | nil

The current user's uuid from socket assigns, or nil.

list_roles()

@spec list_roles() :: [struct()]

All roles (for pickers); [] when the roles API is unavailable.

scope_label(other)

@spec scope_label(String.t()) :: String.t()

Translated label for a dashboard scope enum value.

translate_catalog(string)

@spec translate_catalog(String.t() | nil) :: String.t() | nil

Dynamic translation for catalog DATA (widget names, descriptions, view names, settings labels — plain strings from the provider contract). Falls back to the input when no translation exists, so provider strings pass through.

user_role_uuids(socket)

@spec user_role_uuids(Phoenix.LiveView.Socket.t()) :: [String.t()]

The current user's role uuids, mapped from the scope's cached role names — used by both LiveViews to resolve role-scoped dashboard visibility. Reuses a @roles assign if present, else queries core once. [] when roles are unavailable.