https://github.com/preiter93/edtui

A TUI based vim-inspired editor for the ratatui ecosystem
https://github.com/preiter93/edtui

Last synced: 2 days ago
JSON representation

A TUI based vim-inspired editor for the ratatui ecosystem

• Host: GitHub
• URL: https://github.com/preiter93/edtui
• Owner: preiter93
• License: mit
• Created: 2023-11-28T12:44:52.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-10-21T12:47:36.000Z (19 days ago)
• Last Synced: 2024-10-23T13:56:04.383Z (16 days ago)
• Language: Rust
• Homepage:
• Size: 12.4 MB
• Stars: 18
• Watchers: 1
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-ratatui - edtui - A TUI based vim-inspired editor widget for ratatui. (📦 Libraries / 🧩 Widgets)

README

        
# edtui

### `EdTUI`

#### Overview

`EdTUI` is a text editor widget for the [Ratatui](https://github.com/ratatui-org/ratatui) ecosystem.

It is designed to provide a light-weight user experience inspired by Vim.

### Features

- Vim-like keybindings and editing modes for efficient text manipulation.

- Normal, Insert and Visual mode.

- Clipboard: Uses the `arboard` clibpboard by default which allows copy pasting between the

  system clipboard and the editor.

### Keybindings

`EdTUI` offers a set of keybindings similar to Vim. Here are some of the most common keybindings:

##### Normal/Visual Mode:

| Keybinding              | Description                                  |

|-------------------------|----------------------------------------------|

| `i`                     | Enter Insert mode                            |

| `v`                     | Enter Visual mode                            |

| `h`, `j`, `k`, `l`      | Navigate left, down, up, and right           |

| `w`, `b`                | Move forward or backward by word             |

| `x`                     | Delete the character under the cursor        |

| `Del`                   | Delete the character left of the cursor      |

| `u`, `+r`         | Undo/Redo last action                        |

| `Esc`                   | Escape Insert mode or Visual mode            |

| `0`                     | Move cursor to start of line                 |

| `^`                     | Move cursor to first non-blank character     |

| `$`                     | Move cursor to end of line                   |

| `a`                     | Append after the cursor                      |

| `A`                     | Append at the end of the line                |

| `o`                     | Add a new line below and enter Insert mode   |

| `O`                     | Add a new line above and enter Insert mode   |

| `Backspace`             | Delete the previous character                |

| `d`                     | Delete the selection                         |

| `dd`                    | Delete the current line                      |

| `ciw`                   | Select between delimiters. Supported: [`"`]  |

| `u`                     | Undo the last change                         |

| `r`                     | Redo the last undone action                  |

| `y`                     | Copy the selected text                       |

| `p`                     | Paste the copied text                        |

##### Insert Mode:

| Keybinding | Description                             |

|------------|-----------------------------------------|

| `Esc`      | Return to Normal mode                   |

For more keybindings and customization options, refer to the code.

### Demo

![](resources/app.gif)

#### Roadmap

- [x] Clipboard

- [x] Search

- [ ] Vims `f`/`t` go to first

- [ ] Support termwiz and termion

- [ ] Display line numbers

- [ ] Remap keybindings

- [ ] Soft-wrap lines

License: MIT