lualine-harpoon.nvim

A tiny Lualine component for
ThePrimeagen/harpoon2.
Displays your current Harpoon mark as [x/y] in your statusline.

Requirements

Important

Make sure to install harpoon2, not harpoon on master branch.

Installation

Using lazy.nvim

{
  "nvim-lualine/lualine.nvim",
  dependencies = {
    "kristoferssolo/lualine-harpoon.nvim",
    dependencies = {
      { "ThePrimeagen/harpoon", branch = "harpoon2" }
      "nvim-lua/plenary.nvim",
    },
  },
}

Basic Usage

Once installed, simply add "harpoon" to your lualine.setup sections.
Lualine will auto-load lua/lualine/components/harpoon.lua for you:

require("lualine").setup({
  sections = {
    lualine_c = {
      "harpoon",
    },
  },
})

When you have Harpoon marks, you’ll see an indicator like [2/5] in your statusline.

Configuration

You can override plugin-wide defaults before calling lualine.setup:

-- default configs
require("lualine-harpoon").setup({
  symbol = {
    open = "[",
    close = "]",
    separator = "/",
    unknown = "?",
  },
  icon = "󰀱",
})

Per-component Overrides

You can also pass options directly in your Lualine sections:

require("lualine").setup({
  sections = {
    lualine_c = {
      {
        "harpoon",
        symbol = { open = "<", close = ">" },
      },
    },
  },
})

Acknowledgments and alternatives

This plugin was inspired by and serves as an alternative to letieu/harpoon-lualine.

License

This project is licensed under the MIT License - see the LICENSE file for details.

2.1 KiB Raw Blame History Unescape Escape