# `MishkaDocument.Dashboard.Widgets.WorkspacesSummary`
[🔗](https://github.com/mishka-group/mishka_document/blob/v0.0.1/lib/mishka_document/dashboard/widgets/workspaces_summary.ex#L5)

Dashboard widget (a `dashboard:widgets` plugin): the full-width dark "Documents" summary panel —
a docstats row of totals for workspaces, versions, sections, section drafts, issues, note drafts,
and the set of primary languages. Every total is counted as the viewer through
`MishkaDocument.Dashboard.Scope`: a master counts every site's documents, a site's admin only
their own site's, and a total whose resource belongs to an area the viewer does not hold is `0`.
Offered to holders of `admin:dashboard:document:workspace`.

Unlike the white list/stat widgets this one renders its OWN dark shell (bleeding to the card edges
with `-m-5`) instead of `Widget.card_header`/`Widget.card_footer`.

# `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), read as 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*