Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rolandwalker/nav-flash
Briefly highlight the current line in Emacs
https://github.com/rolandwalker/nav-flash
Last synced: 3 months ago
JSON representation
Briefly highlight the current line in Emacs
- Host: GitHub
- URL: https://github.com/rolandwalker/nav-flash
- Owner: rolandwalker
- Created: 2012-08-19T19:21:20.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2022-07-26T11:17:06.000Z (over 2 years ago)
- Last Synced: 2024-02-17T07:36:06.896Z (9 months ago)
- Language: Emacs Lisp
- Size: 57.6 KB
- Stars: 26
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.markdown
Awesome Lists containing this project
README
[](http://travis-ci.org/rolandwalker/nav-flash)
# Overview
Briefly highlight the current line in Emacs.
* [Quickstart](#quickstart)
* [Explanation](#explanation)
* [See Also](#see-also)
* [Notes](#notes)
* [Compatibility and Requirements](#compatibility-and-requirements)
## Quickstart
```elisp
(require 'nav-flash)
(nav-flash-show)
```
## Explanation
Nav-flash temporarily highlights the line containing the point,
which is sometimes useful for orientation after a navigation command.
There is no user-level interface for this library; it is only used
by other Lisp libraries. However, you might find it useful to call
`nav-flash-show` in your `~/.emacs` file. For example, the following
hook causes a flash to appear after navigating via imenu:
```elisp
(add-hook 'imenu-after-jump-hook 'nav-flash-show nil t)
```
## See Also
* M-x customize-group RET nav-flash RET
* M-x customize-group RET pulse RET
## Notes
This library reuses an overlay defined in `compile.el`, but should
not affect the normal use of `compile.el` / `next-error`.
`pulse.el` provides similar functionality and is included with
Emacs. This library can use `pulse.el`, but does not do so by
default, because `pulse.el` uses `sit-for`, breaking this type
of construct:
```elisp
(nav-flash-show)
(with-temp-message "message here"
(sit-for 2))
```
When using an overlay and timer for cleanup (as nav-flash does
by default) the flash and message appear simultaneously.
`nav-flash.el` is also simpler than `pulse.el`.
## Compatibility and Requirements
GNU Emacs version 25.1-devel : not tested
GNU Emacs version 24.5 : not tested
GNU Emacs version 24.4 : yes
GNU Emacs version 24.3 : yes
GNU Emacs version 23.3 : yes
GNU Emacs version 22.2 : yes, with some limitations
GNU Emacs version 21.x and lower : unknown
No external dependencies