# `MishkaCmsCore.Dashboard.Widgets.SiteOverview`
[🔗](https://github.com/mishka-group/mishka_cms_core/blob/v0.0.1/lib/mishka_cms_core/dashboard/widgets/site_overview.ex#L5)

Dashboard widget (a `dashboard:widgets` plugin): a master sees the fleet — the site total with an
active/inactive split, a per-mode breakdown (API Only / Phoenix Only / Hybrid) and the average
compiled bundle size (gzip CSS + JS); a tenant admin sees the same identity card scoped to their own
site. Site counts come from `MishkaCmsCore.Runtime.States.SiteState` (ETS) and bundle sizes from
`MishkaCmsCore.Runtime.States.AssetsState` (ETS).

See `MishkaCmsCore.Dashboard.Widget` for the shared card primitives this composes.

A mode dot's colour is one of three, so `dot_class/1` writes each out whole and it can be a class.
A bundle bar's width cannot: `pct/2` derives it from the measured bundle, and Tailwind generates
rules from SOURCE TEXT, so a class assembled around a value that only exists at render time gets no
rule at all and the bar draws with no width. That width rides an inline `style` attribute, which is
why the policy in `MishkaCmsCore.Runtime.Plugs.SecurityHeaders` keeps `style-src-attr` permitted —
see `MishkaCmsWeb.InterpolatedClassTest`.

# `error_return`

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

# `okey_return`

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

# `child_spec`

Returns a specification to start this module under a supervisor.

See `Supervisor`.

# `config`

```elixir
@spec config() :: keyword()
```

# `config`

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

# `enable`

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

# `get`

```elixir
@spec get() :: keyword()
```

# `health_check`

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

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

# `load`

Loads this widget's data off the dashboard render (in a Task), scoped to the viewer.

# `on_dependency_error`

```elixir
@spec on_dependency_error(term()) :: term()
```

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

# `register`

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

# `render`

# `restart`

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

# `start`

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

# `start_link`

# `stop`

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

# `unregister`

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

# `widget`

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

This widget's descriptor.

---

*Consult [api-reference.md](api-reference.md) for complete listing*