README.md

slimline.nvim

Another Neovim statusline written in Lua.

The goal is to provide a visual pleasing and efficient statusline. It started with writing my own statusline. Reason for writing was to learn more about the Neovim ecosystem and having exactly what I want, function and aesthetic wise.

In the meantime it is a quite generic and configurable alternative to other popular statuslines.

Impressions

Here are some screenshots that might be a bit outdated. See recipes for config examples.

Components

Which components to show in which section (left, right, center) can be configured. The components entries accept function calls and strings so that you can create custom comonents. See Custom components for an introduction.

Components have a flow direction which means that components on the left have their primary part on the left side and components on the right have their primary part on their right side.

Contributing

Feel free to create an issue/PR if you want to see anything else implemented.

Installation

lazy.nvim

{
    -- Calls `require('slimline').setup({})`
    "sschleemilch/slimline.nvim",
    opts = {}
},

mini.deps

MiniDeps.now(function()
    MiniDeps.add('sschleemilch/slimline.nvim')
    require('slimline').setup({})
end)

Neovim's 0.12+ built in plugin manager vim.pack

vim.pack.add({
  "https://github.com/sschleemilch/slimline.nvim",
})
require("slimline").setup({})

Optional dependencies:

• gitsigns, mini.git (branch only), mini.diff (diff only), vim-gitgutter (diff-only) or vim-fugitive (branch only) if you want the git component. Otherwise, it will not be rendered
• mini.icons or nvim-web-devicons if you want filetype icons

You'll also need to have a patched nerd font for icons and separators.

If you decide to not use a global one then you can configure via components_inactive what will be rendered in the inactive one. By default, all components will be shown. Inactive components will use the secondary highlighting for primary parts.

shows an example using default options.

Configuration

{
  bold = false, -- makes primary parts bold

  -- Global style. Can be overwritten using `configs.<component>.style`
  style = 'bg', -- or "fg"

  -- Component placement
  components = {
    left = {
      'mode',
      'path',
      'git',
    },
    center = {},
    right = {
      'diagnostics',
      'filetype_lsp',
      'progress',
    },
  },

  -- Inactive components
  -- Uses all `components` by default.
  -- E.g. for only showing `path`:
  -- components_inactive = {
  --   left = { 'path' },
  --   right = {},
  -- },
  components_inactive = {},

  -- Component configuration
  -- `<component>.style` can be used to overwrite the global 'style'
  -- `<component>.sep` can be used to overwrite the global 'sep.left' and `sep.right`
  -- `<component>.hl = { primary = ..., secondary = ...}` can be used to overwrite global ones
  -- `<component>.follow` can point to another component name to follow its style (e.g. 'progress' following 'mode' by default). Follow can be disabled by setting it to `false`
  -- `<component>.trunc_width` can be used to hide a component completely once the window width drops below that value
  configs = {
    mode = {
      verbose = false, -- Selects the `verbose` format
      hl = {
        normal = 'Type',
        visual = 'Keyword',
        insert = 'Function',
        replace = 'Statement',
        command = 'String',
        other = 'Function',
      },
      format = {
        ['n'] = { verbose = 'NORMAL', short = 'N' },
        ['v'] = { verbose = 'VISUAL', short = 'V' },
        ['V'] = { verbose = 'V-LINE', short = 'V-L' },
        ['\22'] = { verbose = 'V-BLOCK', short = 'V-B' },
        ['s'] = { verbose = 'SELECT', short = 'S' },
        ['S'] = { verbose = 'S-LINE', short = 'S-L' },
        ['\19'] = { verbose = 'S-BLOCK', short = 'S-B' },
        ['i'] = { verbose = 'INSERT', short = 'I' },
        ['R'] = { verbose = 'REPLACE', short = 'R' },
        ['c'] = { verbose = 'COMMAND', short = 'C' },
        ['r'] = { verbose = 'PROMPT', short = 'P' },
        ['!'] = { verbose = 'SHELL', short = 'S' },
        ['t'] = { verbose = 'TERMINAL', short = 'T' },
        ['U'] = { verbose = 'UNKNOWN', short = 'U' },
      },
    },
    path = {
      trunc_width = 60,
      directory = true, -- Whether to show the directory
      -- truncates the directory path. Can be disabled by setting `truncate = false`
      truncate = {
        chars = 1, -- number of characters for each path component
        full_dirs = 2, -- how many path components to keep unshortened
      },
      icons = {
        folder = ' ',
        modified = '',
        read_only = '',
      },
    },
    git = {
      trunc_width = 120,
      icons = {
        branch = '',
        added = '+',
        modified = '~',
        removed = '-',
      },
    },
    diagnostics = {
      trunc_width = 75,
      workspace = false, -- Whether diagnostics should show workspace diagnostics instead of current buffer
      icons = {
        ERROR = ' ',
        WARN = ' ',
        HINT = ' ',
        INFO = ' ',
      },
      severity = {
        -- vim.diagnostic.SeverityFilter options
        min = vim.diagnostic.severity.HINT,
      },
      hl = {
        error = 'DiagnosticError',
        warn = 'DiagnosticWarn',
        hint = 'DiagnosticHint',
        info = 'DiagnosticInfo',
      },
    },
    filetype_lsp = {
      trunc_width = 95,
      -- Map lsp client names to custom names or ignore them by setting to `false`
      -- E.g. { ['tsserver'] = 'TS', ['pyright'] = 'Python', ['GitHub Copilot'] = false }
      map_lsps = {},
      lsp_sep = ',', -- separator between attached LSPs
    },
    selectioncount = {
      hl = {
        primary = 'Special',
      },
      icon = '󰈈 ',
    },
    searchcount = {
      hl = {
        primary = 'Special',
      },
      icon = ' ',
      -- Options to be passed to vim.fn.searchcount, see :h searchcount
      options = {
        recompute = true,
      },
    },
    progress = {
      follow = 'mode',
      column = false, -- Enables a secondary section with the cursor column
      icon = ' ',
    },
    recording = {
      icon = ' ',
      hl = {
        primary = 'Special',
      },
    },
  },

  -- Spacing configuration
  spaces = {
    components = ' ', -- string between components
    left = ' ', -- string at the start of the line
    right = ' ', -- string at the end of the line
    padding = ' ', -- component inner padding. Only relevant for style 'bg'
  },

  -- Seperator configuartion
  sep = {
    hide = {
      first = false, -- hides the first separator of the line
      last = false, -- hides the last separator of the line
    },
    left = '', -- left separator of components
    right = '', -- right separator of components
  },

  -- Global highlights
  hl = {
    base = 'Normal', -- highlight of the background
    base_inactive = 'Normal', -- highlight of the background when inactive
    primary = 'Normal', -- highlight of primary parts (e.g. filename)
    secondary = 'Comment', -- highlight of secondary parts (e.g. filepath)
  },

  -- Hide statusline on filetypes
  disabled_filetypes = {},
}

