Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/b0o/incline.nvim
🎈 Floating statuslines for Neovim, winbar alternative
https://github.com/b0o/incline.nvim
neovim neovim-plugin neovim-statusline neovim-ui neovim-winbar nvim nvim-plugin vim winbar
Last synced: 25 days ago
JSON representation
🎈 Floating statuslines for Neovim, winbar alternative
- Host: GitHub
- URL: https://github.com/b0o/incline.nvim
- Owner: b0o
- License: mit
- Created: 2022-04-08T04:33:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-17T06:13:40.000Z (6 months ago)
- Last Synced: 2024-09-29T01:43:02.999Z (about 1 month ago)
- Topics: neovim, neovim-plugin, neovim-statusline, neovim-ui, neovim-winbar, nvim, nvim-plugin, vim, winbar
- Language: Lua
- Homepage:
- Size: 241 KB
- Stars: 784
- Watchers: 10
- Forks: 14
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - b0o/incline.nvim - Lightweight floating statuslines, intended for use with Neovim's new global statusline. (Bars and Lines / Statusline)
README
# 🎈 incline.nvim
[](https://mit-license.org) [](https://github.com/b0o/incline.nvim/actions/workflows/test.yaml)
Incline is a plugin for creating lightweight floating statuslines. It works great with Neovim's global statusline (`:set laststatus=3`).
Why use Incline instead of Neovim's built-in winbar? Incline:
- Only takes up the amount of space it needs, leaving more room for your code.
- Is highly configurable and themeable using Lua.
- Can be shown/hidden dynamically based on cursor position, focus, buffer type, or any other condition.
- Can be positioned at the top or bottom, left or right side of each window.
## Configuration
The render function is the most important part of an Incline configuration. As the name suggests, it's called for each window in order to render its statusline. You can think of it like a React component: it's passed a table of props and returns a tree-like data structure describing the content and appearance of the statusline. For example:
```lua
render = function(props)
local filename = vim.fn.fnamemodify(vim.api.nvim_buf_get_name(props.buf), ':t')
local modified = vim.bo[props.buf].modified
return {
' ',
filename,
modified and { ' *', guifg = '#888888', gui = 'bold' } or '',
' ',
guibg = '#111111',
guifg = '#eeeeee',
}
end
```
The returned value can be nil, a string, or a table which can include strings, highlight properties like foreground/background color, or even nested tables. Nested tables can contain the same sorts of things, including more nested tables. If the render function returns nil, the statusline will be hidden until the next time the render function returns a non-nil value. For more on the render function, see [`:help incline-render`](https://github.com/b0o/incline.nvim/blob/main/doc/incline.txt#L92).
Below are some examples to get you started.
### Icon + Filename
Requires [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons).
View Code
```lua
local helpers = require 'incline.helpers'
local devicons = require 'nvim-web-devicons'
require('incline').setup {
window = {
padding = 0,
margin = { horizontal = 0 },
},
render = function(props)
local filename = vim.fn.fnamemodify(vim.api.nvim_buf_get_name(props.buf), ':t')
if filename == '' then
filename = '[No Name]'
end
local ft_icon, ft_color = devicons.get_icon_color(filename)
local modified = vim.bo[props.buf].modified
return {
ft_icon and { ' ', ft_icon, ' ', guibg = ft_color, guifg = helpers.contrast_color(ft_color) } or '',
' ',
{ filename, gui = modified and 'bold,italic' or 'bold' },
' ',
guibg = '#44406e',
}
end,
}
```
### Icon + Filename + Navic
Requires [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons) and [nvim-navic](https://github.com/SmiteshP/nvim-navic).
View Code
```lua
local helpers = require 'incline.helpers'
local navic = require 'nvim-navic'
local devicons = require 'nvim-web-devicons'
require('incline').setup {
window = {
padding = 0,
margin = { horizontal = 0, vertical = 0 },
},
render = function(props)
local filename = vim.fn.fnamemodify(vim.api.nvim_buf_get_name(props.buf), ':t')
if filename == '' then
filename = '[No Name]'
end
local ft_icon, ft_color = devicons.get_icon_color(filename)
local modified = vim.bo[props.buf].modified
local res = {
ft_icon and { ' ', ft_icon, ' ', guibg = ft_color, guifg = helpers.contrast_color(ft_color) } or '',
' ',
{ filename, gui = modified and 'bold,italic' or 'bold' },
guibg = '#44406e',
}
if props.focused then
for _, item in ipairs(navic.get_data(props.buf) or {}) do
table.insert(res, {
{ ' > ', group = 'NavicSeparator' },
{ item.icon, group = 'NavicIcons' .. item.type },
{ item.name, group = 'NavicText' },
})
end
end
table.insert(res, ' ')
return res
end,
}
```
### Diagnostics + Git Diff + Icon + Filename
Requires [nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons) and [gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim).
Credit: [@lkhphuc](https://github.com/lkhphuc) ([Discussion](https://github.com/b0o/incline.nvim/discussions/32))
View Code
```lua
local devicons = require 'nvim-web-devicons'
require('incline').setup {
render = function(props)
local filename = vim.fn.fnamemodify(vim.api.nvim_buf_get_name(props.buf), ':t')
if filename == '' then
filename = '[No Name]'
end
local ft_icon, ft_color = devicons.get_icon_color(filename)
local function get_git_diff()
local icons = { removed = '', changed = '', added = '' }
local signs = vim.b[props.buf].gitsigns_status_dict
local labels = {}
if signs == nil then
return labels
end
for name, icon in pairs(icons) do
if tonumber(signs[name]) and signs[name] > 0 then
table.insert(labels, { icon .. signs[name] .. ' ', group = 'Diff' .. name })
end
end
if #labels > 0 then
table.insert(labels, { '┊ ' })
end
return labels
end
local function get_diagnostic_label()
local icons = { error = '', warn = '', info = '', hint = '' }
local label = {}
for severity, icon in pairs(icons) do
local n = #vim.diagnostic.get(props.buf, { severity = vim.diagnostic.severity[string.upper(severity)] })
if n > 0 then
table.insert(label, { icon .. n .. ' ', group = 'DiagnosticSign' .. severity })
end
end
if #label > 0 then
table.insert(label, { '┊ ' })
end
return label
end
return {
{ get_diagnostic_label() },
{ get_git_diff() },
{ (ft_icon or '') .. ' ', guifg = ft_color, guibg = 'none' },
{ filename .. ' ', gui = vim.bo[props.buf].modified and 'bold,italic' or 'bold' },
{ '┊ ' .. vim.api.nvim_win_get_number(props.win), group = 'DevIconWindows' },
}
end,
}
```
### More Examples
See more user-contributed configurations and share your own in the [Showcase](https://github.com/b0o/incline.nvim/discussions/categories/showcase).
## Installation
[Lazy.nvim](https://github.com/folke/lazy.nvim):
```lua
{
'b0o/incline.nvim',
config = function()
require('incline').setup()
end,
-- Optional: Lazy load Incline
event = 'VeryLazy',
},
```
[Packer](https://github.com/wbthomason/packer.nvim):
```lua
use "b0o/incline.nvim"
```
## Usage
```lua
require('incline').setup()
```
### Configuration
Incline's default configuration:
```lua
require('incline').setup {
debounce_threshold = {
falling = 50,
rising = 10
},
hide = {
cursorline = false,
focused_win = false,
only_win = false
},
highlight = {
groups = {
InclineNormal = {
default = true,
group = "NormalFloat"
},
InclineNormalNC = {
default = true,
group = "NormalFloat"
}
}
},
ignore = {
buftypes = "special",
filetypes = {},
floating_wins = true,
unlisted_buffers = true,
wintypes = "special"
},
render = "basic",
window = {
margin = {
horizontal = 1,
vertical = 1
},
options = {
signcolumn = "no",
wrap = false
},
overlap = {
borders = true,
statusline = false,
tabline = false,
winbar = false
},
padding = 1,
padding_char = " ",
placement = {
horizontal = "right",
vertical = "top"
},
width = "fit",
winhighlight = {
active = {
EndOfBuffer = "None",
Normal = "InclineNormal",
Search = "None"
},
inactive = {
EndOfBuffer = "None",
Normal = "InclineNormalNC",
Search = "None"
}
},
zindex = 50
}
}
```
See [`incline.txt`](https://github.com/b0o/incline.nvim/blob/main/doc/incline.txt) for full documentation of all configuration options.
## License
© 2022-2024 Maddison Hellstrom and contributors
Released under the MIT License.