TakeV/spacemacs
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/+completion/ivy
History
MadAnd 8fea6f134d ivy: Use new API to register additional transient state bindings 
This is a follow-up commit after #8155 has been merged. It applies the same
changes to code of the `ivy` layer. It is not part of #8155 because there was
no `ivy` layer when that PR was submitted.
2017-05-24 09:12:48 +02:00
..
local/ivy-spacemacs-help Add beginners tutorial to ivy-spacemacs-help. 2017-04-16 11:14:59 -04:00
config.el helm/ivy: Limit rg results to 150 columns 2017-05-07 22:07:42 -04:00
funcs.el Bump year in copyright headers 2017-01-05 23:08:17 -05:00
layers.el Bump year in copyright headers 2017-01-05 23:08:17 -05:00
packages.el ivy: Use new API to register additional transient state bindings 2017-05-24 09:12:48 +02:00
README.org update docs to the new toc-org format 2017-05-22 18:35:37 +03:00

README.org

Ivy layer

Description

This layer enables Ivy for completion. It will replace the default completion by 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.

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

You can customize ivy with the following variables:

  • ivy-wrap Whether C-n and C-p should wrap-around when at the 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.

Key Bindings

If you choose ivy as completion system, make sure to read the official manual. In case you don't want to read everything, at least familiarise with 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