Skip to content

README.md

Latest commit

 

History

History
334 lines (283 loc) · 8.98 KB

README.md

File metadata and controls

334 lines (283 loc) · 8.98 KB

WinBar

Preview

- Configurable and minimal Neovim WinBar -

Components

  • Filename (icon support)
  • LSP Clients
  • LSP Diagnostics
  • LSP Loading progress (wip)
  • Git Branch
  • Git Diff

Status

  • Readonly status
  • Modified status

Extensions

Extensions add optional functionality to the winbar.

They are disabled by default and can be enabled individually.

Each extension:

  • is configured under the extensions table
  • must be added to the layout table to be displayed

Enabling an extension

layout = {
  'modes',
  'filename',
  ...
}

extensions = {
  modes = {
    enabled = true,
  },
}

Available extensions

Vim mode (modes)
  • Displays the current Vim mode in the winbar.
extensions = {
  modes = {
    enabled = true,
    format = function(mode)
      return mode
    end,
  },
}

-- Highlight groups
highlights = {
  WinBarModeNormal        = {  link = 'Conceal'    },
  WinBarModeInsert        = {  link = 'String'     },
  WinBarModeVisual        = {  link = 'Title'      },
  WinBarModeReplace       = {  link = 'Error'      },
  WinBarModeCommand       = {  link = 'Identifier' },
  WinBarModeTerminal      = {  link = 'Special'    },
  WinBarModeSelect        = {  link = 'Statement'  },
  WinBarModeMore          = {  link = 'WarningMsg' },
  WinBarModeConfirm       = {  link = 'WarningMsg' },
  WinBarModeShell         = {  link = 'Special'    },
}

Installation

Install with your preferred plug-in manager.

With nvim-mini/mini.deps 
require('mini.deps').later(function()
  require('mini.deps').add({
    source = 'mateconpizza/winbar.nvim',
    depends = {
      -- optional: add file icons to the winbar
      'nvim-mini/mini.icons',       -- or 'nvim-tree/nvim-web-devicons'

      -- optional: show git diff stats in the winbar
      'nvim-mini/mini.diff',        -- or 'lewis6991/gitsigns.nvim'
    },
  })

  require('winbar').setup()
end)
With folke/lazy.nvim 
{
  'mateconpizza/winbar.nvim',
  event = { 'BufReadPre', 'BufNewFile' },
  dependencies = {
    -- optional: add file icons to the winbar
    'nvim-tree/nvim-web-devicons',  -- or use 'nvim-mini/mini.icons'

    -- optional: show git diff stats in the winbar
    'lewis6991/gitsigns.nvim',      -- or use 'nvim-mini/mini.diff'
  },
  ---@module 'winbar'
  ---@type winbar.config
  opts = {},
}

Note

You must call require('winbar').setup() to activate the plugin.

This plug-in adds a user command WinBarToggle for toggling the WinBar.

