terminu

package module

Go to main page

Versions in this module

v0

v0.4.12

Oct 22, 2026

v0.4.11

Oct 22, 2026

v0.4.10

Oct 22, 2026

v0.4.9

Oct 22, 2026

Changes in this version

type ModeKey

+ Item bool

+ Label string

+ MenuDesc string

v0.4.8

Oct 22, 2026

v0.4.7

Oct 22, 2026

Changes in this version

type App

+ func (a *App) CompareAction(p *Panel, l *List, c Compare) Action

+ type Compare struct

+ Can func(Row) bool

+ Key string

+ Name func(Row) string

+ Split *bool

+ Text func(Row) (string, error)

type ModeKey

+ Disabled func() bool

v0.4.6

Oct 22, 2026

Changes in this version

type List

+ Anchor string

v0.4.5

Oct 21, 2026

Changes in this version

+ var Mantle = Hex("#181825")

v0.4.4

Oct 21, 2026

Changes in this version

type App

+ func (a *App) NoLongerUsed(paths ...string)

v0.4.3

Oct 21, 2026

v0.4.2

Oct 20, 2026

Changes in this version

type App

+ func (a *App) MoveAsideRecord(path string, err error, reread func() tea.Cmd) tea.Cmd

type Column

+ Line bool

v0.4.1

Oct 20, 2026

v0.4.0

Oct 20, 2026

Changes in this version

+ func Escape(s string) string

+ func Reading(lines ...string) []string

type App

+ func (a *App) Log(kind ToastKind, text string)

+ func (a *App) MoveAside(path string, err error, fresh func() tea.Cmd) tea.Cmd

type Field

+ Styled func() []Span

type FormField

+ Styled func() []Span

type FormResult

+ Info bool

type Row

+ Styled [][]Span

+ type Span struct

+ Style Style

+ Text string

+ func ColorSpans(c Color) []Span

+ func SliderSpans(value, bottom, top float64, width int, color Color) []Span

type Terminal

+ AllKeys bool

+ Interactive bool

v0.3.0

Oct 20, 2026

Changes in this version

type App

+ func (a *App) Tick(d time.Duration, fn func(time.Time) tea.Msg) tea.Cmd

v0.2.2

Oct 19, 2026

v0.2.1

Oct 19, 2026

Changes in this version

type Column

+ MinWidth int

+ Shrink bool

type Form

+ OnCancel func() tea.Cmd

type NumberInput

+ Unchanged func() tea.Cmd

type PasswordInput

+ Unchanged func() tea.Cmd

type Terminal

+ func (t *Terminal) Empty() bool

type TextInput

+ Unchanged func() tea.Cmd

v0.2.0

Oct 19, 2026

Changes in this version

+ const RemoteIconWidth

+ const RemotePowerlineWidth

+ func Clipboard(text string)

+ func LoadingFrame() string

+ func TruncateMiddle(s string, w int) string

type Action

+ AskFor func() *Ask

+ Clear bool

+ EnterHint string

+ Live func() (label, desc string)

type App

+ Canvas func(w, h int) []string

+ CanvasKey func(key string, msg tea.KeyMsg) (bool, tea.Cmd)

+ MinHeight int

+ MinWidth int

+ OnResize func(w, h int) tea.Cmd

+ QuitFlow func() tea.Cmd

+ Spinning func() bool

+ ToastLines int

+ func (a *App) CloseAll() tea.Cmd

+ func (a *App) CloseTop(n int) tea.Cmd

+ func (a *App) ErrorAbout(title, subject, message string) tea.Cmd

+ func (a *App) Focus(p *Panel) tea.Cmd

+ func (a *App) LoadChecks(c *Checks) tea.Cmd

+ func (a *App) LoadSelect(s *Select) tea.Cmd

+ func (a *App) MenuAbout(title, subject string, sections ...MenuSection) tea.Cmd

+ func (a *App) PlaySplash(s Splash) tea.Cmd

+ func (a *App) ShowScreen(s *Screen) tea.Cmd

type Ask

+ OnCancel func() tea.Cmd

type Checks

+ Commit func([]bool) error

+ Loading bool

+ OnCancel func() tea.Cmd

