Mouse represents a Mouse message. Use [MouseMsg] to represent all mouse messages. The X and Y coordinates are zero-based, with (0,0) being the upper

Key represents a Key press or release event. It contains information about the Key pressed, like the runes, the type of Key, and the modifiers pressed

BackgroundColorMsg represents a background color message. This message is emitted when the program requests the terminal background color with the [Re

BlurMsg represents a terminal blur message. This occurs when the terminal loses focus.

CapabilityMsg represents a Termcap/Terminfo response event. Termcap responses are generated by the terminal in response to RequestTermcap (XTGETTCAP)

ClipboardMsg is a clipboard read message event. This message is emitted when a terminal receives an OSC52 clipboard read message event.

CursorColorMsg represents a cursor color change message. This message is emitted when the program requests the terminal cursor color.

CursorPositionMsg is a message that represents the terminal cursor position.

EnvMsg is a message that represents the environment variables of the program. This is useful for getting the environment variables of programs running

FocusMsg represents a terminal focus message. This occurs when the terminal gains focus.

ForegroundColorMsg represents a foreground color message. This message is emitted when the program requests the terminal foreground color with the [Re

KeyPressMsg represents a key press message.

KeyReleaseMsg represents a key release message.

KeyboardEnhancementsMsg is a message that gets sent when the terminal supports keyboard enhancements.

ModeReportMsg is a message that represents a mode report event (DECRPM). This is sent by the terminal in response to a request for a terminal mode re

MouseClickMsg represents a mouse button click message.

MouseMotionMsg represents a mouse motion message.

MouseReleaseMsg represents a mouse button release message.

MouseWheelMsg represents a mouse wheel message event.

PasteEndMsg is an message that is emitted when the terminal ends the bracketed-paste text.

PasteMsg is an message that is emitted when a terminal receives pasted text using bracketed-paste.

PasteStartMsg is an message that is emitted when the terminal starts the bracketed-paste text.

TerminalVersionMsg is a message that represents the terminal version.

WindowSizeMsg is used to report the terminal size. It's sent to Update once initially and then on every terminal resize. Note that Windows does not ha

A model can be more or less any type of data. It holds all the data for a program, so often it's a struct. For this simple example, however, all we'll

processFinishedMsg is sent when a pretend process completes.

requestCapabilityMsg is an internal message that requests the terminal to send its Termcap/Terminfo response.

A message used to indicate that activity has occurred. In the real world (for example, chat) this would contain actual data.

sequenceMsg is used internally to run the given commands in order.

setClipboardMsg is an internal message used to set the system clipboard using OSC52.

setPrimaryClipboardMsg is an internal message used to set the primary clipboard using OSC52.

BatchMsg is a message used to perform a bunch of commands concurrently with no ordering guarantees. You can send a BatchMsg with Batch.

Cmd is an IO operation that returns a message when it's complete. If it's nil it's considered a no-op. Use it for things like HTTP requests, timers, s

ColorProfileMsg is a message that describes the terminal's color profile. This message is send to the program's update function when the program is st

Cursor represents a cursor on the terminal screen.

CursorShape represents a terminal cursor shape.

ExecCallback is used when executing an *exec.Command to return a message with an error, which may or may not be nil.

ExecCommand can be implemented to execute things in a blocking fashion in the current terminal.

InterruptMsg signals the program should suspend. This usually happens when ctrl+c is pressed on common programs, but since bubbletea puts the terminal

KeyMsg represents a key event. This can be either a key press or a key release event.

KeyboardEnhancements describes the requested keyboard enhancement features. If the terminal supports any of them, it will respond with a [KeyboardEnha

LayerHitMsg is a message that is sent to the program when a layer is hit by a mouse event. This is used to determine which layer in a compostable view

LogOptionsSetter is an interface implemented by stdlib's log and charm's log libraries.

Model contains the program's state as well as its core functions.

MouseMode represents the mouse mode of a view.

MouseMsg represents a mouse message. This is a generic mouse message that can represent any kind of mouse event.

Position represents a position in the terminal.

Program is a terminal user interface.

ProgramOption is used to set options when initializing a Program. Program can accept a variable number of options. Example usage: p := NewProgram(m

ProgressBar represents the terminal progress bar. Support depends on the terminal. See https://learn.microsoft.com/en-us/windows/terminal/tutorials/

ProgressBarState represents the state of the progress bar.

QuitMsg signals that the program should quit. You can send a [QuitMsg] with [Quit].

RawMsg is a message that contains a string to be printed to the terminal without any intermediate processing.

ResumeMsg can be listen to do something once a program is resumed back from a suspend state.

SuspendMsg signals the program should suspend. This usually happens when ctrl+z is pressed on common programs, but since bubbletea puts the terminal i

View represents a terminal view that can be composed of multiple layers. It can also contain a cursor that will be rendered on top of the layers.

backgroundColorMsg is a message that requests the terminal background color.

channelHandlers manages the series of channels returned by various processes. It allows us to wait for those processes to terminate before exiting the

clearScreenMsg is an internal message that signals to clear the screen. You can send a clearScreenMsg with ClearScreen.

cursorColorMsg is a message that requests the terminal cursor color.

Dialog Windows

execMsg is used internally to run an ExecCommand sent with Exec.

foregroundColorMsg is a message that requests the terminal foreground color.