Key event handling library for tcell
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Trevor Slocum 91bcd66e25 Remove code.rocketnine.space migration notice 6 months ago
whichkeybind Add code.rocketnine.space migration notice 6 months ago
.gitignore Initial release 2 years ago
CHANGELOG Add code.rocketnine.space migration notice 6 months ago
LICENSE Initial release 2 years ago
README.md Remove code.rocketnine.space migration notice 6 months ago
configuration.go Add code.rocketnine.space migration notice 6 months ago
configuration_test.go Update Configuration test 6 months ago
doc.go Initial release 2 years ago
go.mod Add code.rocketnine.space migration notice 6 months ago
go.sum Update README and usage examples 6 months ago
key.go Update README and usage examples 6 months ago
key_test.go Upgrade tcell to v2 1 year ago

README.md

cbind

GoDoc Donate

Key event handling library for tcell

Features

  • Set KeyEvent handlers
  • Encode and decode KeyEvents as human-readable strings

Usage

// Create a new input configuration to store the key bindings.
c := NewConfiguration()

// Define save event handler.
handleSave := func(ev *tcell.EventKey) *tcell.EventKey {
    return nil
}

// Define open event handler.
handleOpen := func(ev *tcell.EventKey) *tcell.EventKey {
    return nil
}

// Define exit event handler.
handleExit := func(ev *tcell.EventKey) *tcell.EventKey {
    return nil
}

// Bind Alt+s.
if err := c.Set("Alt+s", handleSave); err != nil {
    log.Fatalf("failed to set keybind: %s", err)
}

// Bind Alt+o.
c.SetRune(tcell.ModAlt, 'o', handleOpen)

// Bind Escape.
c.SetKey(tcell.ModNone, tcell.KeyEscape, handleExit)

// Capture input. This will differ based on the framework in use (if any).
// When using tview or cview, call Application.SetInputCapture before calling
// Application.Run.
app.SetInputCapture(c.Capture)

Documentation

Documentation is available via gdooc.

The utility program whichkeybind is available to determine and validate key combinations.

go get code.rocketnine.space/tslocum/cbind/whichkeybind

Support

Please share issues and suggestions here.