pane

Documentation

Index

• type Model
  • func NewModel(isActive, borderless bool, ...) Model
  • func (m Model) GetHeight() int
  • func (m Model) GetHorizontalFrameSize() int
  • func (m Model) GetIsActive() bool
  • func (m Model) GetWidth() int
  • func (m Model) GetYOffset() int
  • func (m *Model) GotoBottom()
  • func (m *Model) GotoTop()
  • func (m *Model) LineDown(lines int)
  • func (m *Model) LineUp(lines int)
  • func (m *Model) SetActive(isActive bool)
  • func (m *Model) SetContent(content string)
  • func (m *Model) SetSize(width, height int)
  • func (m *Model) ShowAlternateBorder(show bool)
  • func (m *Model) ShowSpinner(show bool)
  • func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)
  • func (m Model) View() string

Types

type Model

type Model struct {
	Viewport            viewport.Model
	Style               lipgloss.Style
	IsActive            bool
	Borderless          bool
	AlternateBorder     bool
	ShowLoading         bool
	ActiveBorderColor   lipgloss.AdaptiveColor
	InactiveBorderColor lipgloss.AdaptiveColor
	Spinner             spinner.Model
}

Model is a struct to represent the properties of a pane.

func NewModel

func NewModel(isActive, borderless bool, activeBorderColor, inactiveBorderColor lipgloss.AdaptiveColor) Model

NewModel creates an instance of a pane.

func (Model) GetHeight

func (m Model) GetHeight() int

GetHeight returns the height of the pane.

func (Model) GetHorizontalFrameSize

func (m Model) GetHorizontalFrameSize() int

GetHorizontalFrameSize returns the horizontal frame size of the pane.

func (Model) GetIsActive

func (m Model) GetIsActive() bool

GetIsActive returns the active state of the pane.

func (Model) GetWidth

func (m Model) GetWidth() int

GetWidth returns the width of the pane.

func (Model) GetYOffset

func (m Model) GetYOffset() int

GetYOffset returns the y offset of the pane.

func (*Model) GotoBottom

func (m *Model) GotoBottom()

GotoBottom goes to the bottom of the pane.

func (*Model) GotoTop

func (m *Model) GotoTop()

GotoTop goes to the top of the pane.

func (*Model) LineDown

func (m *Model) LineDown(lines int)

LineDown scrolls the pane down the specified number of lines.

func (*Model) LineUp

func (m *Model) LineUp(lines int)

LineUp scrolls the pane up the specified number of lines.

func (*Model) SetActive

func (m *Model) SetActive(isActive bool)

SetActive sets the active state of the pane.

func (*Model) SetContent

func (m *Model) SetContent(content string)

SetContent sets the content of the pane.

func (*Model) SetSize

func (m *Model) SetSize(width, height int)

SetSize sets the size of the pane and its viewport, useful when resizing the terminal.

func (*Model) ShowAlternateBorder

func (m *Model) ShowAlternateBorder(show bool)

SetActiveBorderColors sets the active border colors.

func (*Model) ShowSpinner

func (m *Model) ShowSpinner(show bool)

ShowSpinner determines wether to show the spinner or not.

func (Model) Update

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

Update updates the pane.

func (Model) View

func (m Model) View() string

View returns a string representation of the pane.