https://github.com/rougier/nano-sidebar

Emacs package to have configurable sidebars on a per frame basis.
https://github.com/rougier/nano-sidebar

elisp emacs frame nano sidebar

Last synced: about 2 months ago
JSON representation

Emacs package to have configurable sidebars on a per frame basis.

• Host: GitHub
• URL: https://github.com/rougier/nano-sidebar
• Owner: rougier
• License: gpl-3.0
• Created: 2021-08-30T17:38:21.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-09-02T04:54:31.000Z (over 3 years ago)
• Last Synced: 2024-08-01T03:42:45.533Z (5 months ago)
• Topics: elisp, emacs, frame, nano, sidebar
• Language: Emacs Lisp
• Homepage:
• Size: 1.55 MB
• Stars: 113
• Watchers: 3
• Forks: 6
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
## GNU Emacs / N Λ N O sidebar

This package allows to have configurable sidebars on a per frame basis.

### Installation

Install with [straight.el](https://github.com/raxod502/straight.el):

```

(straight-use-package '(nano-sidebar :type git :host github

                                     :repo "rougier/nano-sidebar"))

```

... or install with [`quelpa`](https://github.com/quelpa/quelpa):

```emacs-lisp

(use-package nano-sidebar

  :ensure nil

  :defer t

  :quelpa (nano-sidebar

           :fetcher github

           :repo "rougier/nano-sidebar"))

```

### Usage

It is possible to use the sidebar without any configuration

```emacs-lisp

(require 'nano-sidebar)

(nano-sidebar-toggle)

```

In such case, a sidebar with default values is created and the default

init function is called.

You can also configure sidebars individually by first naming your frame

and then provide a specific configuration:

```emacs-lisp

(defun nano-sidebar-mu4e-init (frame sidebar)

  (select-frame sidebar)

  (do-some-stuff...))

(add-to-list 'nano-sidebar-properties

   `("mu4e"    36 dark ,nano-dark-background nano-sidebar-mu4e-init))

(set-frame-parameter nil 'name "mu4e")

(nano-sidebar-toggle)

```

### Screenshots

This screenshot shows a sidebar displaying a custom ibuffer. See [nano-sidebar-ibuffer.el](nano-sidebar-ibuffer.el)

![](images/nano-sidebar-ibuffer.png)

This screenshot shows a sidebar displaying a mu4e dashboard. See [mu4e-dashboard](https://github.com/rougier/mu4e-dashboard)

![](images/nano-sidebar-mu4e.png)