Highlights

Slimline creates highlight groups with the base highlights chosen in the hl section of the config. The default ones should be a safe choice to work well with most colorschemes but of course you can adapt them to your liking. Depending on the chosen style (fg or bg) the color will be used as a foreground or as a background color.

Instead of specifying the base highlight group in the config you can also tweak target highlight groups directly. Make sure to do that before slimline's setup().

Recipes

Pure

{
  style = 'fg',
  bold = true,
  configs = {
    path = {
      hl = {
        primary = 'Label',
      },
    },
    git = {
      hl = {
        primary = 'Function',
      },
    },
    filetype_lsp = {
      hl = {
        primary = 'String',
      },
    },
  },
}

Rainbow

{
  configs = {
    path = {
      hl = {
        primary = 'Define',
      },
    },
    git = {
      hl = {
        primary = 'Function',
      },
    },
    filetype_lsp = {
      hl = {
        primary = 'String',
      },
    },
  },
}

Minimal

{
    style = "fg",
    spaces = {
        components = '',
        left = '',
        right = ''
    }
}

Slashed

{
    spaces = {
        components = "",
        left = "",
        right = "",
    },
    sep = {
        hide = {
            first = true,
            last = true,
        },
        left = "",
        right = "",
    },
}

Bubble chain

{
    spaces = {
        components = "─",
        left = "─",
        right = "─",
    },
},

And adding fill chars stl Neovim option:

vim.opt.fillchars = {
	stl = "─",
}

3 letter non-shifting mode

{
    configs = {
        mode = {
            format = {
                ['n'] = { short = 'NOR' },
                ['v'] = { short = 'VIS' },
                ['V'] = { short = 'V-L' },
                ['\22'] = { short = 'V-B' },
                ['s'] = { short = 'SEL' },
                ['S'] = { short = 'S-L' },
                ['\19'] = { short = 'S-B' },
                ['i'] = { short = 'INS' },
                ['R'] = { short = 'REP' },
                ['c'] = { short = 'CMD' },
                ['r'] = { short = 'PRO' },
                ['!'] = { short = 'SHE' },
                ['t'] = { short = 'TER' },
                ['U'] = { short = 'UNK' },
            },
        },
    }
}

Stealth

Uses the default StatusLine and StatusLineNC base highlights that mimics the default statusline. Also sets the primary and secondary to those highlight groups which makes it very subtle. Removes unneeded spaces for most efficient space.

{
    style = 'fg',
    hl = {
        primary = 'StatusLine',
        secondary = 'StatusLineNC',
        base = 'StatusLine',
        base_inactive = 'StatusLineNC',
    },
    configs = {
        progress = {
            follow = false,
        },
    }
    spaces = {
        components = '',
        left = '',
        right = ''
    }
}

Custom components

The components part of the config accepts function calls. This opens the door extending Slimline with your own content.

Let's create a center component using a function like this directly in the config:

opts = {
    components = {
        center = {
            function ()
                return "Hello World"
            end
        },
    }
}

It will render to something like this (depending on your colorscheme):

If you want to use internal render functionality of a component (here of the path component) you can do it like that:

function(active)
    return Slimline.highlights.hl_component(
        { primary = 'Hello', secondary = 'World' },
        Slimline.highlights.hls.components['path'],
        Slimline.get_sep('path'),
        'right', -- flow direction (on which side the secondary part will be rendered)
        active, -- whether the component is active or not
        'fg' -- style to use
    )
end,

It will now render to that (depending on the config)

Of course you can use Slimline* highlight groups on your own to create your own styled component

The following lua table is required to be passed if you want to use hl_component():

hl = {
    primary = {
        text = '',
        sep = '',
        sep2sec = '',
    },
    secondary = {
        text = '',
        sep = '',
    }
}

Similar plugins

• nvim-lualine/lualine.nvim
• echasnovski/mini.statusline