shell

Documentation

Overview

Package Shell is a basic wrapper around the navstack and breadcrumb packages It provides a basic navigation mechanism while showing breadcrumb view of where the user is within the navigation stack.

Index

• type Model
  • func New() 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 Model

type Model struct {
	Navstack   *navstack.Model
	Breadcrumb breadcrumb.Model
	// contains filtered or unexported fields
}

func New

func New() Model

New creates a new shell model

func (Model) Init

func (m Model) Init() tea.Cmd

Init determines the size of the widow used by the navigation stack.

func (Model) Update

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

Update passes messages to the navigation stack.

func (Model) View

func (m Model) View() string

View renders the breadcrumb and the navigation stack.