help

package
v0.0.2 Latest Latest
Warning

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

Go to latest
Published: Feb 26, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type HelpContext

type HelpContext int

HelpContext represents which view the help is being shown in

const (
	GlobalContext HelpContext = iota
	HomeContext
	SearchContext
	ResultsContext
	EpisodesContext
	SeasonsContext
	AniListContext
	DownloadsContext
	SettingsContext
	HistoryContext
	ProviderStatusContext
)

type Model

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

Model represents the help panel state

func New

func New() Model

New creates a new help model

func (*Model) Hide

func (m *Model) Hide()

Hide hides the help panel

func (Model) Init

func (m Model) Init() tea.Cmd

Init initializes the help model

func (Model) IsVisible

func (m Model) IsVisible() bool

IsVisible returns whether the help panel is visible

func (*Model) SetContext

func (m *Model) SetContext(ctx HelpContext)

SetContext sets the current help context

func (*Model) SetProviderName

func (m *Model) SetProviderName(name string)

SetProviderName sets the current provider name

func (*Model) Show

func (m *Model) Show()

Show shows the help panel

func (*Model) Toggle

func (m *Model) Toggle()

Toggle toggles the visibility of the help panel

func (Model) Update

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

Update handles messages

func (Model) View

func (m Model) View() string

View renders the help panel

type Shortcut

type Shortcut struct {
	Key         string
	Description string
	Context     []HelpContext
}

Shortcut represents a keyboard shortcut with its description

Jump to

Keyboard shortcuts

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