keys

package

v0.21.0 Latest Latest Go to latest Published: Jul 10, 2026 License: MIT Imports: 1 Imported by: 0

Details

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

Repository

github.com/getstackit/stackit

Links

Open Source Insights

Documentation ¶

Overview ¶

Package keys provides shared keybindings for TUI views.

Constants ¶

This section is empty.

Variables ¶

View Source

var DefaultNavigation = NavigationKeyMap{
	Up: key.NewBinding(
		key.WithKeys("up", "k"),
		key.WithHelp("↑/k", "up"),
	),
	Down: key.NewBinding(
		key.WithKeys("down", "j"),
		key.WithHelp("↓/j", "down"),
	),
	Select: key.NewBinding(
		key.WithKeys("enter"),
		key.WithHelp("enter", "select"),
	),
	Cancel: key.NewBinding(
		key.WithKeys("ctrl+c", "esc", "q"),
		key.WithHelp("esc", "cancel"),
	),
}

DefaultNavigation returns standard navigation keybindings with vim support.

View Source

var DefaultReorder = ReorderKeyMap{
	NavigationKeyMap: DefaultNavigation,
	MoveUp: key.NewBinding(
		key.WithKeys("shift+up", "K"),
		key.WithHelp("K", "move up"),
	),
	MoveDown: key.NewBinding(
		key.WithKeys("shift+down", "J"),
		key.WithHelp("J", "move down"),
	),
}

DefaultReorder returns keybindings for reorder views.

View Source

var DefaultSelect = SelectKeyMap{
	NavigationKeyMap: DefaultNavigation,
	Search: key.NewBinding(
		key.WithKeys("/"),
		key.WithHelp("/", "search"),
	),
	Expand: key.NewBinding(
		key.WithKeys("space", " "),
		key.WithHelp("space", "expand/collapse"),
	),
}

DefaultSelect returns keybindings for selection views.

View Source

var DefaultTree = TreeKeyMap{
	NavigationKeyMap: DefaultNavigation,
	Search: key.NewBinding(
		key.WithKeys("/"),
		key.WithHelp("/", "search"),
	),
	Expand: key.NewBinding(
		key.WithKeys("space", " ", "enter"),
		key.WithHelp("space", "expand/collapse"),
	),
	Quit: key.NewBinding(
		key.WithKeys("q", "ctrl+c"),
		key.WithHelp("q", "quit"),
	),
}

DefaultTree returns keybindings for log views.

Functions ¶

This section is empty.

Types ¶

type NavigationKeyMap ¶

type NavigationKeyMap struct {
	Up     key.Binding
	Down   key.Binding
	Select key.Binding
	Cancel key.Binding
}

NavigationKeyMap provides standard navigation keybindings shared across TUI views.

type ReorderKeyMap ¶

type ReorderKeyMap struct {
	NavigationKeyMap
	MoveUp   key.Binding
	MoveDown key.Binding
}

ReorderKeyMap extends NavigationKeyMap with move operations for reordering.

type SelectKeyMap ¶

type SelectKeyMap struct {
	NavigationKeyMap
	Search key.Binding
	Expand key.Binding
}

SelectKeyMap provides keybindings for selection mode.

type TreeKeyMap ¶ added in v0.20.0

type TreeKeyMap struct {
	NavigationKeyMap
	Search key.Binding
	Expand key.Binding
	Quit   key.Binding
}

TreeKeyMap extends NavigationKeyMap with tree-specific operations.

Source Files ¶

View all Source files

keys.go

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