https://github.com/observeroftime/notifications.nvim

Neovim plugin for desktop notifications.
https://github.com/observeroftime/notifications.nvim

neovim neovim-plugin notifications

Last synced: 16 days ago
JSON representation

Neovim plugin for desktop notifications.

• Host: GitHub
• URL: https://github.com/observeroftime/notifications.nvim
• Owner: ObserverOfTime
• License: bsd-2-clause
• Created: 2023-11-23T01:08:05.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2024-05-17T15:50:10.000Z (6 months ago)
• Last Synced: 2024-10-04T16:43:48.343Z (about 1 month ago)
• Topics: neovim, neovim-plugin, notifications
• Language: Lua
• Homepage:
• Size: 24.4 KB
• Stars: 18
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# notifications.nvim

Show notifications on the desktop.

## Platforms

* [x] Linux/BSD (glib2)

* [x] Windows (PowerShell)

* [x] macOS (AppleScript)

_The plugin also supports OSC 777, OSC 99, and OSC 9._

## Installation

### lazy.nvim

```lua

{

  'ObserverOfTime/notifications.nvim',

  opts = {

    override_notify = true,

    hist_command = 'Notifications',

    -- or set `icons = false` to disable all icons

    icons = {

      TRACE = '', -- '🔍',

      DEBUG = '󰠭', -- '🐞',

      INFO  = '', -- '📣',

      WARN  = '', -- '⚠️ ',

      ERROR = '', -- '🚨',

      OFF   = '', -- '⛔',

    },

    hl_groups = {

      TRACE = 'DiagnosticFloatingHint',

      DEBUG = 'DiagnosticFloatingHint',

      INFO = 'DiagnosticFloatingInfo',

      WARN = 'DiagnosticFloatingWarn',

      ERROR = 'DiagnosticFloatingError',

      OFF = 'DiagnosticFloatingOk',

    }

  },

  -- to use OSC 777/99/9:

  --[[

  config = function(_, opts)

    vim.g.notifications_use_osc = '777'

    require('notifications').setup(opts)

  end

  --]]

}

```

### pckr.nvim

```lua

{

  'ObserverOfTime/notifications.nvim',

  config = function()

    -- to use OSC 777/99/9:

    -- vim.g.notifications_use_osc = '777'

    require('notifications').setup {

      ...

    }

  end

}

```

## Usage

### Send a notification

```lua

vim.notify('Hello world', vim.log.levels.INFO, {

  icon = '󱇎',

  title = 'Test',

  critical = true

})

```

### View the history

```vim

:Notifications

```