78297be625
* Fix various isolated typos "apppend" -> "append" "availabe" -> "available" "Descripti using ternon" -> "Description" "you have not them" -> "you don't have them" "new on" -> "new one" "plained" -> "curved" "repel" -> "REPL" "vairable" -> "variable" * Fix a few errors in the CoffeeScript layer readme Add a missing "the". Correct a reference to the layer as "javascript" to "coffeescript". Fix the syntax on the link to CoffeeLint. * Fix typos: "dofile" -> "dotfile" * Fix typos: "formated" and "formating" "formated" -> "formatted" "formating" -> "formatting" * hy: Fix docstrings in funcs.el Fix copy-and-pasted docstring text for spacemacs/hy-shell-eval-current-form-and-go and spacemacs/hy-shell-eval-region-and-go. * Fix typos: "indendation" -> "indentation" * Fix typos: "the the", "a a" Fix duplicated (or misplaced) articles. * Fix typos: "wether" -> "whether" * Fix typos: "intialize" -> "initialize"
91 lines
4.4 KiB
Org Mode
91 lines
4.4 KiB
Org Mode
#+TITLE: Ivy layer
|
|
|
|
* Table of Contents :TOC_4_gh:noexport:
|
|
- [[#description][Description]]
|
|
- [[#features][Features:]]
|
|
- [[#install][Install]]
|
|
- [[#configuration][Configuration]]
|
|
- [[#general][General]]
|
|
- [[#advanced-buffer-information][Advanced buffer information]]
|
|
- [[#key-bindings][Key Bindings]]
|
|
- [[#transient-state][Transient state]]
|
|
|
|
* Description
|
|
This layer enables Ivy for completion. It will replace the default completion by
|
|
[[https://github.com/emacs-helm/helm][Helm]].
|
|
|
|
These completion systems are the central control towers of Spacemacs, they are
|
|
used to manage buffers, projects, search results, configuration layers, toggles
|
|
and more...
|
|
|
|
Mastering your choice of completion system will make you a Spacemacs power user.
|
|
|
|
** Features:
|
|
- Project wide =grep= like text search via =search-auto=
|
|
- Project wide text replacements using =counsel-imenu=
|
|
- Buffer wide dynamic text search via =swiper=
|
|
- Detailed configuration parameters for ivy appearance
|
|
- Intuitive =transient state=
|
|
- Advanced buffer information with =ivy-rich=
|
|
|
|
* Install
|
|
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
|
|
add =ivy= to the existing =dotspacemacs-configuration-layers= list in this
|
|
file.
|
|
|
|
* Configuration
|
|
** General
|
|
You can customize ivy with the following variables:
|
|
|
|
- =ivy-wrap= Whether C-n and C-p should wrap-around when at the first or
|
|
last candidate. The default value is =nil=.
|
|
- =ivy-extra-directories= Setting this to =nil= hides . and .. directories from
|
|
file name completion. You can still go up a directory up by ~DEL~.
|
|
The default value is ("../", "./").
|
|
- =ivy-use-virtual-buffers= Add bookmarks and recent files to buffer completion
|
|
menu. The Spacemacs default is t.
|
|
- =ivy-height= The height of the minibuffer. The Spacemacs default is 15.
|
|
- =ivy-use-selectable-prompt= When non-nil, make the prompt line selectable like
|
|
a candidate. The Spacemacs default value is =t=.
|
|
|
|
** Advanced buffer information
|
|
To display more information about buffers set the layer variable
|
|
=ivy-enable-advanced-buffer-information= to =t= which will enable =ivy-rich=.
|
|
|
|
Note that =ivy-rich= has been reported to be very slow on =macOS=. This feature
|
|
is disabled by default.
|
|
|
|
#+BEGIN_SRC emacs-lisp
|
|
(setq-default dotspacemacs-configuration-layers '(
|
|
(ivy :variables ivy-enable-advanced-buffer-information t)))
|
|
#+END_SRC
|
|
|
|
* Key Bindings
|
|
If you choose =ivy= as completion system, make sure to read the [[http://oremacs.com/swiper/][official manual]].
|
|
In case you don't want to read everything, at least familiarise with
|
|
[[http://oremacs.com/swiper/#minibuffer-key-bindings][minibuffer key bindings]].
|
|
|
|
Some useful key bindings are presented in the following table.
|
|
|
|
| Key Binding | Description |
|
|
|-------------+------------------------------------------------------------------------------------------------------|
|
|
| ~RET~ | call default action on current candidate |
|
|
| ~M-RET~ | the same as ~RET~ but doesn't close completion minibuffer |
|
|
| ~C-M-j~ | use current input immediately (this can be used to create a new file in Find File) |
|
|
| ~tab~ | complete partially |
|
|
| ~M-o~ | show the list of valid actions on current candidate (then press any of described keys to execute it) |
|
|
| ~C-M-o~ | the same as ~M-o~ but doesn't close completion minibuffer |
|
|
| ~C-'~ | use avy to quickly select completion on current page (sometimes faster than using arrows) |
|
|
| ~<ESC>~ | close minibuffer |
|
|
|
|
** Transient state
|
|
Press ~M-SPC~ anytime in Ivy to get into the transient state.
|
|
|
|
| Key Binding | Description |
|
|
|-------------+---------------------------------------------------------|
|
|
| ~j~ | select next candidate |
|
|
| ~k~ | select previous candidate |
|
|
| ~d~ | call default action on candidate |
|
|
| ~g~ | the same as ~d~ but doesn't close completion minibuffer |
|
|
| ~o~ | leave transient state |
|