type ColorPicker

+ Commit func(Color) error

+ OnCancel func() tea.Cmd

type Column

+ Drop int

+ Middle bool

type DatePicker

+ Commit func(time.Time) error

+ OnCancel func() tea.Cmd

type Field

+ Desc string

type FilePicker

+ Commit func(path string) error

+ OnCancel func() tea.Cmd

+ type FilePreview struct

+ EmptyFact string

+ EmptyHint string

+ FS PreviewFS

+ Icon func(path string, dir bool) (string, Color)

+ Info bool

+ Line int

+ Path string

+ func (p *FilePreview) Draw(w, h int, _ bool) []string

+ func (p *FilePreview) Empty() bool

+ func (p *FilePreview) HasItem() bool

+ func (p *FilePreview) Key(string, tea.KeyMsg) (bool, tea.Cmd)

+ func (p *FilePreview) MoveKeys() []KeyRow

+ func (p *FilePreview) Scroll() string

type Finder

+ FS PreviewFS

+ Search func(typed string) tea.Cmd

type FinderItem

+ Line int

+ Match string

type FormButton

+ Back func() (changed bool)

+ Open func() tea.Cmd

type List

+ Location string

+ func (l *List) SetMarked(ids []string)

type NumberInput

+ Commit func(string) error

+ OnCancel func() tea.Cmd

+ Optional bool

+ Stay bool

+ Suggest string

+ Unit string

type Panel

+ Name string

type PasswordInput

+ Commit func(value string, clear bool) error

+ OnCancel func() tea.Cmd

+ PausedUntil func() time.Time

+ Stay bool

+ type PreviewFS interface

+ Lstat func(name string) (fs.FileInfo, error)

+ Open func(name string) (PreviewFile, error)

+ ReadDir func(name string) ([]fs.FileInfo, error)

+ ReadLink func(name string) (string, error)

+ Stat func(name string) (fs.FileInfo, error)

+ type PreviewFile interface

type Reorder

+ Commit func(order []int) error

+ OnCancel func() tea.Cmd

type Row

+ SortGroup int

type Select

+ Commit func(int) error

+ Loading bool

+ OnCancel func() tea.Cmd

type Terminal

+ Copy func(text string) tea.Cmd

+ ExitAsks bool

+ ExitKey string

+ OnFirstOutput func() tea.Cmd

+ SelectKey string

+ func (t *Terminal) Mode() string

+ func (t *Terminal) Spoke() bool

type TerminalKey

+ DoKey func(key string) tea.Cmd

+ Keys []string

type TextInput

+ Commit func(string) error

+ OnCancel func() tea.Cmd

+ Search bool

+ Stay bool

+ Suggest string

+ type TextMatch struct

+ From int

+ Line int

+ To int

type Textarea

+ Check func(string) error

+ Commit func(string) error

+ OnCancel func() tea.Cmd

type ToastKind

+ const Success

type Values

+ EmptyFact string

+ EmptyHint string

+ func (v *Values) Actions() []Action

type Viewer

+ Current int

+ Hits []TextMatch

+ NoNumbers bool

+ NoWrap bool

+ func (v *Viewer) FindText(q string) []TextMatch

v0.1.13

Oct 18, 2026

v0.1.12

Oct 16, 2026

Changes in this version

type Checks

+ Unavailable func(i int) bool

type Field

+ OptionUnavailable func(i int) bool

type FormField

+ OptionUnavailable func(i int) bool

v0.1.11

Oct 15, 2026

v0.1.10

Oct 15, 2026

Changes in this version

type PasswordInput

+ Name string

type TextInput

+ Name string

type Textarea

+ Name string

v0.1.9

Oct 15, 2026

Changes in this version

type App

+ func (a *App) ClosePopup(b PopupBody) tea.Cmd

+ func (a *App) Popup(p Popup) tea.Cmd

+ type Popup struct

+ Body PopupBody

+ Glyph string

+ Subject string

+ Title string

+ type PopupBody interface

+ Draw func(w, h int, layer Color) []string

+ Hint func() []KeyHint

+ Key func(key string, msg tea.KeyMsg) (bool, tea.Cmd)

+ Keys func() []KeySection

