Skip to content

A Neovim plugin to manage and quickly switch between frequently used files, designed for streamlined developer workflows. Similar to Harpoon, with minimal setup and full customization.

Notifications You must be signed in to change notification settings

jackMort/tide.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Tide.nvim

GitHub Workflow Status Lua

Tide.nvim is a Neovim plugin designed to streamline your workflow by helping you manage and quickly switch between frequently used files. It's similar to tools like Harpoon, Arrow, and Snipe, allowing you to focus more on coding and less on file navigation.

The UI design of Tide.nvim is inspired by/based on menu.nvim, providing a simple and intuitive file management interface. Kudos to author for the inspiration!

Preview

Features

  • Quick file management and switching.
  • Simple setup with optional customization.
  • Integration with nui.nvim for enhanced UI elements and nvim-web-devicons for file icons.

Installation

Using lazy.nvim

{
  "jackMort/tide.nvim",
  opts = {
      -- optional configuration
  },
  dependencies = {
    "MunifTanjim/nui.nvim",
    "nvim-tree/nvim-web-devicons"
  }
}
{
  "jackMort/tide.nvim",
  config = function()
    require("tide").setup({
      -- optional configuration
    })
  end,
  requires = {
    "MunifTanjim/nui.nvim",
    "nvim-tree/nvim-web-devicons"
  }
}

Default Configuration

Here are the default settings for Tide.nvim, which you can adjust in the setup() function:

{
  keys = {
    leader = ";",           -- Leader key to prefix all Tide commands
    panel = ";",            -- Open the panel (uses leader key as prefix)
    add_item = "a",         -- Add a new item to the list (leader + 'a')
    delete = "d",           -- Remove an item from the list (leader + 'd')
    clear_all = "x",        -- Clear all items (leader + 'x')
    horizontal = "-",       -- Split window horizontally (leader + '-')
    vertical = "|",         -- Split window vertically (leader + '|')
  },
  animation_duration = 300,  -- Animation duration in milliseconds
  animation_fps = 30,        -- Frames per second for animations
  hints = {
    dictionary = "qwertzuiopsfghjklycvbnm",  -- Key hints for quick access
  },
}

Keybindings Explained

  • Leader key (;): This is the prefix for all Tide.nvim commands. When you press the leader key, it triggers Tide and allows you to run the subsequent commands.
    • ; ; → Opens the Tide panel.
    • ; a → Adds a new item to the list.
    • ; d → Deletes an item from the list.
    • ; x → Clears all items.
    • ; - → Opens a file in a horizontal split.
    • ; | → Opens a file in a vertical split.

Usage

Once installed and configured, Tide.nvim enables you to manage and switch between your most-used files quickly using the keybindings mentioned above. Since there is currently no official documentation, this README serves as a guide to get you started. You can adjust key mappings and other configurations through the setup() function based on your workflow needs. For more detailed usage examples and potential updates, check the Tide.nvim repository.

"Buy Me A Coffee"

About

A Neovim plugin to manage and quickly switch between frequently used files, designed for streamlined developer workflows. Similar to Harpoon, with minimal setup and full customization.

Topics

Resources

Stars

Watchers

Forks

Sponsor this project

Contributors 3

  •  
  •  
  •  

Languages