Automatically and non-intrusively add a vi editing mode to all textareas/inputs. Behaviour is unchanged until you hit Escape.

Latest Version

Version

0.0.10

Update

November 24, 2024

Size

32.85KiB

Developer

Vi Editing Mode Extension

Automatically and non-intrusively add a vi editing mode to all textarea/input
elements on pages, so you can use vim keys/shortcuts to edit and navigate text.
Inputs/textareas keep working as they normally do (like insert mode, handled by
the browser), hitting \"escape\" enables command mode on the focused element,
indicated with a box-shadow.

Features:
- Simple, automatic, non-intrusive vi editing.
- Command, visual and visual-line modes.
- Plenty of commands/keys (but please contribute more!)
- Multi-level undo and redo.
- Repeat.
- The tab key inserts literal tabs after having been in command mode, until the
element loses focus.
- Only basic addon permissions needed. (clipboard read/write permission
requested on first use).

Non-goals:
- vi-like keys for other browser behaviour, like navigating on a page or the
internet.
- Full-blown vi/vim editor (not all commands are needed, it doesn't have to
look like a standalone vi/vim, it would be too much for an input element).
- Marks, tags, macros, registers, custom key mappings and other advanced features.

# Limitations

Since vi.js uses basic textarea/input elements, it inherits some
limitations/behaviour:

Textareas don't expose whether text (e.g. the selection) is visible in the
viewport. This limits how vi.js can implement some commands/motions.

Insert mode is handled by the browser (with the exeception of Tab, which can
insert a literal tab), including undo/redo while typing. JS doesn't have access
to textarea undo/redo history. vi.js tracks history for changes it makes (based
on commands), and tracks changes during insert by comparing contents between
going into insert mode. The edits a user makes in insert mode are turned into a
single history change to undo/redo.

In vi/vim, the cursor is typically \"on\" a character. With a textarea, it is
shown between characters. The position at the end of the line, after the last
character, before the newline, is not normally a separate position in vi. vi.js
lets you navigate to these positions, which changes how some motion keys work.

Access to the clipboard is only explicitly with the \"y\" and \"p\" keys. Commands
that remove/replace text don't change the clipboard.

Not all input types are supported, browsers only allow editing selections on
some types: text, search, url, tel, password. Others don't work: email, time,
etc.

Popular messaging web applications have custom UI elements for sending messages,
for their rich text. They often don't use standard textarea/input elements, so
this plugin won't help with those apps.

Some applications use \"Escape\" as a shortcut to cancel. Use \"ctrl-{\" as
alternative. Unfortunately, the obvious alternative \"ctrl-[\" is interpreted by
firefox as \"back\" and can't be intercepted.

Plenty of vi/vim keys haven't been implemented yet. People typically use a
subset of all the many vi/vim key bindings. Please submit a PR for commands
you're missing and want. Keep the code maintainable.

The source code is Open Source, MIT-licensed, see https://github.com/mjl-/vijs.

Source Manifest.json

{"update_url": "https://clients2.google.com/service/update2/crx",\t"manifest_version": 3,\t"name": "Vi Editing Mode",\t"version": "0.0.10",\t"description": "Automatically and non-intrusively add a vi editing mode to all textareas/inputs. Behaviour is unchanged until you hit Escape.",\t"icons": {\t\t"16": "icons/icon-16.png",\t\t"32": "icons/icon-32.png",\t\t"48": "icons/icon-48.png",\t\t"96": "icons/icon-96.png",\t\t"128": "icons/icon-128.png"\t},\t"content_scripts": [\t\t{\t\t\t"matches": [""],\t\t\t"js": ["vi.js"]\t\t}\t],\t"optional_permissions": [\t\t"clipboardRead",\t\t"clipboardWrite"\t]}

Download CRX(32.85KiB)