Fix keybinding examples

charmbracelet · Sep 1, 2021 · 500d798 · 500d798
1 parent d987ef8
commit 500d798
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -117,13 +117,13 @@ type KeyMap struct {
 
 var DefaultKeyMap = KeyMap{
     Up: key.NewBinding(
-        key.WithKeys("k", "up"),
-        key.WithHelp("↑/k", "move up"),
+        key.WithKeys("k", "up"),        // actual keybindings
+        key.WithHelp("↑/k", "move up"), // corresponding help text
     ),
-    Down: key.Binding{
+    Down: key.NewBinding(
         WithKeys("j", "down"),
         WithHelp("↓/j", "move down"),
-    },
+    ),
 }
 
 func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {

diff --git a/key/key.go b/key/key.go
@@ -9,13 +9,13 @@
 //
 //     var DefaultKeyMap = KeyMap{
 //         Up: key.NewBinding(
-//             key.WithKeys("k", "up"),
-//             key.WithHelp("↑/k", "move up"),
+//             key.WithKeys("k", "up"),        // actual keybindings
+//             key.WithHelp("↑/k", "move up"), // corresponding help text
 //         ),
-//         Down: key.Binding{
+//         Down: key.NewBinding(
 //             WithKeys("j", "down"),
 //             WithHelp("↓/j", "move down"),
-//         },
+//         ),
 //     }
 //
 //     func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {