ui

package
v0.3.35 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 4, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Application

type Application interface {
	// Context returns the context of the application.
	Context() context.Context
	// Config returns the configuration of the application.
	Config() *config.Config
	// QuweueUpdateDraw adds a function to the queue to be executed in the main thread.
	QueueUpdateDraw(f func())
	Stop()
	Draw()
}

Application ...

type Backend

type Backend interface {
	Send(n Notification) tea.Cmd
}

Backend defines the interface for sending desktop notifications.

type BellBackend

type BellBackend struct{}

BellBackend is a notification backend that triggers the terminal bell character (\x07).

func NewBellBackend

func NewBellBackend() *BellBackend

NewBellBackend creates a new bell notification backend.

func (*BellBackend) Send

func (b *BellBackend) Send(n Notification) tea.Cmd

Send returns a tea.Cmd that triggers the terminal bell character (\x07). The terminal will emit an audible beep or visual flash based on user configuration. No message text is displayed.

type Model

type Model[T any] interface {
	Update(msg tea.Msg) (T, tea.Cmd)
	View() string
}

Model represents a common interface for UI components.

type Notification

type Notification struct {
	Title   string
	Message string
}

Notification represents a desktop notification request.

Directories

Path Synopsis
Package console provides console UI utilities.
Package console provides console UI utilities.
Package exitbanner is
Package exitbanner is
Package experimental is a banner to display when the experimental flag is enabled.
Package experimental is a banner to display when the experimental flag is enabled.
Package logo renders a Builder in a stylized way.
Package logo renders a Builder in a stylized way.
example command
Package styles define styling and theming for the project.
Package styles define styling and theming for the project.

Jump to

Keyboard shortcuts

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