Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/javiorfo/nvim-popcorn
Neovim library for popup utilities written in Lua
https://github.com/javiorfo/nvim-popcorn
lua neovim neovim-plugin popup
Last synced: about 1 month ago
JSON representation
Neovim library for popup utilities written in Lua
- Host: GitHub
- URL: https://github.com/javiorfo/nvim-popcorn
- Owner: javiorfo
- License: other
- Created: 2023-04-01T20:39:32.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-14T02:23:35.000Z (5 months ago)
- Last Synced: 2024-08-14T03:59:35.093Z (5 months ago)
- Topics: lua, neovim, neovim-plugin, popup
- Language: Lua
- Homepage:
- Size: 82 KB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nvim-popcorn
Neovim library for popup utilities written in Lua
## Caveats
- This library has been developed on and for Linux following open source philosophy.
## Installation
`Packer`
```lua
use 'javiorfo/nvim-popcorn'
```
`Lazy`
```lua
{ 'javiorfo/nvim-popcorn' }
```
## Overview
| Feature | nvim-popcorn | NOTE |
| ------- | ------------- | ---- |
| Popup borders | :heavy_check_mark: | Includes 5 different borders (also opened to implementation) |
| Set width and height | :heavy_check_mark: | |
| Set title | :heavy_check_mark: | Optional. Centered with highlighting options |
| Set footer | :heavy_check_mark: | Optional. Centered with highlighting options |
| Title or footer with right or left align | :x: | |
| Backgroung color | :x: | Same of editor |
| Content in text format | :heavy_check_mark: | By table. With highlighting options |
| Content file | :heavy_check_mark: | By string |
| Content open to implementation | :heavy_check_mark: | By function |
| Callback | :heavy_check_mark: | Optional. By function |
| Close popup | :heavy_check_mark: | Pressing or Clicking outside of it |
## Usage
- This is an object description. Notice that some values are required and others are optional:
```lua
local popcorn = require'popcorn'
local borders = require'popcorn.borders'
local opts = {
-- Required
width = 50,
-- Required
height = 8,
-- Optional. If not set then simple_thick_border will be the default
border = borders.rounded_corners_border,
-- Optional. The first table value is the title text, the second one is the group to link
-- The second value is optional too. In this case It will highlight "Popcorn Title" linking to "Type" group
title = { "Popcorn Title", "Type" },
-- Optional. The first table value is the footer text, the second one is the group to link
-- The second value is optional too. In this case It will highlight "Popcorn Footer" linking to "String" group
footer = { "Popcorn Footer", "String" },
-- Optional. This will be the body of the popup
-- content is a table
content = {
{ "Results: ", "Constant" }, -- The second value is the group to link to
{ " - Some text here" },
{ " - More text here" }
},
-- Optional. A second approach could be to open a file and show the content in the popup body
-- content is a string
-- content = "path/to/file/to/show/file.txt"
-- Optional. A third approach could be to implement some code in a function
-- content is a function
-- In this example a terminal is opened in the popup body
-- content = function() vim.cmd("start | term") end
-- Optional. If a callback is necessary this is the keymap to execute it
-- Default value is if this variable is not set
callback_keymap = "",
-- Optional. If a callback is necessary this is the implementation
-- Pressing (variable above) will execute the callback
-- In this example It will print the first line of the popup body
callback = function()
print("Callback result => " .. vim.fn.getline(1))
end,
-- Optional
-- Add some actions after all the popup configuration is set
-- I could be autocmd's for example
do_after = function()
-- do something after...
end
}
-- Open popup
popcorn:new(opts):pop() -- pop() returns popup buffer id
```
#### BORDERS
- Check the borders available in [this file](https://github.com/javiorfo/nvim-popcorn/blob/master/lua/popcorn/borders.lua)
- You can add your own border if you like. Further information in `:help popcorn`
## Screenshots
#### Examples of the differents popup's included in this library. Run `:luafile %` in [these files](https://github.com/javiorfo/nvim-popcorn/blob/master/examples)
**NOTE:** The colorscheme **umbra** from [nvim-nyctophilia](https://github.com/javiorfo/nvim-nyctophilia) is used in this image.
---
### Donate
- **Bitcoin** [(QR)](https://raw.githubusercontent.com/javiorfo/img/master/crypto/bitcoin.png) `1GqdJ63RDPE4eJKujHi166FAyigvHu5R7v`
- [Paypal](https://www.paypal.com/donate/?hosted_button_id=FA7SGLSCT2H8G)