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
avy--overlays-back
avy--overlays-lead
avy-action
avy-action-oneshot
avy-all-windows
avy-all-windows-alt
avy-background
avy-case-fold-search
avy-command
avy-current-path
avy-del-last-char-by
avy-dispatch-alist
avy-enter-times-out
avy-escape-chars
avy-flyspell-correct-function
avy-goto-word-0-regexp
avy-handler-function
avy-highlight-first
avy-ignored-modes
avy-indent-line-overlay
avy-key-to-char-alist
avy-keys
avy-keys-alist
avy-last-candidates
avy-lead-faces
avy-line-insert-style
avy-linum-mode
avy-linum-mode-hook
avy-orders-alist
avy-pre-action
avy-ring
avy-single-candidate-jump
avy-style
avy-styles-alist
avy-subword-extra-word-chars
avy-text
avy-timeout-seconds
avy-translate-char-function
avy-word-punc-regexp
avy-words

Defined functions (101)

avy--de-bruijn
avy--done
avy--find-visible-regions
avy--generic-jump
avy--key-to-char
avy--line
avy--line-cands
avy--linum-strings
avy--linum-update-window
avy--make-backgrounds
avy--next-invisible-point
avy--next-visible-point
avy--old-str
avy--overlay
avy--overlay-at
avy--overlay-at-full
avy--overlay-post
avy--overlay-pre
avy--path-alist-1
avy--process
avy--process-1
avy--read-candidates
avy--regex-candidates
avy--remove-leading-chars
avy--style-fn
avy--update-offset-and-str
avy--visible-p
avy-action-copy
avy-action-goto
avy-action-ispell
avy-action-kill-move
avy-action-kill-stay
avy-action-mark
avy-action-teleport
avy-action-yank
avy-action-yank-line
avy-action-zap-to-char
avy-candidate-beg
avy-candidate-end
avy-candidate-wnd
avy-copy-line(ARG)
avy-copy-region(ARG)
avy-dowindows
avy-goto-char(CHAR &optional ARG)
avy-goto-char-2(CHAR1 CHAR2 &optional ARG BEG END)
avy-goto-char-2-above(CHAR1 CHAR2 &optional ARG)
avy-goto-char-2-below(CHAR1 CHAR2 &optional ARG)
avy-goto-char-in-line(CHAR)
avy-goto-char-timer(&optional ARG)
avy-goto-end-of-line(&optional ARG)
avy-goto-line(&optional ARG)
avy-goto-line-above(&optional OFFSET BOTTOM-UP)
avy-goto-line-below(&optional OFFSET BOTTOM-UP)
avy-goto-subword-0(&optional ARG PREDICATE BEG END)
avy-goto-subword-1(CHAR &optional ARG)
avy-goto-symbol-1(CHAR &optional ARG)
avy-goto-symbol-1-above(CHAR &optional ARG)
avy-goto-symbol-1-below(CHAR &optional ARG)
avy-goto-whitespace-end(ARG &optional BEG END)
avy-goto-whitespace-end-above
avy-goto-whitespace-end-below
avy-goto-word-0(ARG &optional BEG END)
avy-goto-word-0-above
avy-goto-word-0-below
avy-goto-word-1(CHAR &optional ARG BEG END SYMBOL)
avy-goto-word-1-above(CHAR &optional ARG)
avy-goto-word-1-below(CHAR &optional ARG)
avy-goto-word-or-subword-1[Arg list not available until function definition is loaded.]
avy-handler-default
avy-isearch[Arg list not available until function definition is loaded.]
avy-jump
avy-kill-region(ARG)
avy-kill-ring-save-region(ARG)
avy-kill-ring-save-whole-line(ARG)
avy-kill-whole-line(ARG)
avy-linum-mode
avy-mouse-event-window
avy-move-line(ARG)
avy-move-region[Arg list not available until function definition is loaded.]
avy-multipop
avy-next
avy-order-closest
avy-org-goto-heading-timer
avy-org-refile-as-child
avy-pop-mark
avy-pre-action-default
avy-prev
avy-process(CANDIDATES &optional OVERLAY-FN CLEANUP-FN)
avy-push-mark
avy-read
avy-read-de-bruijn
avy-read-words
avy-resume
avy-setup-default[Arg list not available until function definition is loaded.]
avy-show-dispatch-help
avy-subdiv
avy-transpose-lines-in-region[Arg list not available until function definition is loaded.]
avy-traverse
avy-tree
avy-window-list
avy-with

Defined faces (0)