keyboard

Documentation

Index

• func Handle(ctx context.Context, opts HandleOpts) error
• type Control
• type ControlOp
• type Event
• type EventOp
• type HandleOpts
• type Handler
• type HandlerState

Functions

func Handle

func Handle(ctx context.Context, opts HandleOpts) error

Handle processes user keystroke events and dev workflow updates. Here we also take care on calling `onDone` callback on user exiting.

Types

type Control

type Control struct {
	HandlerID int
	AckEvent  struct {
		EventID string
	}
	SetEnabled *bool
}

type ControlOp

type ControlOp string

type Event

type Event struct {
	EventID      string
	Operation    EventOp
	StackUpdate  *observers.StackUpdateEvent
	CurrentState string
}

type EventOp

type EventOp string

const (
	OpStackUpdate EventOp = "op.stackupdate"
	OpSet         EventOp = "op.set"
)

type HandleOpts

type HandleOpts struct {
	Provider    observers.SessionProvider
	Keybindings []Handler
	Handler     func(context.Context) error
}

type Handler

type Handler interface {
	// Key MUST be a pure function. E.g. "l"
	Key() string
	// Must only leave when chan Event is closed. OpSet events must be Acknowledged by writing to Control.
	Handle(context.Context, chan Event, chan<- Control)

	// The first state is the initial state as well.
	States() []HandlerState
}

type HandlerState

type HandlerState struct {
	State string
	Label string
}