MishkaCmsCore.Dashboard.Widgets.OverviewMetrics (Mishka CMS Core v0.0.1)

Copy Markdown View Source

Dashboard widget (a dashboard:widgets plugin): the full-width dark KPI band at the top of the board — Sites, Users, Drafts, Open issues, Bloggers, Versions. Anyone holding anything on the dashboard sees the band; a tile shows its count only to whoever may see the card it comes from, and — to anyone else.

It's a :panel widget (renders its own edge-to-edge dark surface, no white card), registered and ordered like every other widget so an admin can reorder or hide it. Counts are aggregated from the sibling widgets' load/1, resolved at runtime (Module.concat + Code.ensure_loaded?) so core keeps no compile-time dependency on the blog/document extensions — a KPI whose source extension isn't installed simply falls back to —.

A tile's accent is a colour on the row, but it reaches the markup as a whole class through ink_class/1 and dot_class/1 rather than as a style attribute: CSP has no nonce for an attribute, so style-src-attr can only be closed by there being none. Written out one clause per colour because Tailwind reads source text — an interpolated class name has no rule at all, which is what MishkaCmsWeb.InterpolatedClassTest guards.

Summary

Functions

Returns a specification to start this module under a supervisor.

Callback implementation for MishkaInstaller.Event.Hook.enable/0.

Callback implementation for MishkaInstaller.Event.Hook.get/0.

Optional. See MishkaInstaller.Event.Hook.health_check/0. Override to report health.

Loads the six KPI tiles, each count resolved from its source widget (runtime-guarded).

Callback implementation for MishkaInstaller.Event.Hook.register/0.

Callback implementation for MishkaInstaller.Event.Hook.restart/0.

Callback implementation for MishkaInstaller.Event.Hook.start/0.

Callback implementation for MishkaInstaller.Event.Hook.stop/0.

This widget's descriptor.

Types

error_return()

@type error_return() ::
  {:error, [%{action: atom(), field: atom(), message: String.t()}]}

okey_return()

@type okey_return() :: {:ok, struct() | map() | module() | [any()]}

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

config()

@spec config() :: keyword()

config(key)

@spec config(atom()) :: any()

enable()

@spec enable() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.enable/0.

get()

@spec get() :: keyword()

Callback implementation for MishkaInstaller.Event.Hook.get/0.

health_check()

@spec health_check() :: :ok | {:degraded, term()} | {:error, term()}

Optional. See MishkaInstaller.Event.Hook.health_check/0. Override to report health.

load(user)

Loads the six KPI tiles, each count resolved from its source widget (runtime-guarded).

on_dependency_error(error)

@spec on_dependency_error(term()) :: term()

Optional. See MishkaInstaller.Event.Hook.on_dependency_error/1. Override to react.

register()

@spec register() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.register/0.

render(assigns)

restart()

@spec restart() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.restart/0.

start()

@spec start() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.start/0.

start_link(args \\ [])

stop()

@spec stop() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.stop/0.

unregister()

@spec unregister() :: okey_return() | error_return()

Callback implementation for MishkaInstaller.Event.Hook.unregister/0.

widget()

@spec widget() :: MishkaCmsCore.Dashboard.Widget.t()

This widget's descriptor.