Skip to content

Latest commit

 

History

History
428 lines (317 loc) · 8.86 KB

neovim_lua_examples.md

File metadata and controls

428 lines (317 loc) · 8.86 KB
Raw

Neovim Lua Examples

These examples use neovim-flavored Lua. Examples are also available in vimscript.

All examples belong in init.lua before vim-crystalline is loaded.

Creating a Basic Statusline

function vim.g.CrystallineStatuslineFn(winnr)
  local s = ""

  -- Add file name and modification status
  s = s .. " %f%h%w%m%r "

  -- Start the right side of the statusline
  s = s .. "%="

  -- Add file type and position info
  s = s .. "%{&ft} %l/%L %2v "

  return s
end

-- Always show the statusline
vim.o.laststatus = 2

See :help 'statusline' for more info.

Creating a Basic Tabline

function vim.g.CrystallineTablineFn()
  local cl = require("crystalline")
  return cl.DefaultTabline()
end

-- Always show the tabline
vim.o.showtabline = 2

See :help 'tabline' for more info.

Hiding Sections

function vim.g.CrystallineStatuslineFn(winnr)
  local s = ""

  s = s .. " %f%h%w%m%r "

  s = s .. "%="

  -- Only add this section in active windows
  if winnr == vim.fn.winnr() then
    s = s .. "%{&ft} "
  end
  -- Only add this section in wide enough windows
  if vim.fn.winwidth(winnr) >= 80 then
    s = s .. "%l/%L %2v "
  end

  return s
end

vim.o.laststatus = 2

Using Highlight Groups

function vim.g.CrystallineStatuslineFn(winnr)
  local cl = require("crystalline")
  local s = ""

  if winnr == vim.fn.winnr() then
    -- Start highlighting section A
    s = s .. cl.HiItem("A")
  else
    -- Start highlighting Fill section for inactive windows
    s = s .. cl.HiItem('InactiveFill')
  end

  s = s .. " %f%h%w%m%r "

  return s
end

vim.o.laststatus = 2
-- Default theme
vim.g.crystalline_theme = "default"

See :help crystalline-highlight-groups for the full list of groups.

See screenshots for the full list of themes.

Using Separators

function vim.g.CrystallineStatuslineFn(winnr)
  local cl = require("crystalline")
  local s = ""

  s = s .. cl.HiItem("A")

  s = s .. " %f%h%w%m%r "

  -- Add separator 0 between section A and the statusline fill section
  s = s .. cl.Sep(0, "A", "Fill")

  s = s .. "%="

  -- Add separator 1 between the fill section and section A
  s = s .. cl.Sep(1, "Fill", "A")

  s = s .. "%{&ft} %l/%L %2v "

  return s
end

function vim.g.CrystallineTablineFn()
  local cl = require("crystalline")
  -- Add separators to the tabline
  return cl.DefaultTabline({ enable_sep = true })
end

vim.o.laststatus = 2
vim.o.showtabline = 2
-- By default, these are powerline-style separators
vim.g.crystalline_separators = {
  { ch = ">", alt_ch = "|", dir = ">" },
  { ch = "<", alt_ch = "|", dir = "<" }
}

Using Mode Colors

Using mode colors manually:

function vim.g.CrystallineStatuslineFn(winnr)
  local cl = require("crystalline")
  local s = ""

  -- In different modes, this will be 'NormalModeA', 'InsertModeA', etc.
  s = s .. cl.ModeHiItem("A")

  s = s .. " %f%h%w%m%r "

  -- The mode prefix is added to all separator groups
  s = s .. cl.Sep(0, cl.ModeGroup("A"), cl.ModeGroup("Fill"))

  return s
end

function vim.g.CrystallineTablineFn()
  local cl = require("crystalline")
  -- auto_prefix_groups automatically uses mode colors
  return cl.DefaultTabline({ auto_prefix_groups = true })
end

vim.o.laststatus = 2
vim.o.showtabline = 2

Using mode colors automatically:

function vim.g.CrystallineStatuslineFn(winnr)
  local cl = require("crystalline")
  local s = ""

  -- In different modes, this will be 'NormalModeA', 'InsertModeA', etc.
  -- In inactive windows, this will be 'InactiveA'
  s = s .. cl.HiItem("A")

  s = s .. " %f%h%w%m%r "

  -- The prefix will automatically be added to separator groups
  s = s .. cl.Sep(0, "A", "Fill")

  return s
end

function vim.g.CrystallineTablineFn()
  local cl = require("crystalline")
  -- auto_prefix_groups will default to true
  -- 'Inactive*' groups will not be used in the tabline
  return cl.DefaultTabline()
end

vim.o.laststatus = 2
vim.o.showtabline = 2
-- This enables auto mode/inactive colors
-- All functions work with this option
vim.g.crystalline_auto_prefix_groups = true

Add a mode section:

function vim.g.CrystallineStatuslineFn(winnr)
  local cl = require("crystalline")
  local s = ""

  -- Automatically create a mode highlight group, mode label, and separator
  -- Same arguments as crystalline.sep()
  s = s .. cl.ModeSection(0, "A", "B")

  s = s .. " %f%h%w%m%r "

  s = s .. cl.Sep(0, "B", "Fill")

  return s
