components

package

v1.0.40357-pre Latest Latest Go to latest Published: Jun 16, 2026 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/CircleCI-Public/circleci-cli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func NewSpinner(color bool) spinner.Model
type SelectModel
- func NewSelectModel(prompt string, options []string) SelectModel
type TokenModel
- func NewTokenModel() TokenModel

Constants ¶

View Source

const (
	KeyCtrlC     = "ctrl+c"
	KeyEnter     = "enter"
	KeyEsc       = "esc"
	KeyBackspace = "backspace"
	KeyHome      = "home"
	KeyEnd       = "end"
	KeySlash     = "/"

	// Letter keys. The value is the literal bubbletea reports; uppercase
	// variants are the shifted key (e.g. "N" for shift+n).
	KeyQ      = "q"
	KeyN      = "n"
	KeyShiftN = "N"
	KeyG      = "g"
	KeyShiftG = "G"
)

Key constants map bubbletea key-press string representations to named values.

Variables ¶

View Source

var LinkStyle = lipgloss.NewStyle().
	Foreground(lipgloss.Color("#00ADD8")).
	Underline(true)

Functions ¶

func NewSpinner ¶

func NewSpinner(color bool) spinner.Model

Types ¶

type SelectModel ¶

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

SelectModel is a single-choice picker rendered as a vertical list with a cursor (›) marking the focused option. ↑/↓ or k/j move; Enter confirms; Esc/Ctrl+C cancels.

func NewSelectModel ¶

func NewSelectModel(prompt string, options []string) SelectModel

func (SelectModel) Done ¶

func (m SelectModel) Done() bool

Done reports whether the user has confirmed a selection.

func (SelectModel) Init ¶

func (m SelectModel) Init() tea.Cmd

func (SelectModel) Selected ¶

func (m SelectModel) Selected() int

Selected returns the index chosen by the user. Only valid when Done().

func (SelectModel) Update ¶

func (m SelectModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (SelectModel) View ¶

func (m SelectModel) View() tea.View

func (SelectModel) WithCursor ¶

func (m SelectModel) WithCursor(i int) SelectModel

WithCursor returns a copy of the model with the initial cursor positioned at index i, clamped to the available options. Use this to pre-select a default choice.

func (SelectModel) WithHint ¶

func (m SelectModel) WithHint(hint string) SelectModel

WithHint returns a copy of the model with a custom footer hint line.

type TokenModel ¶

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

func NewTokenModel ¶

func NewTokenModel() TokenModel

func (TokenModel) Init ¶

func (m TokenModel) Init() tea.Cmd

func (TokenModel) Token ¶

func (m TokenModel) Token() string

func (TokenModel) Update ¶

func (m TokenModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (TokenModel) View ¶

func (m TokenModel) View() tea.View

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL