File: avy.el.html
With Avy, you can move point to any position in Emacs – even in a different window – using very few keystrokes. For this, you look at the position where you want point to be, invoke Avy, and then enter the sequence of characters displayed at that position.
If the position you want to jump to can be determined after only issuing a single keystroke, point is moved to the desired position immediately after that keystroke. In case this isn't possible, the sequence of keystrokes you need to enter is comprised of more than one character. Avy uses a decision tree where each candidate position is a leaf and each edge is described by a character which is distinct per level of the tree. By entering those characters, you navigate the tree, quickly arriving at the desired candidate position, such that Avy can move point to it.
Note that this only makes sense for positions you are able to see when invoking Avy. These kinds of positions are supported:
* character positions
* word or subword start positions
* line beginning positions
* link positions
* window positions
If you're familiar with the popular ace-jump-mode package, this
package does all that and more, without the implementation
headache.
Defined variables (41)
avy--overlay-offset | The offset to apply in ‘avy--overlay’. |
avy--overlays-back | Hold overlays for when ‘avy-background’ is t. |
avy--overlays-lead | Hold overlays for leading chars. |
avy-action | Function to call at the end of select. |
avy-action-oneshot | Function to call once at the end of select. |
avy-all-windows | Determine the list of windows to consider in search of candidates. |
avy-all-windows-alt | The alternative ‘avy-all-windows’ for use with C-u. |
avy-background | When non-nil, a gray background will be added during the selection. |
avy-case-fold-search | Non-nil if searches should ignore case. |
avy-command | Store the current command symbol. |
avy-current-path | Store the current incomplete path during ‘avy-read’. |
avy-del-last-char-by | List of event types, i.e. key presses, that delete the last |
avy-dispatch-alist | List of actions for ‘avy-handler-default’. |
avy-enter-times-out | Whether enter exits avy-goto-char-timer early. If nil it matches newline |
avy-escape-chars | List of characters that quit avy during ‘read-char’. |
avy-flyspell-correct-function | Function called to correct word by ‘avy-action-ispell’ when |
avy-goto-word-0-regexp | Regexp that determines positions for ‘avy-goto-word-0’. |
avy-handler-function | A function to call for a bad ‘read-key’ in ‘avy-read’. |
avy-highlight-first | When non-nil highlight the first decision char with ‘avy-lead-face-0’. |
avy-ignored-modes | List of modes to ignore when searching for candidates. |
avy-indent-line-overlay | When non-nil, display line overlay next to the first non-whitespace character. |
avy-key-to-char-alist | An alist from non-character keys to printable chars used in avy overlays. |
avy-keys | Default keys for jumping. |
avy-keys-alist | Alist of ‘avy-jump’ commands to ‘avy-keys’ overriding the default ‘avy-keys’. |
avy-last-candidates | Store the last candidate list. |
avy-lead-faces | Face sequence for ‘avy--overlay-at-full’. |
avy-line-insert-style | How to insert the newly copied/cut line. |
avy-linum-mode | Non-nil if Avy-Linum mode is enabled. |
avy-linum-mode-hook | Hook run after entering or leaving ‘avy-linum-mode’. |
avy-orders-alist | Alist of candidate ordering functions. |
avy-pre-action | Function to call before ‘avy-action’ is called. |
avy-ring | Hold the window and point history. |
avy-single-candidate-jump | In case there is only one candidate jumps directly to it. |
avy-style | The default method of displaying the overlays. |
avy-styles-alist | Alist of ‘avy-jump’ commands to the style for each command. |
avy-subword-extra-word-chars | A list of characters that should temporarily match "\w". |
avy-text | Store the input read by ‘avy--read-candidates’. |
avy-timeout-seconds | How many seconds to wait for the second char. |
avy-translate-char-function | Function to translate user input key into another key. |
avy-word-punc-regexp | Regexp of punctuation chars that count as word starts for ‘avy-goto-word-1. |
avy-words | Words to use in case ‘avy-style’ is set to ‘words’. |
Defined functions (101)
Defined faces (1)
avy-background-face | Face for whole window background during selection. |