bubbletea

Documentation

Index

• func Middleware(bth Handler) wish.Middleware
• func MiddlewareWithColorProfile(bth Handler, cp termenv.Profile) wish.Middleware
• type BubbleTeaHandler
• type Handler

Functions

func Middleware

func Middleware(bth Handler) wish.Middleware

Middleware takes a Handler and hooks the input and output for the ssh.Session into the tea.Program. It also captures window resize events and sends them to the tea.Program as tea.WindowSizeMsgs. By default a 256 color profile will be used when rendering with Lip Gloss.

func MiddlewareWithColorProfile

func MiddlewareWithColorProfile(bth Handler, cp termenv.Profile) wish.Middleware

MiddlewareWithColorProfile allows you to specify the number of colors returned by the server when using Lip Gloss. The number of colors supported by an SSH client's terminal cannot be detected by the server but this will allow for manually setting the color profile on all SSH connections.

Types

type BubbleTeaHandler

type BubbleTeaHandler = Handler // nolint: revive

BubbleTeaHandler is the function Bubble Tea apps implement to hook into the SSH Middleware. This will create a new tea.Program for every connection and start it with the tea.ProgramOptions returned.

Deprecated: use Handler instead.

type Handler

type Handler func(ssh.Session) (tea.Model, []tea.ProgramOption)

Handler is the function Bubble Tea apps implement to hook into the SSH Middleware. This will create a new tea.Program for every connection and start it with the tea.ProgramOptions returned.