breadcrumb

Documentation

Overview

Package Breadcrumb is a component that consumes a pointer ot a navstack.Model and renders a breadcrumb trail. It is used to give the user a sense of where they are in the application.

Index

• type BreadcrumbStyles
  • func DefaultStyles() BreadcrumbStyles
• type Model
  • func New(n *navstack.Model) Model
  • func (m Model) Init() tea.Cmd
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string

Types

type BreadcrumbStyles

type BreadcrumbStyles struct {
	Frame     lipgloss.Style
	Delimiter string
}

func DefaultStyles

func DefaultStyles() BreadcrumbStyles

type Model

type Model struct {
	Navstack *navstack.Model
	Styles   BreadcrumbStyles
}

func New

func New(n *navstack.Model) Model

func (Model) Init

func (m Model) Init() tea.Cmd

func (Model) Update

func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (Model) View

func (m Model) View() string