hints

Documentation

Overview

Package hints shows the keys that may follow the command being typed, once it waits key_hints milliseconds for its next key, as which-key.nvim does. They stay while the command goes on, a page at a time (B172).

Index

• type Module
  • func New() *Module
  • func (m *Module) Call(context.Context, uint32, api.Scope, ...int) (api.Result, error)
  • func (m *Module) Callback(_ context.Context, id uint32, s api.Scope) (api.Result, error)
  • func (m *Module) Close(context.Context) error
  • func (m *Module) Event(_ context.Context, name string, s api.Scope) (api.Result, error)
  • func (m *Module) Init(context.Context, api.Scope) (api.Result, error)
  • func (m *Module) Name() string
  • func (m *Module) Registered() []api.Registration
  • func (m *Module) Subscribed() []string
  • func (m *Module) Work(context.Context, api.Job) (string, error)

Types

type Module

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

Module is hints. It keeps the command being typed and whether its hints show.

func New

func New() *Module

New returns hints.

func (*Module) Call

func (m *Module) Call(context.Context, uint32, api.Scope, ...int) (api.Result, error)

func (*Module) Callback

func (m *Module) Callback(_ context.Context, id uint32, s api.Scope) (api.Result, error)

Callback shows the hints once the newest wait ends, while the command it waited for is still being typed.

func (*Module) Close

func (m *Module) Close(context.Context) error

func (*Module) Event

func (m *Module) Event(_ context.Context, name string, s api.Scope) (api.Result, error)

Event waits hints.delay for a command being typed, or shows the hints of one that goes on while they show.

func (*Module) Init

func (m *Module) Init(context.Context, api.Scope) (api.Result, error)

func (*Module) Name

func (m *Module) Name() string

func (*Module) Registered

func (m *Module) Registered() []api.Registration

func (*Module) Subscribed

func (m *Module) Subscribed() []string

func (*Module) Work

func (m *Module) Work(context.Context, api.Job) (string, error)