+ Size func(sw, sh int) (w, h int)

v0.1.8

Oct 15, 2026

Changes in this version

type Form

+ ButtonSubject string

type FormButton

+ Subject string

v0.1.7

Oct 15, 2026

Changes in this version

type Form

+ Buttons [][]*FormButton

+ SubmitLong func(ctx context.Context) (tea.Cmd, error)

+ type FormButton struct

+ Label string

+ Needs []*FormField

+ Run func(ctx context.Context) FormResult

+ Submit func() (tea.Cmd, error)

+ SubmitLong func(ctx context.Context) (tea.Cmd, error)

+ type FormResult struct

+ Apply func()

+ Err error

+ Lines []string

+ Toast string

v0.1.6

Oct 15, 2026

Changes in this version

type App

+ func (a *App) Reorder(r Reorder) tea.Cmd

type List

+ Draggable bool

+ func (l *List) Drop()

+ func (l *List) Hold() bool

+ func (l *List) Holding() bool

+ func (l *List) MoveHeld(down bool)

+ type Reorder struct

+ Done func(order []int) tea.Cmd

+ Glyph string

+ Options []string

+ Subject string

+ Title string

v0.1.5

Oct 14, 2026

Changes in this version

type Checks

+ Cursor int

v0.1.4

Oct 14, 2026

v0.1.3

Oct 14, 2026

Changes in this version

type Action

+ ToDetails func() bool

type Panel

+ Details *Panel

v0.1.2

Oct 14, 2026

Changes in this version

type List

+ OnMove func(Row) tea.Cmd

type Row

+ Group string

type Values

+ OnMove func(f *Field, option int) tea.Cmd

v0.1.1

Oct 14, 2026

Changes in this version

type Ask

+ Subject string

type Checks

+ Subject string

type ColorPicker

+ Subject string

type DatePicker

+ Subject string

type Finder

+ Subject string

type Form

+ Subject string

type NumberInput

+ Subject string

type PasswordInput

+ Subject string

type Select

+ Subject string

type Slider

+ Subject string

type TextInput

+ Subject string

type Textarea

+ Subject string

v0.1.0

Oct 14, 2026

Changes in this version

+ const FamilyIconWidth

+ const FamilyPowerlineWidth

+ var Base = Hex("#1e1e2e")

+ var Blue = Hex("#89b4fa")

+ var ErrEmpty = errors.New("can't be empty")

+ var Green = Hex("#a6e3a1")

+ var Lavender = Hex("#b4befe")

+ var Overlay0 = Hex("#6c7086")

+ var Peach = Hex("#fab387")

+ var Red = Hex("#f38ba8")

+ var Sapphire = Hex("#74c7ec")

+ var Subtext1 = Hex("#bac2de")

+ var Surface1 = Hex("#45475a")

+ var Surface2 = Hex("#585b70")

+ var Text = Hex("#cdd6f4")

+ var Yellow = Hex("#f9e2af")

+ func Center(s string, w int) string

+ func ColorText(c Color) string

+ func Composite(base, top []string, x, y, width int) []string

+ func Cut(s string, from, to int) string

+ func Dim(line string) string

+ func DimLines(lines []string) []string

+ func EmptyState(w, h int, fact, hint string) []string

+ func EnvName(app, name string) string

+ func Filter(items []string, typed string) []int

+ func Fit(s string, w int) string

+ func FitLeft(s string, w int) string

+ func HexText(c Color) string

+ func IconWidth() int

+ func KeyName(msg tea.KeyMsg) string

+ func MarkLabel(key, label string) string

+ func Matches(text, typed string) bool

+ func Pad(s string, w int) string

+ func Pad2(lines []string, w, h int) []string

+ func PadLeft(s string, w int) string

+ func PowerlineWidth() int

+ func Repeat(s string, n int) string

+ func SetIconWidth(icon, powerline int)

+ func SliderTrack(value, bottom, top float64, width int, color Color) string

+ func StripStyles(s string) string

+ func Truncate(s string, w int) string

+ func TruncateLeft(s string, w int) string

+ func Upper(text string) string

+ func Width(s string) int

+ func Wrap(s string, w int) []string

+ type Action struct

