Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jcs-elpa/modablist

Modifiable tabulated-list extension.
https://github.com/jcs-elpa/modablist

emacs excel spreadsheet tablist

Last synced: about 1 month ago
JSON representation

Modifiable tabulated-list extension.

Awesome Lists containing this project

README

        

[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

# modablist
> Modifiable tabulated-list extension.

[![CI](https://github.com/jcs-elpa/modablist/actions/workflows/test.yml/badge.svg)](https://github.com/jcs-elpa/modablist/actions/workflows/test.yml)



This package makes `tabulated-list` editable like spreadsheet.

By the current implementation this package alone doesn't do much. You
would probably need to extend this package and treat this as a `library`
or `framework`.

## 🏆 Features

* Editable table
* Add new row (empty)
* Table box selection

## ❓ Work with upstream

Most packages would probably have their own variable that contains all data
to and just use `tabulated-list` to display it. Yet this package respect data
from `tabulated-list` itself and **NOT** the data from their variable.

Here is the list of open API/hooks for you to update the upstream database
from user.

* `modablist-new-data-hook`
* `modablist-change-data-hook`

## 🖼️ Faces

The following list of faces are possible to customize.

* `modablist-select-face` - Overlay face when selecting.
* `modablist-insert-face` - Overlay face when inserting.

## 🛠 Contribute

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
[![Elisp styleguide](https://img.shields.io/badge/elisp-style%20guide-purple)](https://github.com/bbatsov/emacs-lisp-style-guide)
[![Donate on paypal](https://img.shields.io/badge/paypal-donate-1?logo=paypal&color=blue)](https://www.paypal.me/jcs090218)
[![Become a patron](https://img.shields.io/badge/patreon-become%20a%20patron-orange.svg?logo=patreon)](https://www.patreon.com/jcs090218)

If you would like to contribute to this project, you may either
clone and make pull requests to this repository. Or you can
clone the project and establish your own branch of this tool.
Any methods are welcome!

### 🔬 Development

To run the test locally, you will need the following tools:

- [Eask](https://emacs-eask.github.io/)
- [Make](https://www.gnu.org/software/make/) (optional)

Install all dependencies and development dependencies:

```sh
$ eask install-deps --dev
```

To test the package's installation:

```sh
$ eask package
$ eask install
```

To test compilation:

```sh
$ eask compile
```

**🪧 The following steps are optional, but we recommend you follow these lint results!**

The built-in `checkdoc` linter:

```sh
$ eask lint checkdoc
```

The standard `package` linter:

```sh
$ eask lint package
```

*📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.*

## ⚜️ License

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see .

See [`LICENSE`](./LICENSE.txt) for details.