end

vim.o.laststatus = 2

Using Color Variants

Using color variants manually:

local function GroupSuffix()
  if vim.fn.mode() == 'i' and vim.o.paste then
    -- Add the suffix "2" to all groups
    return "2"
  end
  if vim.o.modified then
    -- Add the suffix "1" to all groups
    return "1"
  end
  -- Don"t add any suffix
  return ""
end

function vim.g.CrystallineStatuslineFn(winnr)
  local cl = require("crystalline")
  local s = ""

  -- Add the variant onto the end of the highlight item
  s = s .. cl.HiItem("Fill" .. GroupSuffix())

  s = s .. " %f%h%w%m%r "

  return s
end

function vim.g.CrystallineTablineFn()
  local cl = require("crystalline")
  -- Add the variant onto the end of all tabline groups
  return cl.DefaultTabline({ group_suffix = GroupSuffix() })
end

vim.o.laststatus = 2
vim.o.showtabline = 2
vim.g.crystalline_auto_prefix_groups = true

Using color variants automatically:

local function GroupSuffix()
  if vim.fn.mode() == 'i' and vim.o.paste then
    return "2"
  end
  if vim.o.modified then
    return "1"
  end
  return ""
end

function vim.g.CrystallineStatuslineFn(winnr)
  local cl = require("crystalline")
  local s = ""

  -- Automatically add the suffix onto the end of all groups
  -- Works with all functions
  vim.g.crystalline_group_suffix = GroupSuffix()

  s = s .. cl.HiItem("Fill")

  s = s .. " %f%h%w%m%r "

  return s
end

function vim.g.CrystallineTablineFn()
  local cl = require("crystalline")
  vim.g.crystalline_group_suffix = GroupSuffix()
  return cl.DefaultTabline()
end

vim.o.laststatus = 2
vim.o.showtabline = 2
vim.g.crystalline_auto_prefix_groups = true

There are 2 variants to use in built-in themes.

Showing More Statusline Information

function vim.g.CrystallineStatuslineFn(winnr)
  local s = ""

  s = s .. " %f%h%w%m%r "

  -- Add the current branch from vim-fugitive
  -- Plugins often provide functions for the statusline
  s = s .. "%{fugitive#Head()} "

  s = s .. "%="

  -- Show settings in the statusline
  s = s .. "%{&paste ? 'PASTE ' : ' '}"

  return s
end

vim.o.laststatus = 2

Showing More Tabline Information

function vim.g.CrystallineTablineFn()
  local cl = require("crystalline")
  local max_width = vim.o.columns

  -- Start the right side of the tabline
  local right = "%="

  -- Add a separator
  -- Reuse the TabType group for the right section
  right = right .. cl.Sep(1, "TabFill", "TabType")
  -- Subtract the width of the separator
  max_width = max_width - 1

  -- Add a label indicating if vim or neovim is being used
  local vimlabel = " NVIM "
  right = right .. vimlabel
  -- Use strchars() to get the real visible width
  max_width = max_width - vim.fn.strchars(vimlabel)

  -- Reduce the number of max tabs to fit new tabline items
  local max_tabs = 23

  return cl.DefaultTabline({ max_tabs = max_tabs, max_width = max_width }) .. right
end

vim.o.showtabline = 2

Full Example

local function GroupSuffix()
  if vim.fn.mode() == 'i' and vim.o.paste then
    return "2"
  end
  if vim.o.modified then
    return "1"
  end
  return ""
end

function vim.g.CrystallineStatuslineFn(winnr)
  local cl = require("crystalline")
  vim.g.crystalline_group_suffix = GroupSuffix()
  local curr = winnr == vim.fn.winnr()
  local s = ""

  if curr then
    s = s .. cl.ModeSection(0, "A", "B")
  else
    s = s .. cl.HiItem("Fill")
  end
  s = s .. " %f%h%w%m%r "
  if curr then
    s = s .. cl.Sep(0, "B", "Fill") .. " %{fugitive#Head()}"
  end

  s = s .. "%="
  if curr then
    s = s .. cl.Sep(1, "Fill", "B") .. "%{&paste ? ' PASTE ' : ' '}"
    s = s .. cl.Sep(1, "B", "A")
  end
  if vim.fn.winwidth(winnr) > 80 then
    s = s .. " %{&ft} %l/%L %2v "
  else
    s = s .. " "
  end

  return s
end

function vim.g.CrystallineTablineFn()
  local cl = require("crystalline")
  local max_width = vim.o.columns
  local right = "%="

  right = right .. cl.Sep(1, "TabFill", "TabType")
  max_width = max_width - 1

  local vimlabel = " NVIM "
  right = right .. vimlabel
  max_width = max_width - vim.fn.strchars(vimlabel)

  max_tabs = 23

  return cl.DefaultTabline({
    enable_sep = true,
    max_tabs = max_tabs,
    max_width = max_width
  }) .. right
end

vim.o.showtabline = 2
vim.o.laststatus = 2
vim.g.crystalline_auto_prefix_groups = 1