https://github.com/echasnovski/mini.notify

Show notifications. Part of 'mini.nvim' library.
https://github.com/echasnovski/mini.notify

lua mini-nvim neovim neovim-plugin

Last synced: 3 days ago
JSON representation

Show notifications. Part of 'mini.nvim' library.

• Host: GitHub
• URL: https://github.com/echasnovski/mini.notify
• Owner: echasnovski
• License: mit
• Created: 2024-01-01T10:52:27.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-08-27T13:56:23.000Z (3 months ago)
• Last Synced: 2024-08-27T15:25:10.851Z (3 months ago)
• Topics: lua, mini-nvim, neovim, neovim-plugin
• Language: Lua
• Homepage:
• Size: 35.2 KB
• Stars: 13
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![GitHub license](https://badgen.net/github/license/echasnovski/mini.nvim)](https://github.com/echasnovski/mini.nvim/blob/main/LICENSE)

### Show notifications

See more details in [Features](#features) and [help file](doc/mini-notify.txt).

---

⦿ This is a part of [mini.nvim](https://github.com/echasnovski/mini.nvim) library. Please use [this link](https://github.com/echasnovski/mini.nvim/blob/main/readmes/mini-notify.md) if you want to mention this module.

⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.

⦿ See the repository page to learn about common design principles and configuration recipes.

---

If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://github.com/echasnovski/mini.nvim/blob/main/CONTRIBUTING.md) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.

## Demo

https://github.com/echasnovski/mini.nvim/assets/24854248/81014300-3380-4b8c-9ab5-ba09345032d7

## Features

- Show one or more highlighted notifications in a single floating window.

- Manage notifications (add, update, remove, clear).

- `vim.notify()` wrapper generator (see `MiniNotify.make_notify()`).

- Automated show of LSP progress report.

- Track history which can be accessed with `MiniNotify.get_all()` and shown with `MiniNotify.show_history()`.

## Installation

This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.

There are two branches to install from:

- `main` (default, **recommended**) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).

- `stable` will be updated only upon releases with code tested during public beta-testing phase in `main` branch.

Here are code snippets for some common installation methods (use only one):

With mini.deps

    

        

            Github repo Branch Code snippet

        

    

    

        

            'mini.nvim' library Main Follow recommended 'mini.deps' installation

        

        

            Stable

        

        

            Standalone plugin Main add('echasnovski/mini.notify')

        

        

            Stable add({ source = 'echasnovski/mini.notify', checkout = 'stable' })

        

    

With folke/lazy.nvim

    

        

            Github repo Branch Code snippet

        

    

    

        

            'mini.nvim' library Main { 'echasnovski/mini.nvim', version = false },

        

        

            Stable { 'echasnovski/mini.nvim', version = '*' },

        

        

            Standalone plugin Main { 'echasnovski/mini.notify', version = false },

        

        

            Stable { 'echasnovski/mini.notify', version = '*' },

        

    

With junegunn/vim-plug

    

        

            Github repo Branch Code snippet

        

    

    

        

            'mini.nvim' library Main Plug 'echasnovski/mini.nvim'

        

        

            Stable Plug 'echasnovski/mini.nvim', { 'branch': 'stable' }

        

        

            Standalone plugin Main Plug 'echasnovski/mini.notify'

        

        

            Stable Plug 'echasnovski/mini.notify', { 'branch': 'stable' }

        

    




**Important**: don't forget to call `require('mini.notify').setup()` to enable its functionality.

**Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file : Filename too long`). Try doing one of the following:

- Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall.

## Default config

```lua

-- No need to copy this inside `setup()`. Will be used automatically.

{

  -- Content management

  content = {

    -- Function which formats the notification message

    -- By default prepends message with notification time

    format = nil,

    -- Function which orders notification array from most to least important

    -- By default orders first by level and then by update timestamp

    sort = nil,

  },

  -- Notifications about LSP progress

  lsp_progress = {

    -- Whether to enable showing

    enable = true,

    -- Duration (in ms) of how long last message should be shown

    duration_last = 1000,

  },

  -- Window options

  window = {

    -- Floating window config

    config = {},

    -- Maximum window width as share (between 0 and 1) of available columns

    max_width_share = 0.382,

    -- Value of 'winblend' option

    winblend = 25,

  },

}

```

## Similar plugins

- [j-hui/fidget.nvim](https://github.com/j-hui/fidget.nvim)

- [rcarriga/nvim-notify](https://github.com/rcarriga/nvim-notify)