scroll

Documentation

Overview

Package scroll provides Vim-style scrolling functionality for the Neru application.

This package implements a comprehensive scrolling system that allows users to navigate content using familiar Vim-style keybindings. The scroll functionality can be used both as a standalone mode and within other navigation modes (hints/grid) for precise content navigation.

Index

• Constants
• type Action
• type Context
  • func (c *Context) IsActive() bool
  • func (c *Context) LastKey() string
  • func (c *Context) LastKeyState() (string, int64)
  • func (c *Context) LastKeyTime() int64
  • func (c *Context) Reset()
  • func (c *Context) SetIsActive(active bool)
  • func (c *Context) SetLastKey(key string)
• type KeyMap
  • func NewKeyMap(bindings map[string][]string) *KeyMap
  • func (m *KeyMap) Action(name string) (Action, bool)
  • func (m *KeyMap) CanCompleteSequence(first, second string) bool
  • func (m *KeyMap) IsSequenceStart(key string) bool
  • func (m *KeyMap) KeyToAction() map[string]string
  • func (m *KeyMap) Lookup(key string) (string, bool)
  • func (m *KeyMap) LookupSequence(seq string) (string, bool)
  • func (m *KeyMap) Normalize(key string) string
  • func (m *KeyMap) Sequences() map[string]string
• type SequenceState
  • func NewSequenceState(key string, receivedAt int64) *SequenceState
  • func (s *SequenceState) Expired() bool

Constants

const (
	ArrowUp    = "Up"
	ArrowDown  = "Down"
	ArrowLeft  = "Left"
	ArrowRight = "Right"
	PageUp     = "PageUp"
	PageDown   = "PageDown"
)

Arrow key names for normalized key mapping. These use the canonical display forms from the centralized validNamedKeys registry.

const (
	ActionScrollUp    = "scroll_up"
	ActionScrollDown  = "scroll_down"
	ActionScrollLeft  = "scroll_left"
	ActionScrollRight = "scroll_right"
	ActionGoTop       = "go_top"
	ActionGoBottom    = "go_bottom"
	ActionPageUp      = "page_up"
	ActionPageDown    = "page_down"
)

Scroll action names used in configuration.

const SequenceTimeout = 500 * time.Millisecond

SequenceTimeout is the maximum time allowed between keys in a multi-key sequence.

Types

type Action

type Action struct {
	Direction services.ScrollDirection
	Amount    services.ScrollAmount
}

Action represents a scroll action with direction and amount.

type Context

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

Context holds the state and context for scroll mode operations.

func (*Context) IsActive

func (c *Context) IsActive() bool

IsActive returns whether scroll mode is currently active.

func (*Context) LastKey

func (c *Context) LastKey() string

LastKey returns the last key pressed during scroll operations.

func (*Context) LastKeyState

func (c *Context) LastKeyState() (string, int64)

LastKeyState atomically returns both the last key and its timestamp. Use this instead of separate LastKey()/LastKeyTime() calls when both values are needed together to avoid TOCTOU races.

func (*Context) LastKeyTime

func (c *Context) LastKeyTime() int64

LastKeyTime returns the timestamp when the last key was pressed.

func (*Context) Reset

func (c *Context) Reset()

Reset resets the scroll context to its initial state.

func (*Context) SetIsActive

func (c *Context) SetIsActive(active bool)

SetIsActive sets whether scroll mode is currently active.

func (*Context) SetLastKey

func (c *Context) SetLastKey(key string)

SetLastKey sets the last key pressed during scroll operations. When key is non-empty, the timestamp is updated to now. When key is empty (clearing state), the timestamp is zeroed.

type KeyMap

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

KeyMap maps key bindings to scroll actions and handles key sequence detection.

func NewKeyMap

func NewKeyMap(bindings map[string][]string) *KeyMap

NewKeyMap creates a new KeyMap from the given bindings. Bindings is a map from action names to lists of key strings.

func (*KeyMap) Action

func (m *KeyMap) Action(name string) (Action, bool)

Action returns the Action struct for a given action name and whether it was found.

func (*KeyMap) CanCompleteSequence

func (m *KeyMap) CanCompleteSequence(first, second string) bool

CanCompleteSequence returns true if the given two keys form a complete sequence.

func (*KeyMap) IsSequenceStart

func (m *KeyMap) IsSequenceStart(key string) bool

IsSequenceStart returns true if the given key can start a multi-key sequence.

func (*KeyMap) KeyToAction

func (m *KeyMap) KeyToAction() map[string]string

KeyToAction returns the map of single keys to action names.

func (*KeyMap) Lookup

func (m *KeyMap) Lookup(key string) (string, bool)

Lookup returns the action name for a given key and whether it was found.

func (*KeyMap) LookupSequence

func (m *KeyMap) LookupSequence(seq string) (string, bool)

LookupSequence returns the action name for a complete key sequence and whether it was found.

func (*KeyMap) Normalize

func (m *KeyMap) Normalize(key string) string

Normalize converts a key string to its canonical form.

func (*KeyMap) Sequences

func (m *KeyMap) Sequences() map[string]string

Sequences returns the map of key sequences to action names.

type SequenceState

type SequenceState struct {
	FirstKey   string
	ReceivedAt int64
}

SequenceState tracks the state of an incomplete key sequence.

func NewSequenceState

func NewSequenceState(key string, receivedAt int64) *SequenceState

NewSequenceState creates a new SequenceState for the given first key and timestamp.

func (*SequenceState) Expired

func (s *SequenceState) Expired() bool

Expired returns true if the sequence has exceeded the timeout window.