Documentation
¶
Overview ¶
Package toggle provides a yes/no (boolean) selector wrapped in a pane — two labelled buttons rendered side-by-side with the active side highlighted, inside a bordered titled box.
Like every other tuilib component (input, filter, list, …), toggle owns its own pane: View() returns the bordered render. Don't wrap a toggle in another pane — set Options.Title to put the label on the border instead.
While focused, left/right/h/l/space toggle, and y/n set explicitly:
tg := toggle.New(theme.Dark().Toggle())
tg.SetTitle("Send notifications?")
// in your screen's Update: tg, _ = tg.Update(msg)
// later: send := tg.Value()
Index ¶
- type Model
- func (m *Model) Blur()
- func (m *Model) Focus() tea.Cmd
- func (m Model) FocusToken() focus.Token
- func (m Model) Focused() bool
- func (m Model) Help() []key.Binding
- func (m Model) HelpSections() []help.Section
- func (m Model) Init() tea.Cmd
- func (m Model) Rect() geom.Rect
- func (m *Model) SetActiveBorder(b lipgloss.Border)
- func (m *Model) SetActiveColor(c lipgloss.TerminalColor)
- func (m *Model) SetInactiveBorder(b lipgloss.Border)
- func (m *Model) SetInactiveColor(c lipgloss.TerminalColor)
- func (m *Model) SetRect(r geom.Rect)
- func (m *Model) SetSelectedStyle(s lipgloss.Style)
- func (m *Model) SetTitle(s string)
- func (m *Model) SetTopRight(s string)
- func (m *Model) SetUnselectedStyle(s lipgloss.Style)
- func (m *Model) SetValue(v bool)
- func (m Model) Title() string
- func (m Model) Update(msg tea.Msg) (Model, tea.Cmd)
- func (m Model) Value() bool
- func (m Model) View() string
- type Options
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Model ¶
type Model struct {
// contains filtered or unexported fields
}
Model is the toggle's exported state. Focus state lives on both the internal flag and the pane (so the border color reflects focus) — toggle them together via Focus/Blur.
func (Model) FocusToken ¶ added in v0.18.1
FocusToken returns the toggle's stable focus identity.
func (Model) Help ¶
Help returns the keys this toggle responds to. Compose into a screen's Help() to drive a per-component help line.
func (Model) HelpSections ¶ added in v0.25.0
HelpSections reports the toggle's bindings under Edit — flipping a toggle is editing its value, and grouping it with the fields around it is how the overlay reads on a form-shaped screen.
func (*Model) SetActiveBorder ¶ added in v0.24.0
SetActiveBorder updates the border shape drawn while focused.
func (*Model) SetActiveColor ¶
func (m *Model) SetActiveColor(c lipgloss.TerminalColor)
SetActiveColor updates the border color used when focused.
func (*Model) SetInactiveBorder ¶ added in v0.24.0
SetInactiveBorder updates the border shape drawn while unfocused.
func (*Model) SetInactiveColor ¶
func (m *Model) SetInactiveColor(c lipgloss.TerminalColor)
SetInactiveColor updates the border color used when unfocused.
func (*Model) SetRect ¶ added in v0.18.0
SetRect places the toggle at r. Height is fixed at 3 regardless of what the rect offers, since the pane is border + one content row + border.
func (*Model) SetSelectedStyle ¶
SetSelectedStyle updates the rendered style of the active side. Useful when reacting to a theme swap without rebuilding the model.
func (*Model) SetTopRight ¶ added in v0.18.1
SetTitle sets the title shown on the pane's top border. SetTopRight writes into the pane's top-right border slot. Hosts use it for a short annotation that belongs to the component as a whole — pkg/form paints validation errors there. Pass "" to clear.
func (*Model) SetUnselectedStyle ¶
SetUnselectedStyle updates the rendered style of the inactive side.
type Options ¶
type Options struct {
// Width sets the pane's outer width. Height is fixed at 3.
Width int
// Title sits on the top border of the pane. Defaults to "toggle" — set
// it to the field's question (e.g. "Send notifications?").
Title string
// Initial is the starting value. Defaults to false.
Initial bool
// YesLabel and NoLabel are the rendered button labels. Default to "yes"
// and "no" — wrap your own text (e.g. "on"/"off", "save"/"discard").
YesLabel string
NoLabel string
// SelectedStyle styles the active side, brackets included.
SelectedStyle lipgloss.Style
// UnselectedStyle styles the inactive side.
UnselectedStyle lipgloss.Style
// Pane pass-throughs. Unset fields fall back to NormalBorder both states
// and SlotBracketsNone.
ActiveColor lipgloss.TerminalColor
InactiveColor lipgloss.TerminalColor
ActiveBorder lipgloss.Border
InactiveBorder lipgloss.Border
// Glyphs are the marks this component draws, plus the scrollbar
// thumb and track it hands to its pane. Empty fields fall back to
// glyph.Default.
Glyphs glyph.Set
SlotBrackets pane.SlotBracketStyle
}
Options configures a new toggle. Zero-value fields fall back to defaults.
Source Files