# `MishkaBlog.Dashboard.Widgets.Bloggers`
[🔗](https://github.com/mishka-group/mishka_blog/blob/v0.0.1/lib/mishka_blog/dashboard/widgets/bloggers.ex#L5)

Dashboard widget (a `dashboard:widgets` plugin): the top bloggers leaderboard — a podium of the
three most-published profiles plus the runners-up, each with their post tally and publish role
(`Blogger` + the `post_count` aggregate), read as the viewer through `MishkaBlog.Dashboard.Scope`:
a master ranks bloggers across every site, a site's admin only their own site's, and a viewer
without `admin:dashboard:blog:post` none.

How many bloggers the leaderboard ranks is the viewer's own setting — the card's gear in customize
mode, or Settings → Blog → Dashboard widgets, both writing the same per-user row
(`MishkaCmsCore.Dashboard.Widget.set_config/4`). The first three always fill the podium, so the
setting starts at three and everything past it becomes a runner-up row.

# `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 and sized by
their own "Bloggers to rank" setting. Called as `load/1` (a direct call, no dashboard) it uses the
declared default.

# `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*