+ Ask *Ask

+ Desc string

+ Detail bool

+ Disabled func() bool

+ Do func() tea.Cmd

+ Hidden func() bool

+ Hint string

+ Key string

+ Label string

+ Scope Scope

+ Stay bool

+ type App struct

+ CoreKeys []CoreKey

+ ForceNarrow bool

+ Global []Action

+ HideSecretsInPreview bool

+ InputTabWidth int

+ Name string

+ OnMsg func(tea.Msg) tea.Cmd

+ Progress func() (frac float64, ok bool)

+ Quit *Ask

+ QuitDesc string

+ ShiftTab bool

+ Splash Splash

+ Start func() tea.Cmd

+ Status func(w int) string

+ func New(name string) *App

+ func (a *App) AddScreen(s *Screen) *Screen

+ func (a *App) Checks(c Checks) tea.Cmd

+ func (a *App) Confirm(ask Ask, accept func() tea.Cmd) tea.Cmd

+ func (a *App) Error(title, message string) tea.Cmd

+ func (a *App) Find(f *Finder) tea.Cmd

+ func (a *App) Form(f *Form) tea.Cmd

+ func (a *App) Frame() []string

+ func (a *App) Init() tea.Cmd

+ func (a *App) Menu(title string, sections ...MenuSection) tea.Cmd

+ func (a *App) Number(in NumberInput) tea.Cmd

+ func (a *App) Open(in Input) tea.Cmd

+ func (a *App) OpenTerminal(t *Terminal) tea.Cmd

+ func (a *App) Password(in PasswordInput) tea.Cmd

+ func (a *App) PickColor(c ColorPicker) tea.Cmd

+ func (a *App) PickDate(d DatePicker) tea.Cmd

+ func (a *App) PickFile(p FilePicker) tea.Cmd

+ func (a *App) Run() error

+ func (a *App) Screen() *Screen

+ func (a *App) Select(s Select) tea.Cmd

+ func (a *App) Size() (w, h int)

+ func (a *App) Text(in TextInput) tea.Cmd

+ func (a *App) Textarea(t Textarea) tea.Cmd

+ func (a *App) Toast(kind ToastKind, text string) tea.Cmd

+ func (a *App) Update(msg tea.Msg) (tea.Model, tea.Cmd)

+ func (a *App) View() string

+ func (a *App) Viewer(v *Viewer) tea.Cmd

+ type Ask struct

+ Details []string

+ Question string

+ Title string

+ Verb string

+ Warn []int

+ type Body interface

+ Draw func(w, h int, focused bool) []string

+ HasItem func() bool

+ Key func(key string, msg tea.KeyMsg) (bool, tea.Cmd)

+ MoveKeys func() []KeyRow

+ Scroll func() string

+ type Capsule struct

+ Selected bool

+ Text string

+ type Checks struct

+ Checked []bool

+ Done func([]bool) tea.Cmd

+ Glyph string

+ Options []string

+ Title string

+ type Color struct

+ Set bool

+ func DimColor(c Color) Color

+ func Hex(s string) Color

+ func LayerColor(k int) Color

+ func (c Color) B() uint8

+ func (c Color) G() uint8

+ func (c Color) R() uint8

+ func (c Color) String() string

+ type ColorPicker struct

+ Done func(Color) tea.Cmd

+ Glyph string

+ Title string

+ Value Color

+ type Column struct

+ Flex bool

+ Number bool

+ Path bool

+ Title string

+ type CoreKey struct

+ Desc string

+ Do func() tea.Cmd

+ Key string

+ type DatePicker struct

+ Done func(time.Time) tea.Cmd

+ Glyph string

+ Max time.Time

+ Min time.Time

+ SundayFirst bool

+ Time bool

+ Title string

+ Value time.Time

+ type Failure struct

+ Fact string

+ Hint string

+ type Field struct

+ Checked []bool

+ Disabled func() bool

+ Edit func() tea.Cmd

+ Empty string

+ Err func() bool

+ Label string

+ Multi bool

+ OnChange func() tea.Cmd

+ Options []string

+ Path bool

+ Selected int

+ Value func() string

+ type FilePicker struct

+ Dirs bool