Default configuration 
-- There's no need to include this in setup(). It will be used automatically.
require('winbar').setup({
  -- Core behavior
  enabled = true, -- Enable the WinBar plugin
  update_interval = 1000, -- How much to wait in milliseconds before update (git diff, diagnostics)
  filename = {
    enabled = true,
    icon = true, -- Show file icon (e.g., via nvim-web-devicons)
    format = function(filename) -- Custom formatter for the filename.
      return filename
    end,
    min_width = 20,
    max_segments = 3, -- Show the last n folders/segments when two files share the same name.
  },
  show_single_buffer = true, -- Show WinBar even with a single visible buffer
  -- Icons used across components
  icons = {
    modified = '[+]', -- Shown for unsaved buffers (choice: ●)
    readonly = '[RO]', -- Shown for readonly buffers (choice: )
  },
  -- LSP components
  lsp = {
    -- LSP client name display
    clients = {
      enabled = true, -- Enable LSP client display
      separator = ',', -- Separator for multiple clients
      format = function(clients) -- Formatter for LSP client names
        return clients
      end,
      min_width = 50,
    },
    -- Diagnostics configuration
    diagnostics = {
      enabled = true, -- Show diagnostics
      style = 'standard', -- Display style (`standard` or `mini`)
      icons = { -- Diagnostic severity icons
        error = 'e:',
        hint = 'h:',
        info = 'i:',
        warn = 'w:',
      },
      min_width = 55,
    },
    -- LSP loading progress display
    progress = {
      enabled = true,
      spinner = { '⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏' },
      spinner_interval = 120,
      min_width = 50,
    },
  },
  -- Git components
  git = {
    branch = {
      enabled = true,
      icon = '', -- Git branch icon (choice: )
      min_width = 45,
    },
    diff = {
      enabled = true,
      added = '+',
      changed = '~',
      removed = '-',
      min_width = 50,
    },
  },
  -- Optional components
  extensions = {},
  -- Layout of the WinBar
  layout = {
    left = { 'git_branch', 'git_diff' }, -- Components aligned to the left
    center = {}, -- Components at the center
    right = { -- Components aligned to the right
      'lsp_progress',
      'lsp_status',
      'lsp_diagnostics',
      'modified',
      'readonly',
      'file_icon',
      'filename',
    },
  },
  -- Highlight groups
  highlights = {
    WinBarModified              = { link = 'WarningMsg' },
    WinBarReadonly              = { link = 'ErrorMsg' },
    WinBarGitBranch             = { link = 'Comment' },
    WinBarGitDiffAdded          = { link = 'Comment' },
    WinBarGitDiffChanged        = { link = 'Comment' },
    WinBarGitDiffRemoved        = { link = 'Comment' },
    WinBarLspStatus             = { link = 'Comment' },
    WinBarDiagnosticError       = { link = 'DiagnosticError' },
    WinBarDiagnosticWarn        = { link = 'DiagnosticWarn' },
    WinBarDiagnosticInfo        = { link = 'DiagnosticInfo' },
    WinBarDiagnosticHint        = { link = 'DiagnosticHint' },
    WinBarLspProgress           = { link = 'Comment' },
    WinBarLspProgressSpinner    = { link = 'WarningMsg' },
    WinBarLspProgressDone       = { link = 'Constant' },
  },
  exclusions = {
    filetypes = {
      -- Filetypes where WinBar will not be shown
      'aerial',
      'checkhealth',
      'dap-float',
      'fugitive',
      'gitcommit',
      'gitrebase',
      'help',
      'lazy',
      'lspinfo',
      'man',
      'oil',
      'qf',
      'trouble',
    },
    -- Buffer types where WinBar will not be shown
    buftypes = {
      'help',
      'netrw',
      'nofile',
      'nowrite',
      'popup',
      'prompt',
      'quickfix',
      'scratch',
      'terminal',
    },
  },
})
Highlight groups

Highlight groups

Built-in components

Group Default Description
WinBarReadonly ErrorMsg File read-only indicator highlight
WinBarModified WarningMsg File modified buffer indicator highlight
WinBarGitBranch Comment Git branch highlight
WinBarGitDiffAdded Comment Git diff added lines highlight
WinBarGitDiffChanged Comment Git diff changed lines highlight
WinBarGitDiffRemoved Comment Git diff removed lines highlight
WinBarLspStatus Comment LSP client highlight
WinBarDiagnosticError DiagnosticError LSP Diagnostic error highlight
WinBarDiagnosticWarn DiagnosticWarn LSP Diagnostic warning highlight
WinBarDiagnosticInfo DiagnosticInfo LSP Diagnostic info highlight
WinBarDiagnosticHint DiagnosticHint LSP Diagnostic hint highlight
WinBarLspProgress Comment LSP Progress loading
WinBarLspProgressSpinner WarningMsg LSP Progress loading spinner
WinBarLspProgressDone Constant LSP Progress loading done message
Visible elements
Todo
  • LSP progress:
    • Move to extensions
    • Add mini opt to component
      • Maybe add format fn func(progress, message, percentage, spinner)
      • Show only percentage and spinner
  • LSP Clients:
    • Rename lsp_status -> lsp_clients
  • WinBar:
    • track active/inactive window and link to WinBarNC
⚡