4.8 KiB
:feature popup
This module provides a highly customizable popup window management system.
Not all windows are created equally. Some are less important. Some I want gone once they have served their purpose, like code output or a help buffer. Others I want to stick around, like a scratch buffer or org-capture popup.
More than that, popups ought to be be the second class citizens of my editor; spawned off to the side, discarded with the simple push of a button (Escape/C-g), and easily restored if I want to see them again. Of course, this system should clean up after itself and kill off buffers I mark as transient.
Table of Contents TOC
Configuration
The :popup setting
This module has one setting for defining your own rules for popups:
(set! :popup CONDITION &optional ALIST PARAMETERS)CONDITIONcan be a function or regexp string. If the function returns non-nil, or the regexp string matches the buffer's name, it will be opened in a popup window.ALISTdictates the characteristics of the popup, such as what side to spawn it on and what size to make it. Seedisplay-buffer's documentation to see what parameters are supported. This supports one custom parameter:size, which will map towindow-widthorwindow-heightdepending on whatsideyou (or the defaults) specify.PARAMETERSdictate what window parameters are set on the popup window. See+popup-window-parameters's documentation and the Window Parameters section of the Emacs manual for what parameters are supported. This supports four custom parameters:transient,quit,selectandmodeline. For details on these, look at the documentation for+popup-window-parameters.
Rules are added to display-buffer-alist, which instructs display-buffer
calls on how to set up windows for buffers that meet certain conditions.
The
switch-to-buffercommand (and itsswitch-to-buffer-*variants) are not affected bydisplay-buffer-alist.
Here are a couple example rules:
(set! :popup "^ \\*") ; a fallback for special buffers
(set! :popup "^\\*" nil '((select . t)))
(set! :popup "^\\*\\(?:scratch\\|Messages\\)" nil '((transient)))
(set! :popup "^\\*Help"
'((size . 0.2))
'((select . t)))
(set! :+popup "^\\*doom:"
'((size . 0.35))
'((select . t) (quit) (transient)))
And here are the default settings for ALIST and PARAMETERS, which will be
overwritten if specified in your :popup rules.
(defvar +popup-default-alist
'((slot . 1)
(window-height . 0.14)
(window-width . 26)
(reusable-frames . visible))
"The default alist for `display-buffer-alist' rules.")
(defvar +popup-default-parameters
'((transient . t)
(quit . t))
"The default window parameters.")Disabling aggressive mode-line hiding in popups
There are two ways to go about this. You can turn on modelines by changing the
default 'modeline window parameter in +popup-default-parameters:
;; put in private/$USER/config.el
(map-put +popup-default-parameters 'modeline t)This will ensure all popups have a modeline by default, but allows you to override this on a per-popup basis.
Alternatively, you can disable modeline-hiding entirely:
;; put in private/$USER/config.el
(remove-hook '+popup-buffer-mode-hook '+popup|set-modeline)Appendix
Commands
+popup/other(aliased toother-popup, bound toC-x p)+popup/toggle+popup/close+popup/close-all+popup/toggle+popup/restore+popup/raisewithout-popups!save-popups!
Hacks
help-modehas been advised to follow file links in the buffer you were in before entering the popup, rather than in a new window.wgrepbuffers are advised to close themselves when aborting or committing changes.persp-modeis advised to restore popup windows when loading a session from file.- Interactive calls to
windmove-*commands (used byevil-window-*commands) will ignore theno-other-windowwindow parameter, allowing you to switch to popup windows as if they're ordinary windows. balance-windowshas been advised to close popups while it does its business, then restores them afterwards.neotreeadvisesbalance-windows, which causes major slow-downs when paired with ourbalance-windowadvice, so we removes neotree's advice.