desktop-notify-nvim

desktop-notify-nvim copied to clipboard

.. default-role:: code

################################### Desktop notifications from Neovim ###################################

This plugin provides implementations of the vim.notify function which use the operating system's notification facility to display native notifications. Currently only shelling out to notify-send is implemented, but other implementations can be added. Contributions are very welcome.

.. image:: doc/screenshot.png :align: center :alt: Screenshot of a Neovim window with a native desktop notification hovering on top of it. The command-line of the Neovim window shows the command which produced the notification.

Installation and dependencies #############################

First install this plugin like any other Neovim plugins. You will also need to satisfy dependencies for the particular implementation you wish to use.

Shelling out to notify-send: Requires notify-send to be in your $PATH

Usage

You can try calling the implementation directly. Example:

.. code:: vim

lua require('desktop_notify').notify_send('Hello from Neovim')

Once you execute the above command in your running Neovim instance a notification native to your OS should open up. In practice you will probably want to overwrite the default implementation with this one.

.. code:: lua

vim.notify = require('desktop_notify').notify_send

License #######

Released under the MIT (Expat) license. Please refer to the LICENSE_ file for details.

.. _LICENSE: LICENSE.txt