Documentation
¶
Overview ¶
Package list demonstrates a filterable list.Model as a single-screen app.
The list is deliberately long — far more rows than fit — so the scroll affordances are all reachable:
- Drag the scrollbar thumb on the right edge, or click anywhere on its track to jump there. Every row is numbered, so the number under the cursor after a drag tells you whether the jump landed where the thumb says it should.
- Roll the wheel over the list, focused or not.
- g / G jump to the ends, ctrl+u / ctrl+d by half-pages.
- Double-click a row to open it (the mouse spelling of enter, rule 14).
- "/" filters; the filter is a row inside the pane rather than a separate box above it.
Index ¶
- func New(t theme.Theme) screen.Screen
- type Screen
- func (s *Screen) Help() []key.Binding
- func (s *Screen) HelpSections() []help.Section
- func (s *Screen) Init() tea.Cmd
- func (s *Screen) IsCapturingKeys() bool
- func (s *Screen) Layout() layout.Node
- func (s *Screen) OnEnter(any) tea.Cmd
- func (s *Screen) SetTheme(t theme.Theme)
- func (s *Screen) Title() string
- func (s *Screen) Update(msg tea.Msg) (screen.Screen, tea.Cmd)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Screen ¶
type Screen struct {
// contains filtered or unexported fields
}
func (*Screen) HelpSections ¶ added in v0.25.0
HelpSections passes the list's own groups through and adds this screen's verbs. The scroll affordances join the list's Scroll group rather than this screen's, because that is what they do — mouse hints are grouped by verb like everything else (rule 10).
func (*Screen) IsCapturingKeys ¶
Source Files
Click to show internal directories.
Click to hide internal directories.