https://github.com/jellydn/spinner.nvim
spinner.nvim is a single file, no-dependency plugin for Neovim
https://github.com/jellydn/spinner.nvim
lua neovim neovim-plugin spinner
Last synced: 6 months ago
JSON representation
spinner.nvim is a single file, no-dependency plugin for Neovim
- Host: GitHub
- URL: https://github.com/jellydn/spinner.nvim
- Owner: jellydn
- License: mit
- Created: 2024-01-17T16:16:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-14T06:43:05.000Z (about 1 year ago)
- Last Synced: 2025-03-28T10:50:31.197Z (7 months ago)
- Topics: lua, neovim, neovim-plugin, spinner
- Language: Lua
- Homepage:
- Size: 7.81 KB
- Stars: 14
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Welcome to spinner.nvim 👋
spinner.nvim is a single file, no-dependency plugin for Neovim. It's easy to add to your Lua project for better organization.
## Installation
To install spinner.nvim, simply move the `spinner.lua` file from this repository to a subdirectory in your Lua project directory. Once transferred, you can adjust the configuration table at the beginning of the file to suit your needs.
## Usage
Here's a basic example of how to use spinner.nvim:
```lua
local spinner = require('YOUR_PROJECT.spinner')
-- Display the spinner at the top right of the screen
spinner.show()
-- Or customize the position
spinner.show({
relative = "editor",
width = 1,
height = 1,
col = vim.o.columns - 1,
row = vim.o.rows - 1,
})
-- Hide the spinner when it's done
spinner.hide()
```
## Configuration
You can customize the following values:
```lua
-- User configuration section
local config = {
-- Show a notification when done (set to false to disable)
show_notification = true,
-- Name of the plugin
plugin = "spinner.nvim",
-- Spinner frames
spinner_frames = {
"⠋",
"⠙",
"⠹",
"⠸",
"⠼",
"⠴",
"⠦",
"⠧",
"⠇",
"⠏",
},
}
```
## Demo
[](https://gyazo.com/7806f54956945800e0144edc4f0998da)
## Support
If you find spinner.nvim helpful, please consider giving it a star! ⭐️