Interrupt is a special command that tells the Bubble Tea program to interrupt.

IsDark returns whether the color is dark.

IsDark returns whether the color is dark.

Key returns the underlying key event. This is a syntactic sugar for casting the key event to a [Key].

Key returns the underlying key event. This is a convenience method and syntactic sugar to satisfy the [KeyMsg] interface, and cast the key event to [K

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

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

Mouse returns the underlying mouse event. This is a convenience method and syntactic sugar to satisfy the [MouseMsg] interface, and cast the mouse eve

Mouse returns the underlying mouse event. This is a convenience method and syntactic sugar to satisfy the [MouseMsg] interface, and cast the mouse eve

Mouse returns the underlying mouse event. This is a convenience method and syntactic sugar to satisfy the [MouseMsg] interface, and cast the mouse eve

Mouse returns the underlying mouse event. This is a convenience method and syntactic sugar to satisfy the [MouseMsg] interface, and cast the mouse eve

NewProgressBar returns a new progress bar with the given state and value. The value is ignored if the state is [ProgressBarNone] or [ProgressBarIndete

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

Println prints above the Program. This output is unmanaged by the program and will persist across renders by the Program. Unlike fmt.Println (but sim

Raw is a command that prints the given string to the terminal without any formatting. This is intended for advanced use cases where you need to query

ReadClipboard produces a command that reads the system clipboard using OSC52. Note that OSC52 is not supported in all terminals.

ReadPrimaryClipboard produces a command that reads the primary clipboard using OSC52. Primary clipboard selection is a feature present in X11 and Wayl

ReleaseTerminal restores the original terminal state and cancels the input reader. You can return control to the Program with RestoreTerminal.

RequestBackgroundColor is a command that requests the terminal background color.

RequestCapability is a command that requests the terminal to send its Termcap/Terminfo response for the given capability. Bubble Tea recognizes the f

RequestCursorColor is a command that requests the terminal cursor color.

RequestCursorPosition is a command that requests the cursor position. The cursor position will be sent as a [CursorPositionMsg] message.

RequestForegroundColor is a command that requests the terminal foreground color.

RequestTerminalVersion is a command that queries the terminal for its version using XTVERSION. Note that some terminals may not support this command.

RequestWindowSize is a command that queries the terminal for its current size. It delivers the results to Update via a [WindowSizeMsg]. Keep in mind t

SetPrimaryClipboard produces a command that sets the primary clipboard using OSC52. Primary clipboard selection is a feature present in X11 and Waylan

SetStderr sets stderr on the underlying exec.Cmd to the given io.Writer.

SetStdin sets stdin on underlying exec.Cmd to the given io.Reader.

SetStdout sets stdout on underlying exec.Cmd to the given io.Writer.

Additional short help entries. This satisfies the help.KeyMap interface and is entirely optional.

ShortHelp returns keybindings to be shown in the mini help view. It's part of the key.Map interface.

String returns the capability content as a string.

String returns the string representation of the clipboard message.

String returns the terminal name as a string.

String returns the hex representation of the color.

String returns the hex representation of the color.

String returns the pasted content as a string.

String returns a string representation of the mouse click message.

String returns a string representation of the mouse release message.

String returns a string representation of the mouse wheel message.

String returns a string representation of the mouse motion message.

String implements [fmt.Stringer] and is quite useful for matching key events. For details, on what this returns see [Key.String].

String implements [fmt.Stringer] and is quite useful for matching key events. For details, on what this returns see [Key.String].

SupportsAllKeysAsEscapeCodes returns whether the terminal supports reporting all keys as escape codes.

SupportsAlternateKeys returns whether the terminal supports reporting alternate key codes.

SupportsAssociatedText returns whether the terminal supports reporting associated text with key events.

SupportsKeyDisambiguation returns whether the terminal supports key disambiguation (e.g., distinguishing between different modifier keys).

Suspend is a special command that tells the Bubble Tea program to suspend.

Fixes: https://github.com/charmbracelet/bubbletea/issues/1690