Help us shape the future of Go! Take the 2026 Go Developer Survey

settings

package
v0.4.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 8, 2026 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package settings implements the settings overlay panel for grut. It displays a navigable list of configurable options (preview position, theme, double-click actions) and emits messages when the user changes a value.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Panel

type Panel struct {
	panels.BasePanel
	// contains filtered or unexported fields
}

Panel is the settings overlay. It implements panels.Panel.

func New

func New(currentPos layout.PreviewPosition, currentTheme string, themeNames []string, actionsCfg config.ActionsConfig, th *theme.Theme) *Panel

New creates a new settings overlay panel.

func (*Panel) Init

func (p *Panel) Init(_ context.Context) tea.Cmd

--------------------------------------------------------------------------- panels.Panel interface --------------------------------------------------------------------------- Init implements panels.Panel.

func (*Panel) KeyBindings

func (p *Panel) KeyBindings() []panels.KeyBinding

KeyBindings implements panels.Panel.

func (*Panel) Update

func (p *Panel) Update(msg tea.Msg) (panels.Panel, tea.Cmd)

Update implements panels.Panel.

func (*Panel) View

func (p *Panel) View(width, height int) string

View implements panels.Panel. It renders the settings menu within the given dimensions.

type ResetActionPromptsMsg

type ResetActionPromptsMsg = panels.ResetActionPromptsMsg

Message type aliases — the canonical definitions now live in the panels package so that the root TUI model can type-switch without importing this package directly. The aliases preserve backwards compatibility for any external callers and internal tests.

type SetDoubleClickActionMsg

type SetDoubleClickActionMsg = panels.SetDoubleClickActionMsg

Message type aliases — the canonical definitions now live in the panels package so that the root TUI model can type-switch without importing this package directly. The aliases preserve backwards compatibility for any external callers and internal tests.

type SetPreviewPositionMsg

type SetPreviewPositionMsg = panels.SetPreviewPositionMsg

Message type aliases — the canonical definitions now live in the panels package so that the root TUI model can type-switch without importing this package directly. The aliases preserve backwards compatibility for any external callers and internal tests.

type SetRightClickActionMsg

type SetRightClickActionMsg = panels.SetRightClickActionMsg

Message type aliases — the canonical definitions now live in the panels package so that the root TUI model can type-switch without importing this package directly. The aliases preserve backwards compatibility for any external callers and internal tests.

type SetThemeMsg

type SetThemeMsg = panels.SetThemeMsg

Message type aliases — the canonical definitions now live in the panels package so that the root TUI model can type-switch without importing this package directly. The aliases preserve backwards compatibility for any external callers and internal tests.

type ToggleSettingsMsg

type ToggleSettingsMsg = panels.ToggleSettingsMsg

Message type aliases — the canonical definitions now live in the panels package so that the root TUI model can type-switch without importing this package directly. The aliases preserve backwards compatibility for any external callers and internal tests.

Jump to

Keyboard shortcuts

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