panes

Documentation

Index

• Constants
• type AlignmentHorizontal
  • func ToAlignmentHorizontal(raw string) (AlignmentHorizontal, error)
• type AlignmentVertical
  • func ToAlignmentVertical(raw string) (AlignmentVertical, error)
• type Direction
• type Pane
  • func NewLeaf(m tea.Model) Pane
  • func NewNode(direction Direction, children ...Pane) Pane
  • func (m Pane) Children() []Pane
  • func (m Pane) Height() int
  • func (m Pane) Init() tea.Cmd
  • func (m Pane) Update(msg tea.Msg) (Pane, tea.Cmd)
  • func (m Pane) View() string
  • func (m Pane) Width() int
  • func (m Pane) WithAlignment(vertical AlignmentVertical, horizontal AlignmentHorizontal) Pane
  • func (m Pane) WithDimensions(width, height int) (Pane, tea.Cmd)
  • func (m Pane) WithDirection(direction Direction) Pane
  • func (p Pane) WithName(name string) Pane
• type ViewableSizeMsg

Constants

const (
	AlignmentVerticalTop    AlignmentVertical = "top"
	AlignmentVerticalCenter AlignmentVertical = "center"
	AlignmentVerticalBottom AlignmentVertical = "bottom"

	AlignmentHorizontalLeft   AlignmentHorizontal = "left"
	AlignmentHorizontalCenter AlignmentHorizontal = "center"
	AlignmentHorizontalRight  AlignmentHorizontal = "right"
)

Types

type AlignmentHorizontal

type AlignmentHorizontal string

func ToAlignmentHorizontal

func ToAlignmentHorizontal(raw string) (AlignmentHorizontal, error)

type AlignmentVertical

type AlignmentVertical string

func ToAlignmentVertical

func ToAlignmentVertical(raw string) (AlignmentVertical, error)

type Direction

type Direction int

const (
	DirectionVertical Direction = iota
	DirectionHorizontal
)

type Pane

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

func NewLeaf

func NewLeaf(m tea.Model) Pane

NewModel creates a new pane containing the given model.

func NewNode

func NewNode(direction Direction, children ...Pane) Pane

NewNode creates a new pane containing the given children.

func (Pane) Children

func (m Pane) Children() []Pane

func (Pane) Height

func (m Pane) Height() int

func (Pane) Init

func (m Pane) Init() tea.Cmd

func (Pane) Update

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

func (Pane) View

func (m Pane) View() string

func (Pane) Width

func (m Pane) Width() int

func (Pane) WithAlignment

func (m Pane) WithAlignment(vertical AlignmentVertical, horizontal AlignmentHorizontal) Pane

func (Pane) WithDimensions

func (m Pane) WithDimensions(width, height int) (Pane, tea.Cmd)

func (Pane) WithDirection

func (m Pane) WithDirection(direction Direction) Pane

func (Pane) WithName

func (p Pane) WithName(name string) Pane

type ViewableSizeMsg

type ViewableSizeMsg struct {
	Width  int
	Height int
}