💥 Highly experimental plugin that completely replaces the UI for messages, cmdline and the popupmenu.

💥 Noice (Nice, Noise, Notice)

Highly experimental plugin that completely replaces the UI for messages, cmdline and the popupmenu.

✨ Features

• 🌅 fully configurable views like nvim-notify, splits, popups, virtual text, ..
• 🔍 use filters to route messages to different views
• 🌈 message highlights are preserved in the views (like the colors of :hi)
• 📝 command output like :messages is shown in normal buffers, which makes it much easier to work with
• 📚 :Noice command to show a full message history
• ⌨️ no more :h more-prompt
• 💻 fully customizable cmdline with icons
• 💅 syntax highlighting for vim and lua on the cmdline
• 🚥 statusline components

✅ Status

WIP

⚡️ Requirements

• Neovim >= 0.8.0
• nui.nvim: used for proper rendering and multiple views
• nvim-notify: notification view

📦 Installation

Install the plugin with your preferred package manager:

-- Packer
use({
  "folke/noice.nvim",
  event = "VimEnter",
  config = function()
    require("noice").setup()
  end,
  requires = {
    -- if you lazy-load any plugin below, make sure to add proper `module="..."` entries
    "MunifTanjim/nui.nvim",
    "rcarriga/nvim-notify",
    }
})

⚙️ Configuration

noice.nvim comes with the following defaults:

Check the wiki for configuration recipes.

{
  cmdline = {
    view = "cmdline_popup", -- view for rendering the cmdline. Change to `cmdline` to get a classic cmdline at the bottom
    opts = { buf_options = { filetype = "vim" } }, -- enable syntax highlighting in the cmdline
    icons = {
      ["/"] = { icon = " ", hl_group = "DiagnosticWarn" },
      ["?"] = { icon = " ", hl_group = "DiagnosticWarn" },
      [":"] = { icon = " ", hl_group = "DiagnosticInfo", firstc = false },
    },
  },
  popupmenu = {
    enabled = true, -- disable if you use something like cmp-cmdline
    ---@type 'nui'|'cmp'
    backend = "nui", -- backend to use to show regular cmdline completions
    -- You can specify options for nui under `config.views.popupmenu`
  },
  history = {
    -- options for the message history that you get with `:Noice`
    view = "split",
    opts = { enter = true },
    filter = { event = "msg_show", ["not"] = { kind = { "search_count", "echo" } } },
  },
  throttle = 1000 / 30, -- how frequently does Noice need to check for ui updates? This has no effect when in blocking mode.
  ---@type table<string, NoiceViewOptions>
  views = {}, -- @see the section on views below
  ---@type NoiceRouteConfig[]
  routes = {}, -- @see the section on routes below
  ---@type table<string, NoiceFilter>
  status = {}, --@see the section on statusline components below
}

🔍 Filters

Noice uses filters to route messages to specific views.

-- all messages over 10 lines, excluding echo and search_count
local filter = {
  event = "msg_show",
  min_height = 10,
  ["not"] = { kind = { "search_count", "echo" } },
}

🌅 Views

Noice comes with the following built-in backends:

• popup: powered by nui.nvim
• split: powered by nui.nvim
• notify: powered by nvim-notify
• virtualtext: shows the message as virtualtext (for example for search_count)

A View (config.views) is a combination of a backend and options. Noice comes with the following built-in views with sane defaults:

Please refer to noice.config.views to see the options. Any options passed to existing views in config.views, will override those options only. You can configure completely new views and use them in custom routes.

-- override the default split view to always enter the split when it opens
require("noice").setup({
    views = {
        split = {
            enter = true
          }
      }
  })

Nui Options

See the Nui documentation for Popup and Split.

{
  win_options = {
    winhighlight = {
      Normal = "NormalFloat",
      FloatBorder = "FloatBorder"
    },
  }
}

Notify Options

Virtual Text Options

Right now there's only an option to set the hl_group used to render the virtual text.

🚗 Routes

A route has a filter, view and optional opts attribute.

• view: one of the views (built-in or custom)
• filter a filter for messages matching this route
• opts: options for the view and the route

Route options can be any of the view options above, or one of:

Please refer to noice.config.routes for an overview of the default routes. Routes passed to setup() will be prepended to the default routes.

-- skip search_count messages instead of showing them as virtual text
require("noice").setup({
  routes = {
    {
      filter = { event = "msg_show", kind = "search_count" },
      opts = { skip = true },
    },
  },
})

-- always route any messages with more than 20 lines to the split view
require("noice").setup({
  routes = {
    {
      view = "split",
      filter = { event = "msg_show", min_height = 20 },
    },
  },
})

🚥 Statusline Components

Noice comes with the following statusline components:

• ruler
• message: last line of the last message (event=show_msg)
• command: showcmd
• mode: showmode (@recording messages)
• search: search count messages

See noice.config.status for the default config.

You can add custom statusline components in setup under the status key.

Statusline components have the following methods:

• get: gets the content of the message without highlights
• get_hl: gets the content of the message with highlights
• has: checks if the component is available

require("lualine").setup({
  sections = {
    lualine_x = {
      {
        require("noice.status").message.get_hl,
        cond = require("noice.status").message.has,
      },
      {
        require("noice.status").command.get,
        cond = require("noice.status").command.has,
        color = { fg = "#ff9e64" },
      },
      {
        require("noice.status").mode.get,
        cond = require("noice.status").mode.has,
        color = { fg = "#ff9e64" },
      },
      {
        require("noice.status").search.get,
        cond = require("noice.status").search.has,
        color = { fg = "#ff9e64" },
      },
    },
  },
})

🚀 Usage

• :Noice shows the message history
• :Noice disable disables Noice
• :Noice enable enables Noice
• :Noice stats shows debugging stats

🔥 Known Issues

Noice is using the new experimental vim.ui_attach API, so issues are to be expected. During setup, we apply a bunch of Hacks to work around some of the current issues. For more details, see this tracking issue