termcap.go

package tea

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

// RequestCapability is a command that requests the terminal to send its
// Termcap/Terminfo response for the given capability.
//
// Bubble Tea recognizes the following capabilities and will use them to
// upgrade the program's color profile:
//   - "RGB" Xterm direct color
//   - "Tc" True color support
//
// Note: that some terminal's like Apple's Terminal.app do not support this and
// will send the wrong response to the terminal breaking the program's output.
//
// When the Bubble Tea advertises a non-TrueColor profile, you can use this
// command to query the terminal for its color capabilities. Example:
//
//	switch msg := msg.(type) {
//	case tea.ColorProfileMsg:
//	  if msg.Profile != colorprofile.TrueColor {
//	    return m, tea.Batch(
//	      tea.RequestCapability("RGB"),
//	      tea.RequestCapability("Tc"),
//	    )
//	  }
//	}
func RequestCapability(s string) Cmd {
	return func() Msg {
		return requestCapabilityMsg(s)
	}
}

// CapabilityMsg represents a Termcap/Terminfo response event. Termcap
// responses are generated by the terminal in response to RequestTermcap
// (XTGETTCAP) requests.
//
// See: https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Operating-System-Commands
type CapabilityMsg struct {
	Content string
}

// String returns the capability content as a string.
func (c CapabilityMsg) String() string {
	return c.Content
}