doomemacs/modules/ui/window-select
Henrik Lissner 037b018cdd
feat: add .doommodule files
These optional dotfiles indicate the root of a module or module
group (:lang), and will later contain module metadata. They will also
serve as an alternative to packages.el and doctor.el, and will aide the
parts of the v3.0 module API concerned with resolving the current module
from a path (`doom-module-from-path`), which currently rely too heavily
on parsing path strings.

For now, however, they're simply placeholders.
2024-09-14 20:47:39 -04:00
..
.doommodule feat: add .doommodule files 2024-09-14 20:47:39 -04:00
config.el fix(window-select): unset winum-auto-setup-mode-line sooner 2023-02-23 01:09:32 -05:00
packages.el bump: :ui 2023-02-20 22:47:23 -05:00
README.org docs(*): replace all-the-icons with nerd-icons 2023-09-16 20:19:11 +02:00

:ui window-select

Description   unfold

This module provides several methods for selecting windows without the use of the mouse or spatial navigation (e.g. C-w {h,j,k,l}).

The command other-window is remapped to either doom-package:switch-window or doom-package:ace-window, depending on which backend you've enabled. It is bound to C-x o (and C-w C-w for evil users).

It also provides numbered windows and selection with the doom-package:winum package, if desired. Evil users can jump to window N in C-w <N> (where N is a number between 0 and 9). Non evil users have C-x w <N> instead.

Maintainers

This module has no dedicated maintainers. Become a maintainer?

Module flags

+numbers
Enable numbered windows and window selection (using doom-package:winum).
+switch-window
Use the doom-package:switch-window package as the backend, instead of ace-window (doom-package:avy).

Hacks

No hacks documented for this module.

TODO Changelog

This module does not have a changelog yet.

Installation

Enable this module in your doom! block.

This module has no external requirements.

TODO Usage

󱌣 This module has no usage documentation yet. Write some?

TODO Configuration

󱌣 This module's configuration documentation is incomplete. Complete it?

This module provides two backends, both providing the same functionality, but with different visual cues. They are doom-package:ace-window and doom-package:switch-window.

ace-window

The first character of the buffers changes to a highlighted, user-selectable character.

  • Pros: the content of the buffers are always visible.
  • Cons: The display characters are small and difficult to see (see below for a way to enlarge them).

Custom font-face example

This changes the ace-window display to show a white letter with a red background. The box attribute adds some padding:

(custom-set-faces!
  '(aw-leading-char-face
    :foreground "white" :background "red"
    :weight bold :height 2.5 :box (:line-width 10 :color "red")))

switch-window

Replaces the entire buffer with large letters.

  • Pros: The displayed characters are really easy to see.
  • Cons: You can't see the contents of the buffers.

Troubleshooting

There are no known problems with this module. Report one?

Frequently asked questions

This module has no FAQs yet. Ask one?

TODO Appendix

󱌣 This module has no appendix yet. Write one?