Emacs library to facilitate the creation of tabulated-list based UIs
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Damien Cassou 640ce4b58d Merge branch 'master' of jao/navigel into master 1 week ago
examples Rename navigel-examples-fs to navigel-ex-fs 3 months ago
media Add initial README.org 4 months ago
test Introduce navigel-method to simplify usages of cl-defmethod 3 months ago
.drone.yml Switch from gitlab-ci to drone 1 week ago
.gitignore Ignore makel.mk 3 months ago
COPYING Initial commit 4 months ago
Makefile Update makel 1 week ago
README.org Add support for bookmark 2 months ago
navigel.el Doc lint fix 1 week ago

README.org

navigel

#+BEGIN_HTML

MELPA Stable

MELPA

pipeline status

#+END_HTML

Summary

The navigel package is a library that makes it simpler for Emacs Lisp developers to define user-interfaces based on tablists (also known as tabulated-lists). Overriding a few (CL) methods and calling `navigel-open' is all that's required to get a nice UI to navigate your domain objects (files, music library, database, etc.).

Navigel displays "entities" in a tablist. An "entity" is whatever you want that has a name. If an entity defines some "children", then pressing RET on the entity will list its children in another tablist.

Some features of navigel include:

  • pressing RET on an entity lists the entity's children in another
  • tablist;
  • pressing ^ opens the parent of the current entity;
  • pressing m marks the entity at point;
  • pressing d deletes the marked entities.

Navigel automatically adds support for bookmarks and imenu.

This package depends on tablist to get support for marking, deletion and more. On top of the tablist package, navigel provides an easy way to specify the content of your tabulated lists: through entities specified with method overrides. This makes it a breath to have tablist-based navigation within domain objects.

Usage

This code is a library and is meant for Emacs Lisp developers. The source code is well documented and organized in sections. Please have a look at it.

Please have a look at the examples/navigel-ex-fs.el file for an example on how to use the library. This file guides the reader through an implementation of a tablist-based directory navigator with support for marking and deleting:

media/files.png

License

See COPYING. Copyright (c) 2019 Damien Cassou.

#+BEGIN_HTML Donate using Liberapay #+END_HTML