Skip to content

docs: add mappings and highlight sections #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cpea2506 merged 1 commit into from
Aug 9, 2025
Merged

docs: add mappings and highlight sections #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 45 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,26 +25,27 @@ Opinionated, simple replacement for `vim.ui.input`.

## ⚙️ Setup

Once installed, this plugin is activated automatically. No setup is required unless you want to customize the options.
This plugin works immediately after installation.
Configuration is optional, only needed if you want to override defaults.

### Available Options

| Option | Description | Type | Note |
| ---------------- | ----------------------------------------- | -------------------- | ----------------------------------- |
| `icon` | Icon displayed alongside the input prompt | `string` | N/A |
| `default_prompt` | Default text shown in the input prompt | `string` | N/A |
| `win_options` | Window-level Vim options | `table<string, any>` | `:h nvim_win_set_option` |
| `buf_options` | Buffer-level Vim options | `table<string, any>` | `:h nvim_buf_set_option` |
| `win_config` | Window configuration for `nvim_open_win` | `table<string, any>` | `:h nvim_open_win` |
| `width_options` | Dynamic width settings | `table<string, any>` | See [Width Options](#width-options) |
| Option | Description | Type | Notes |
| ---------------- | ---------------------------------------- | -------------------- | ----------------------------------- |
| `icon` | Icon displayed next to the prompt | `string` | N/A |
| `default_prompt` | Default text for the prompt | `string` | N/A |
| `win_options` | Window-level Vim options | `table<string, any>` | See `:h nvim_win_set_option` |
| `buf_options` | Buffer-level Vim options | `table<string, any>` | See `:h nvim_buf_set_option` |
| `win_config` | Window configuration for `nvim_open_win` | `table<string, any>` | See `:h nvim_open_win` |
| `width_options` | Dynamic width settings | `table<string, any>` | See [Width Options](#width-options) |

#### Width Options

| Sub-Option | Description | Type | Note |
| ----------- | --------------------- | ------------------ | ------------------------------------- |
| `prefer` | Preferred input width | `number` | Used as the default target width |
| `min_value` | Minimum allowed width | `{number, number}` | Supports fixed width and window ratio |
| `max_value` | Maximum allowed width | `{number, number}` | Supports fixed width and window ratio |
| Sub-Option | Description | Type | Notes |
| ----------- | --------------------- | ------------------ | ------------------------------------ |
| `prefer` | Preferred input width | `number` | Default target width |
| `min_value` | Minimum allowed width | `{number, number}` | Fixed width or ratio of window width |
| `max_value` | Maximum allowed width | `{number, number}` | Fixed width or ratio of window width |

### Default Configuration

Expand All @@ -58,11 +59,7 @@ require("input").setup({
listchars = "precedes:…,extends:…",
sidescrolloff = 0,
},
buf_options = {
swapfile = false,
bufhidden = "wipe",
filetype = "input",
},
buf_options = {},
win_config = {
relative = "cursor",
anchor = "NW",
Expand All @@ -83,7 +80,35 @@ require("input").setup({
})
```

## :eyes: Inspiration
## ⌨️ Key Mappings

These are the default key mappings:

| Keybinding | Mode(s) | Action |
| ---------- | ------- | --------------------------------------- |
| `<C-c>` | i, n | Cancel content changes and close input |
| `q` | n | Cancel content changes and close input |
| `<CR>` | i, n | Confirm content changes and close input |

## 🎨 Highlights

| Highlight Group | Purpose |
| --------------- | ----------------------------------------------------- |
| `InputIcon` | Status column icon, which displayed before the prompt |

To customize highlights for the plugin window:

```lua
require("input").setup({
win_options = {
winhighlight = "NormalFloat:DiagnosticError"
}
})
```

For more, see `:h winhighlight`.

## 👀 Inspiration

- [dressing.nvim](https://github.com/stevearc/dressing.nvim)

Expand Down
Loading