+ Done func(path string) tea.Cmd

+ Glyph string

+ Icon func(path string, dir bool) (string, Color)

+ Root string

+ Title string

+ Value string

+ type Finder struct

+ Done func(FinderItem) tea.Cmd

+ Files bool

+ Glyph string

+ Items []FinderItem

+ Loading bool

+ Preview func(FinderItem) (title string, lines []string)

+ Title string

+ Verb string

+ type FinderItem struct

+ ID string

+ Icon string

+ IconColor Color

+ Text string

+ type Form struct

+ Button string

+ Fields []*FormField

+ Focus *FormField

+ Glyph string

+ Name string

+ Submit func() (tea.Cmd, error)

+ Title string

+ type FormField struct

+ Check func() string

+ Checked []bool

+ Disabled func() bool

+ Edit func() Input

+ Empty string

+ Label string

+ Multi bool

+ OptionDisabled func(i int) bool

+ Options []string

+ Path bool

+ Selected int

+ Stacked bool

+ Value func() string

+ type Input interface

+ type KeyHint struct

+ Desc string

+ Key string

+ type KeyRow struct

+ Desc string

+ Disabled bool

+ Key string

+ type KeySection struct

+ Rows []KeyRow

+ Title string

+ type List struct

+ Columns []Column

+ EmptyFact string

+ EmptyHint string

+ Filterable bool

+ Marks bool

+ func (l *List) Actions() []Action

+ func (l *List) ClearFilter()

+ func (l *List) ClearMarks()

+ func (l *List) Current() (Row, bool)

+ func (l *List) Draw(w, h int, focused bool) []string

+ func (l *List) Empty() bool

+ func (l *List) Filtering() bool

+ func (l *List) Focus()

+ func (l *List) HasItem() bool

+ func (l *List) Key(key string, msg tea.KeyMsg) (bool, tea.Cmd)

+ func (l *List) Marked() []string

+ func (l *List) MoveKeys() []KeyRow

+ func (l *List) OpenFilter()

+ func (l *List) Rows() []Row

+ func (l *List) Scroll() string

+ func (l *List) Select(id string)

+ func (l *List) SetRows(rows []Row)

+ func (l *List) SortBy(keys ...SortKey)

+ func (l *List) Sorting() []SortKey

+ func (l *List) ToggleMark()

+ func (l *List) Typing() bool

+ type MenuSection struct

+ Actions []Action

+ Title string

+ type Mode struct

+ Exit string

+ Keys []ModeKey

+ Name string

+ OnExit func() tea.Cmd

+ Pause bool

+ type ModeKey struct

+ Desc string

+ Do func(key string) tea.Cmd

+ Key string

+ Keys []string

+ NoFooter bool

+ type NumberInput struct

+ Check func(string) error

+ Decimal bool

+ Done func(string) tea.Cmd

+ Glyph string

+ Max float64

+ Min float64

+ Name string

+ Negative bool

+ Old string

+ Prompt string

+ Title string

+ Verb string

+ type Pager struct

+ EmptyFact string

+ EmptyHint string

+ Follow bool

+ func (t *Pager) Append(lines ...string)

+ func (t *Pager) Draw(w, h int, focused bool) []string

+ func (t *Pager) Empty() bool

+ func (t *Pager) HasItem() bool

+ func (t *Pager) Key(key string, _ tea.KeyMsg) (bool, tea.Cmd)

+ func (t *Pager) Lines() []string

+ func (t *Pager) MoveKeys() []KeyRow

+ func (t *Pager) Scroll() string

+ func (t *Pager) SetLines(lines []string)

+ type Panel struct

+ Actions []Action

+ Body Body

+ Fail *Failure

+ HintPressableOnly bool

+ Label string

+ Loading bool

+ LoadingText string

+ OnEsc func() tea.Cmd

+ OnTab func(tab int) tea.Cmd

+ OtherKeys []KeySection

+ Stream bool

+ Tab int

+ Tabs []string

+ func (p *Panel) EnterMode(m *Mode)

+ func (p *Panel) InMode() *Mode

+ func (p *Panel) LeaveMode()

+ type PasswordInput struct

+ Check func(string) error

+ Done func(value string, clear bool) tea.Cmd

