Admin sidebar tabs for this module.

Each tab needs at minimum: :id, :label, :path, :level, :permission.

Key fields:

• :id — unique atom across ALL modules (prefix with :admin_yourmodule)
• :path — must start with /admin and use hyphens, not underscores
• :permission — must match module_key/0 so custom roles get proper access
• :group — use :admin_modules to appear in the Modules section of the sidebar
• :priority — controls sort order (higher = further down). Built-in modules use 500-620; use 640+ for external modules
• :live_view — {Module, :action} tuple; PhoenixKit auto-generates the route
• :icon — Heroicon name (optional, shown in sidebar)
• :match — :exact or :prefix for active-state highlighting

Return [] to have no admin tabs (default).

OTP apps whose templates Tailwind should scan for CSS classes.

Disables the module. Same pattern as enable_system/0.

Enables the module by persisting a boolean setting.

update_boolean_setting_with_module/3 stores the value and tracks which module owns the setting. The third argument must match module_key/0.

Whether the module is currently enabled.

Reads from the DB-backed settings table. Defensive against three failure modes that can hit before/around DB availability:

• rescue _: DB not running, table missing, schema mismatch, etc.
• catch :exit, _: connection pool checkout EXIT (e.g. when a test sandbox owner has just stopped — test-environment artifact, but harmless to handle in production code too).

All branches return false so callers don't need to special-case startup ordering.

Unique key for this module. Used in settings, permissions, and PubSub events.

Display name shown in the admin UI.

Notification types this module contributes.

Each type becomes a per-user toggle in notification preferences. actions maps the activity action strings this module emits to the type, so a user who mutes "Hello World" stops receiving those notifications.

Optionally declare sub_types for finer control: the base type then acts as a master switch (off ⇒ every sub muted) and each sub is individually toggleable (see PhoenixKit.Notifications.Types). Sub keys are bare here ("greetings") and composed to "hello_world.greetings" at registration. When a type is fully split, leave its own actions: [] so every action is owned by exactly one sub. See the Notifications admin page (Web.NotificationsLive) for the senders.

Permission metadata for the roles/permissions matrix.

The :key MUST match module_key/0 — PhoenixKit validates this at startup. Icons use the hero- prefix (Heroicons via phoenix_heroicons).

Return nil to opt out of the permissions system entirely (default).

@spec resolve_comment_resources([binary()]) :: %{required(binary()) => map()}

Optional integration with phoenix_kit_comments: make this module's resources clickable in the comments moderation admin.

If your module owns things that users comment on (the resource_type you pass to the comments component), implement resolve_comment_resources/1 to turn a list of resource uuids into display chips. Return %{uuid => info} where info is:

• :title — the chip label (e.g. the record's name)
• :path — a raw app path, e.g. "/admin/widgets/#{uuid}". The comments module runs it through PhoenixKit.Utils.Routes.path/1 itself (prefix + locale), so do NOT pre-apply the prefix here or the link double-prefixes.
• :thumb_url — optional image URL for a thumbnail (otherwise a type badge shows). Omit the key when there's none.

Then register the handler so comments dispatches "hello_world" resources to this module:

# config/config.exs
config :phoenix_kit, :comment_resource_handlers, %{
  "hello_world" => PhoenixKitHelloWorld
}

A real implementation queries your schema:

def resolve_comment_resources(uuids) do
  import Ecto.Query

  from(w in Widget, where: w.uuid in ^uuids, select: {w.uuid, w.name})
  |> Repo.all()
  |> Map.new(fn {uuid, name} ->
    {uuid, %{title: name, path: "/admin/widgets/#{uuid}"}}
  end)
rescue
  _ -> %{}
end

Hello World has no resources of its own, so this returns an empty map. Hosts can also link a type with no code via Settings → Comments → Resource Paths (a path template like /admin/widgets/:uuid).

Version string. Shown on the admin Modules page.