File: erc-status-sidebar.el.html
This package provides a HexChat-like sidebar for joined channels in
ERC. It relies on the erc-track module, and displays all of the
same information that erc-track does in the mode line, but in an
alternative format in form of a sidebar.
Shout out to sidebar.el <https://github.com/sebastiencs/sidebar.el> and outline-toc.el <https://github.com/abingham/outline-toc.el> for the sidebar window management ideas.
Usage:
Use M-x erc-status-sidebar-open RET to open the ERC status sidebar
in the current frame. Make sure that the erc-track module is
active (this is the default).
Use M-x erc-status-sidebar-close RET to close the sidebar on the current frame. With a prefix argument, it closes the sidebar on all frames.
Use M-x erc-status-sidebar-kill RET to kill the sidebar buffer and close the sidebar on all frames.
In addition to the commands above, you can also try the all-in-one
entry point erc-bufbar-mode(var)/erc-bufbar-mode(fun). See its doc string for usage.
If you want the status sidebar enabled whenever you use ERC, add
bufbar to erc-modules. Note that this library also has a major
mode, erc-status-sidebar-mode, which is for internal use.
Defined variables (19)
erc-bufbar-mode | Non-nil if Erc-Bufbar mode is enabled. |
erc-bufbar-mode-hook | Hook run after entering or leaving ‘erc-bufbar-mode’. |
erc-status-sidebar--active-marker | Marker indicating currently active buffer. |
erc-status-sidebar--highlight-refresh-triggers | Triggers enabled with ‘erc-status-sidebar-highlight-active-buffer’. |
erc-status-sidebar--singular-p | Whether to restrict the sidebar to a single frame. |
erc-status-sidebar-buffer-name | Name of the sidebar buffer. |
erc-status-sidebar-channel-format | Function used to format channel names for display in the sidebar. |
erc-status-sidebar-channel-sort | Sorting function used to determine order of channels in the sidebar. |
erc-status-sidebar-click-display-action | How to display a buffer when clicked. |
erc-status-sidebar-header-line-format | Header line format for the status sidebar. |
erc-status-sidebar-highlight-active-buffer | Whether to highlight the selected window’s buffer in the sidebar. |
erc-status-sidebar-mode-abbrev-table | Abbrev table for ‘erc-status-sidebar-mode’. |
erc-status-sidebar-mode-hook | Hook run after entering ‘erc-status-sidebar-mode’. |
erc-status-sidebar-mode-line-format | Mode line format for the status sidebar. |
erc-status-sidebar-mode-map | Keymap for ‘erc-status-sidebar-mode’. |
erc-status-sidebar-mode-syntax-table | Syntax table for ‘erc-status-sidebar-mode’. |
erc-status-sidebar-refresh-triggers | Hooks to refresh the sidebar on. |
erc-status-sidebar-style | Preset style for rendering the sidebar. |
erc-status-sidebar-width | Default width of the sidebar (in columns). |