notify.hx

A Helix plugin to display notification popups.

Installation

NOTE: Helix plugin support is still experimental

Follow the instructions here⁠ to install Helix with its plugin branch.

Once you have Helix with the plugin support you also should have steel REPL and forge package manager.

You can install the notify.hx with Forge now:

forge pkg install --git https://github.com/chuwy/notify.hx.git

Once installed, you can add the following to init.scm in your Helix config directory:

(require "notify/notify.scm")

Usage

This plugin is intended to be used by other plugins from Steel⁠:

(require "notify/notify.scm")

(notify "This is a minimal popup with info severity")

(notify "This is a warning showing some options" #:severity 'warning #:title "notify.hx demo" #:duration 10000 #:render 'default)

(notify "...and an error" #:severity 'error #:title "notify.hx demo" #:duration 10000)

(notify "Have fun!" #:title "notify.hx demo" #:duration 2000)

But you also can invoke it as a plain command:

:notify "Works from here as well!"

Configuration

You can configure the plugin via public notify-config function that can be called in init.scm.

Render

If you want the popups to take less space you can set the 'render option to 'minimal:

;; init.scm
(require "notify/notify.scm")

(notify-config 'render 'minimal)   ;; Default is 'default

The render can be overwritten by publisher using #:render keyword, it has a priority over user config.

Why

Helix out of the box shows most informational messages in a statusline. Although it goes inline with Helix' minimalistic design it has some flaws:

• Tailored for fully synchronous work
• Just a single line of information
• No yank
• No additional metadata

notify.hx solves all these problem.

Acknowledgments

• @mattwparas⁠ for his work on the plugin system for Helix and his help on Steel Discord
• @rcarriga⁠ for nvim-notify⁠ where notify.hx draws an inspiration from