Documentation
¶
Overview ¶
Package list provides list components for displaying items in ordered or unordered lists with various styling options.
Basic Usage ¶
list.List(
list.ListItem(g.Text("Item 1")),
list.ListItem(g.Text("Item 2")),
list.ListItem(g.Text("Item 3")),
)
With Icons ¶
list.List(
list.Icons(),
list.ListItem(
icons.Check(),
g.Text("Completed task"),
),
)
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func List ¶
List creates an unordered list component.
Example:
list.List(list.Spaced())(
list.ListItem(g.Text("First item")),
list.ListItem(g.Text("Second item")),
)
func ListItem ¶
func ListItem(opts ...ItemOption) func(...g.Node) g.Node
ListItem creates a list item component.
Example:
// Simple item
list.ListItem()(g.Text("Simple item"))
// Item with icon
list.ListItem()(
icons.Check(),
g.Text("Completed task"),
)
// Detailed item
list.ListItem(list.Detailed())(
html.Div(
html.Class("font-medium"),
g.Text("Item title"),
),
html.Div(
html.Class("text-sm text-muted-foreground"),
g.Text("Item description"),
),
)
// Card-style clickable item
list.ListItem(
list.CardStyle(),
list.WithItemOnClick("handleClick()"),
)(
icons.User(),
g.Text("User Name"),
badge.Badge(g.Text("Admin")),
)
Types ¶
type ItemOption ¶
type ItemOption func(*ItemProps)
ItemOption is a functional option for configuring the ListItem component.
func CardStyle ¶
func CardStyle() ItemOption
CardStyle creates a card-style list item with border and padding.
func Clickable ¶
func Clickable() ItemOption
Clickable makes the list item clickable with hover effects.
func Detailed ¶
func Detailed() ItemOption
Detailed creates a list item with space for subtitle/description.
func WithItemAttr ¶
func WithItemAttr(attrs ...g.Node) ItemOption
WithItemAttr adds custom HTML attributes to the list item.
func WithItemClass ¶
func WithItemClass(class string) ItemOption
WithItemClass adds additional CSS classes to the list item.
func WithItemOnClick ¶
func WithItemOnClick(handler string) ItemOption
WithItemOnClick adds a click handler to the list item.
func WithItemVariant ¶
func WithItemVariant(variant ItemVariant) ItemOption
WithItemVariant sets the list item variant.
type ItemProps ¶
type ItemProps struct {
Variant ItemVariant
Class string
Clickable bool
OnClick string
Attrs []g.Node
}
ItemProps defines the properties for the ListItem component.
type ItemVariant ¶
type ItemVariant string
ItemVariant represents the visual style of the list item.
const ( ItemSimple ItemVariant = "simple" // Simple text item ItemDetailed ItemVariant = "detailed" // Item with subtitle ItemCard ItemVariant = "card" // Card-style item with border )
type ListVariant ¶
type ListVariant string
ListVariant represents the visual style of the list.
const ( VariantBullets ListVariant = "bullets" // Default bullets VariantNone ListVariant = "none" // No markers VariantIcons ListVariant = "icons" // Icon markers )
Source Files