chatbubble

Documentation

Overview

Package chatbubble renders a role-aware speech bubble with width-aware wrap.

Index

• type Bubble
  • func New(t theme.Theme) Bubble
  • func (b Bubble) View() string
  • func (b Bubble) WithLabel(s string) Bubble
  • func (b Bubble) WithRole(r Role) Bubble
  • func (b Bubble) WithText(s string) Bubble
  • func (b Bubble) WithWidth(w int) Bubble
• type Role

Types

type Bubble

type Bubble struct {
	// contains filtered or unexported fields
}

Bubble renders one chat message.

func New

func New(t theme.Theme) Bubble

New constructs a bubble using the given theme.

func (Bubble) View

func (b Bubble) View() string

View renders the bubble to a string. Safe to call repeatedly.

func (Bubble) WithLabel

func (b Bubble) WithLabel(s string) Bubble

WithLabel sets the role label printed above the bubble. If empty, no label is rendered.

func (Bubble) WithRole

func (b Bubble) WithRole(r Role) Bubble

WithRole sets the role used for styling.

func (Bubble) WithText

func (b Bubble) WithText(s string) Bubble

WithText sets the body text.

func (Bubble) WithWidth

func (b Bubble) WithWidth(w int) Bubble

WithWidth caps the bubble's content width in cells.

type Role

type Role string

Role drives the bubble's color and alignment.

const (
	RoleUser      Role = "user"
	RoleAssistant Role = "assistant"
	RoleSystem    Role = "system"
	RoleTool      Role = "tool"
)