API Reference PhoenixKitDashboards v#0.1.0

Copy Markdown View Source

Modules

Customizable dashboards for PhoenixKit.

The responsive grid breakpoint tiers, with a per-device column count.

Context for dashboard pages and their widget layouts.

Pure cell-placement math for grid dashboards.

Read/write a widget instance's geometry in the embedded item shape

Centralized path helpers for the Dashboards module.

Discovers and caches the widget catalog.

A dashboard page: an ordered set of placed widgets owned by a user (personal) or by the system / a role (shared).

The dashboard builder — a responsive, server-rendered grid of widgets that can be added from the catalog, reordered, resized, configured, and removed.

Manage page — lists the current user's personal dashboards, all shared (system) dashboards, and any role-scoped dashboards for the user's roles. Admins can create a personal, shared (system), or by-role dashboard, clone any visible dashboard into a private editable copy, open the builder, or delete (own personal ones + shared/role ones).

Cross-cutting helpers shared by the Dashboards LiveViews.

A widget type — the catalog entry that describes a kind of widget that can be placed on a dashboard.

The built-in widget catalog shipped with this module.

Built-in "Clock" widget — the current time, ticking live, in one of three views, with a per-instance timezone.

Built-in "Module stats" widget — renders the get_config/0 map of any discovered PhoenixKit module, selected by its module_key setting.

Built-in "Note" widget — a title + free-text body from its settings, with the body rendered as Markdown (GFM, XSS-sanitized via core's <.markdown>), so links, lists and emphasis actually work in a pinned note.