Run initializes the program and runs its event loops, blocking until it gets terminated by either [Program.Quit], [Program.Kill], or its signal handle

Println prints above the Program. This output is unmanaged by the program and will persist across renders by the Program. If the altscreen is active

View renders the program's UI, which can be a string or a [Layer]. The view is rendered after every Update.

Update is called when a message is received. Use it to inspect messages and, in response, update the model and/or send a command.

NewProgram creates a new [Program].

Send sends a message to the main update function, effectively allowing messages to be injected from outside the program for interoperability purposes.

WithInput sets the input which, by default, is stdin. In most cases you won't need to use this. To disable input entirely pass nil. p := NewProgram(

WithOutput sets the output which, by default, is stdout. In most cases you won't need to use this.

Printf prints above the Program. It takes a format template followed by values similar to fmt.Printf. This output is unmanaged by the program and will

SetContent is a helper method to set the content of a [View] with a styled string. A styled string represents text with styles and hyperlinks encoded

Getenv returns the value of the environment variable named by the key. If the variable is not present in the environment, the value returned will be t

IsDark returns whether the color is dark.

String implements [fmt.Stringer] and is quite useful for matching key events. It will return the textual representation of the [Key] if there is one,

Init is the first function that will be called. It returns an optional initial command. To not perform an initial command return nil.

WithContext lets you specify a context in which to run the Program. This is useful if you want to cancel the execution from outside. When a Program ge

Key returns the underlying key event.

Mouse returns the underlying mouse event.

Quit is a convenience function for quitting Bubble Tea programs. Use it when you need to shut down a Bubble Tea program from the outside. If you wish

String returns a string representation of the mouse message.

Wait waits/blocks until the underlying Program finished shutting down.

Kill stops the program immediately and restores the former terminal state. The final render that you would normally see when quitting will be skipped.

NewView is a helper function to create a new [View] with the given styled string. A styled string represents text with styles and hyperlinks encoded a

WithEnvironment sets the environment variables that the program will use. This useful when the program is running in a remote session (e.g. SSH) and y

WithWindowSize sets the initial size of the terminal window. This is useful when you need to set the initial size of the terminal window, for example

checkResize detects the current size of the output and informs the program via a WindowSizeMsg.

enableAltScreen sets the alt screen mode. Note that this writes to the buffer directly if write is true.

encodeCursorStyle returns the integer value for the given cursor style and blink state.

flush flushes the output buffer to the program output.

shutdown performs operations to free up resources and restore the terminal to its original state.

waitForReadLoop waits for the cancelReader to finish its read loop.

Batch performs a bunch of commands concurrently with no ordering guarantees about the results. Use a Batch to return several commands. Example:

ExecProcess runs the given *exec.Cmd in a blocking fashion, effectively pausing the Program while the command is running. After the *exec.Cmd exists t

Keystroke returns the keystroke representation of the [Key]. While less type safe than looking at the individual fields, it will usually be more conve

LookupEnv retrieves the value of the environment variable named by the key. If the variable is present in the environment the value (which may be empt

Quit is a special command that tells the Bubble Tea program to exit.

RestoreTerminal reinitializes the Program's input reader, restores the terminal to the former state when the program was running, and repaints. Use it

Sequence runs the given commands one at a time, in order. Contrast this with Batch, which runs commands concurrently.

String returns the hex representation of the color.

SupportsEventTypes returns whether the terminal supports reporting different types of key events (press, release, and repeat).

WithColorProfile sets the color profile that the program will use. This is useful when you want to force a specific color profile. By default, Bubble

WithoutSignals will ignore OS signals. This is mainly useful for testing.

canFindBook returns whether the find button is to be pressed

enableTextCursor sets the text cursor mode.

execute writes the given sequence to the program output.

flush flushes the renderer's buffer to the output.

initInputReader (re)commences reading inputs.

recoverFromGoPanic recovers from a goroutine panic, prints a stack trace and signals for the program to be killed and terminal restored to a usable st

recoverFromPanic recovers from a panic, prints the stack trace, and restores the terminal to a usable state.

render renders the given view to the renderer.

resize notify the renderer of a terminal resize.

restoreTerminalState restores the terminal to the state prior to running the Bubble Tea program.

setColorProfile sets the color profile.

startRenderer starts the renderer.

stopRenderer stops the renderer. If kill is true, the renderer will be stopped immediately without flushing the last frame.

A command that waits for the activity on a channel.