quick-peek

An inline pop-up library for Emacs Lisp.

🔌 API

See the docstrings of quick-peek-show and quick-peek-hide.

Complex programs may need to use the lower-level quick-peek-overlay-ensure-at, quick-peek-overlay-contents, and quick-peek-overlay-update methods.

🧪 Customization

See docstrings of quick-peek-background-face, quick-peek-border-face, and quick-peek-padding-face.

✏️ Changes

🛠️ Contribute

🔬 Development

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

• Eask
• Make (optional)

Install all dependencies and development dependencies:

eask install-deps --dev

To test the package's installation:

eask package
eask install

To test compilation:

eask compile

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

The built-in checkdoc linter:

eask lint checkdoc

The standard package linter:

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 https://www.gnu.org/licenses/.

See LICENSE for details.