+ Glyph string

+ MaxLen int

+ Prompt string

+ Set bool

+ Title string

+ Unlock bool

+ Verb string

+ type ProbeResult struct

+ IconCells int

+ IconFrom string

+ Palette int

+ PowerlineCells int

+ PowerlineFrom string

+ func Probe(app string) ProbeResult

+ type RGB [3]uint8

+ func DimRGB(c RGB) RGB

+ type Rect struct

+ H int

+ W int

+ X int

+ Y int

+ type Row struct

+ Cells []string

+ ID string

+ Sort []string

+ type Scope int

+ const GlobalScope

+ const ItemScope

+ const PanelScope

+ type Screen struct

+ Desc string

+ Key string

+ Layout func(w, h int) []Rect

+ Name string

+ NarrowBelow int

+ Panels []*Panel

+ func (s *Screen) Focused() *Panel

+ type Select struct

+ Done func(int) tea.Cmd

+ Glyph string

+ Keys []string

+ Options []string

+ Selected int

+ Title string

+ type Selection struct

+ Copy func(text string) tea.Cmd

+ CopyKey string

+ Key string

+ Name string

+ type Slider struct

+ Bottom float64

+ Done func(float64) tea.Cmd

+ Glyph string

+ Step float64

+ Title string

+ Top float64

+ Value float64

+ type SortKey struct

+ Col int

+ Desc bool

+ type Splash func(frame, w, h int) (lines []string, done bool)

+ func NewSplash(icon []byte, name, version, intro string) (Splash, error)

+ type Style struct

+ Bg Color

+ Bold bool

+ Fg Color

+ Underline bool

+ func Fg(c Color) Style

+ func On(c Color) Style

+ func (s Style) Bolded() Style

+ func (s Style) Render(text string) string

+ type Terminal struct

+ Command []string

+ Dir string

+ Ends bool

+ Env []string

+ History bool

+ Keys []TerminalKey

+ NotReady func() bool

+ OnExit func(err error) tea.Cmd

+ Subject string

+ Title string

+ func (t *Terminal) Draw(w, h int, focused bool) []string

+ func (t *Terminal) Enter()

+ func (t *Terminal) Exited() bool

+ func (t *Terminal) HasItem() bool

+ func (t *Terminal) Hide(a *App) tea.Cmd

+ func (t *Terminal) Inside() bool

+ func (t *Terminal) Key(string, tea.KeyMsg) (bool, tea.Cmd)

+ func (t *Terminal) MoveKeys() []KeyRow

+ func (t *Terminal) Running() bool

+ func (t *Terminal) Scroll() string

+ func (t *Terminal) Start() tea.Cmd

+ func (t *Terminal) Stop()

+ type TerminalKey struct

+ Desc string

+ Do func() tea.Cmd

+ Key string

+ type TextInput struct

+ Check func(string) error

+ Done func(string) tea.Cmd

+ Glyph string

+ MaxLen int

+ Old string

+ Prompt string

+ Title string

+ Verb string

+ type Textarea struct

+ Done func(string) tea.Cmd

+ Glyph string

+ Old string

+ Title string

+ type ToastKind int

+ const Error

+ const Info

+ const Warning

+ type Values struct

+ Fields []*Field

+ Header [2]string

+ func (v *Values) Current() *Field

+ func (v *Values) Draw(w, h int, focused bool) []string

+ func (v *Values) Empty() bool

+ func (v *Values) EnterHint() string

+ func (v *Values) HasItem() bool

+ func (v *Values) Key(key string, _ tea.KeyMsg) (bool, tea.Cmd)

+ func (v *Values) MoveKeys() []KeyRow

+ func (v *Values) Scroll() string

+ type Viewer struct

+ Glyph string

+ Keys []ViewerKey

+ Lang string

+ Lines []string

+ Loading bool

+ OnTab func(tab int) tea.Cmd

+ Select *Selection

+ Subject string

+ Tab int

+ Tabs []string

+ Title string

+ func (v *Viewer) ScrollTo(i int)

+ func (v *Viewer) Top() int

+ type ViewerKey struct

+ Desc string

+ Do func() tea.Cmd

+ Key string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL