/eaf

Primary LanguageEmacs Lisp

eaf layer

Table of Contents

Description

This layer adds support for the Emacs Application Framework (EAF).

Features:

  • Browse using a full-fledged browser within Emacs
  • PDF viewer (with continuous scroll)
  • Video player
  • Image viewer
  • See EAF documentation for many more features

Install

To use this configuration layer, add it to your ~/.spacemacs. You will need to add eaf to the existing dotspacemacs-configuration-layers list in this file.

Currently the command SPC SPC eaf-install-dependencies no longer works, please refer to install the required dependencies manually.

Usage

Configuring applications

By default, all applications provided by eaf package are loaded, including:

  • eaf-jupyter
  • eaf-browser
  • eaf-airshare
  • eaf-file-browser
  • eaf-file-manager
  • eaf-file-sender
  • eaf-music-player
  • eaf-system-monitor
  • eaf-mindmap
  • eaf-org-previewer
  • eaf-terminal
  • eaf-netease-cloud-music
  • eaf-video-player
  • eaf-image-viewer
  • eaf-demo
  • eaf-vue-demo
  • eaf-pdf-viewer
  • eaf-markdown-previewer
  • eaf-camera

To customise applications, please set the variable eaf-apps

Configuring key bindings

Configuration of EAF key bindings works in a different way than normally in Spacemacs.

Also EAF, and additionally this layer, implement some tricks that are required to make leader keys in EAF buffers behave as expected in Spacemacs. Therefore it is recommended to keep these default (major-mode-)leader keybindings.

For information about configuration of other key bindings for EAF, see here.

If you do want to modify the leader keys, then information about the tricks implemented in this layer can be found here and here.

Key bindings

Except for the few Spacemacs specific modifications listed below, all EAF keybindings are documented here.

Use SPC t k m to show the EAF key bindings persistently in which-key, or use SPC h d K to show the `eaf-mode-map` in a separate buffer.

Global

All EAF-applications

Key bindingDescription
SPC a a fEAF open file (see EAF doc for supported file types)
SPC a a sEAF open system monitor
SPC a a MEAF open musik player
SPC t k mShow available key commands in which-key (read here for more details)
SPC m dtoggle dark-mode (or in browser press M-d and in pdf-viewer just press d)

Browser

Key bindingDescription
SPC a a b oOpen url in new buffer
SPC a a b sSearch with your favorite search engine. Defaults to symbol at point or region string
SPC a a b bOpen bookmark in new buffer
SPC a a b hSearch and open buffer from history

Local

All EAF-applications

Key bindingDescription
j/kScroll up/down

Browser

Key bindingDescription
J/KScroll (half) page up/down
eEdit url
mBookmark page
C-sSearch/search find next (to enter new search prefix with C-g
C-rSearch find previous
SPC m hOpen new buffer from history
SPC m sSearch web with favorite search engine

PDF-viewer

Key bindingDescription
dtoggle dark-mode

pdf-view-mode (pdf-tools)

Key bindingDescription
SPC m eopen in eaf pdf-viewer