Documentation
¶
Overview ¶
Package breadcrumb provides breadcrumb navigation components following shadcn/ui patterns. Breadcrumbs show the current page's location within a navigational hierarchy.
Index ¶
- func Breadcrumb(children ...g.Node) g.Node
- func BreadcrumbWithOptions(opts []Option, children ...g.Node) g.Node
- func Ellipsis() g.Node
- func Item(href string, label g.Node) g.Node
- func Link(href string, label g.Node) g.Node
- func Page(label g.Node) g.Node
- func Separator() g.Node
- func SeparatorWithIcon(icon g.Node) g.Node
- type BreadcrumbProps
- type Option
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Breadcrumb ¶
Breadcrumb creates a breadcrumb navigation container
Example:
breadcrumb.Breadcrumb(
breadcrumb.Item("/", g.Text("Home")),
breadcrumb.Item("/docs", g.Text("Docs")),
breadcrumb.Page(g.Text("Components")),
)
func BreadcrumbWithOptions ¶
BreadcrumbWithOptions creates breadcrumb with custom options
func Ellipsis ¶
Ellipsis creates a breadcrumb ellipsis for collapsed items
Example:
breadcrumb.Ellipsis()
func Item ¶
Item creates a breadcrumb item with a link
Example:
breadcrumb.Item("/docs", g.Text("Documentation"))
func Link ¶
Link creates a breadcrumb link without the separator (for custom layouts)
Example:
breadcrumb.Link("/docs", g.Text("Documentation"))
func Page ¶
Page creates the current page breadcrumb (not a link)
Example:
breadcrumb.Page(g.Text("Current Page"))
Types ¶
type BreadcrumbProps ¶
type BreadcrumbProps struct {
Separator g.Node
MaxItems int // 0 means no limit
Class string
Attrs []g.Node
}
BreadcrumbProps defines breadcrumb configuration
type Option ¶
type Option func(*BreadcrumbProps)
Option is a functional option for configuring breadcrumbs
func WithMaxItems ¶
WithMaxItems sets maximum items to display (middle items collapse to ellipsis)
func WithSeparator ¶
WithSeparator sets custom separator (default is chevron)
Source Files