ui

Documentation

Overview

Package ui provides shared UI constants and utilities.

Index

• Constants
• type Base
  • func (b Base) Height() int
  • func (b Base) IsFocused() bool
  • func (b Base) ListHeight(overhead int) int
  • func (b *Base) SetFocused(focused bool)
  • func (b *Base) SetSize(width, height int)
  • func (b Base) Size() (width, height int)
  • func (b Base) Width() int

Constants

const (
	// ScrollMargin is the number of items to keep visible above/below the cursor.
	ScrollMargin = 5

	// BorderHeight is the vertical space consumed by a standard panel border.
	BorderHeight = 2

	// HeaderHeight is the space for header + separator in panels.
	HeaderHeight = 2

	// PanelOverhead is the total vertical overhead (border + header + separator).
	// Used to calculate available list height: listHeight = panelHeight - PanelOverhead
	PanelOverhead = BorderHeight + HeaderHeight

	// ColumnWidthDivisor determines the width ratio between current and preview columns.
	// Current column gets 1/ColumnWidthDivisor of the width.
	ColumnWidthDivisor = 3

	// MinProgressBarWidth is the minimum width for a usable progress bar.
	MinProgressBarWidth = 5

	// MinExpandedWidth is the minimum width for expanded player bar mode.
	MinExpandedWidth = 40
)

Layout constants for consistent sizing across UI components.

Types

type Base

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

Base provides common UI component functionality for focus and size management. Embed this in component models to get standard methods automatically.

Example:

type Model struct {
    ui.Base
    cursor cursor.Cursor
    items  []Item
}

func (Base) Height

func (b Base) Height() int

Height returns the component height.

func (Base) IsFocused

func (b Base) IsFocused() bool

IsFocused returns whether the component is focused.

func (Base) ListHeight

func (b Base) ListHeight(overhead int) int

ListHeight returns available height for list content after subtracting overhead.

func (*Base) SetFocused

func (b *Base) SetFocused(focused bool)

SetFocused sets whether the component is focused.

func (*Base) SetSize

func (b *Base) SetSize(width, height int)

SetSize sets the component dimensions.

func (Base) Size

func (b Base) Size() (width, height int)

Size returns the component dimensions.

func (Base) Width

func (b Base) Width() int

Width returns the component width.