modal

Documentation

Index

• func PopMode() tea.Msg
• func PushMode(newMode tea.Model) tea.Cmd
• type Modal
  • func New(baseMode tea.Model) Modal
  • func (m Modal) Init() tea.Cmd
  • func (m Modal) Len() int
  • func (m *Modal) Pop() (p tea.Model)
  • func (m *Modal) Push(model tea.Model)
  • func (m Modal) Resize(w, h int) layout.ResizingModel
  • func (m Modal) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Modal) View() string

Functions

func PopMode

func PopMode() tea.Msg

PopMode pops the top-level mode from the modal stack. If there's no modes on the stack, this method does nothing.

func PushMode

func PushMode(newMode tea.Model) tea.Cmd

PushMode pushes a new mode on the modal stack. The new mode will receive keyboard events.

Types

type Modal

type Modal struct {
	// contains filtered or unexported fields
}

Modal is a tea model which displays modes on a stack. Only the top-level model is display and will receive keyboard and mouse events.

func New

func New(baseMode tea.Model) Modal

func (Modal) Init

func (m Modal) Init() tea.Cmd

func (Modal) Len

func (m Modal) Len() int

Len returns the number of models on the mode stack

func (*Modal) Pop

func (m *Modal) Pop() (p tea.Model)

Pop pops a model from the stack

func (*Modal) Push

func (m *Modal) Push(model tea.Model)

Push pushes a new model onto the modal stack

func (Modal) Resize

func (m Modal) Resize(w, h int) layout.ResizingModel

func (Modal) Update

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

func (Modal) View

func (m Modal) View() string