PhoenixKit.Dashboard.Group (phoenix_kit v1.7.71)

Struct representing a dashboard tab group.

Groups organize tabs in the dashboard sidebar. Each group has an ID, an optional label, and a priority for ordering.

Fields

id - Unique group identifier atom (e.g., :admin_main, :shop)
label - Optional display label (nil for unlabeled groups)
priority - Sort priority (lower = first, default: 100)
icon - Optional heroicon name (e.g., "hero-cube")
collapsible - Whether the group can be collapsed in the sidebar

Summary

Types

t()

Functions

new(attrs)

Creates a new group from a map or keyword list.

Types

t()

@type t() :: %PhoenixKit.Dashboard.Group{
  collapsible: boolean(),
  icon: String.t() | nil,
  id: atom(),
  label: String.t() | nil,
  priority: integer()
}

Functions

new(attrs)

@spec new(map() | keyword()) :: t()

Creates a new group from a map or keyword list.