Skip to content

Dashboards

v0.8.0

Build admin dashboard pages from widgets that any module exposes

Install Dashboards

Compose dashboard pages from widgets contributed by any PhoenixKit module or by the host app. A grid dashboard has named layouts sized to one screen (for example Desktop or Wall TV); a second type is a free pixel canvas. Dashboards are stored per user, per role or system-wide in the phoenix_kit_dashboards table.

Use it when

  • You want a wall-screen or landing dashboard combining data from several modules
  • Your own module or app wants to offer widgets without depending on the dashboards package

What it gives you

  • Manage page at /admin/dashboards and a grid builder per dashboard
  • Grid layouts on a 25px cell lattice and a pixel canvas mode
  • Personal, shared and per-role dashboards with per-user cloning
  • Built-in Note, Clock and Module stats widgets
  • Widget contract phoenix_kit_widgets/0, also for host-app providers
  • Works without JavaScript; drag and resize as progressive enhancement

Example

From the README
config :phoenix_kit_dashboards, widget_providers: [MyAppWeb.Widgets]

Dashboards news

Nothing posted about Dashboards yet. Read its changelog or see all PhoenixKit news.

Install

1 Add to mix.exs

deps
{:phoenix_kit_dashboards, "~> 0.8"}

2 Fetch it and run its migrations

Terminal
$ mix deps.get && mix phoenix_kit.update

3 Switch it on in /admin/modules

Releases
  1. 0.8.0
  2. 0.7.0
  3. 0.6.0
Admin
/admin/dashboards

Related modules

What it needs, what builds on it, and its neighbours in Platform & tools.