# popup.nvim

**Repository Path**: mirror_jedsek/popup.nvim

## Basic Information

- **Project Name**: popup.nvim
- **Description**: popup.nvim
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2022-04-05
- **Last Updated**: 2022-05-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# popup.nvim

[WIP] An implementation of the Popup API from vim in Neovim. Hope to upstream
when complete

## Installation

```vim
" This is a requirement, which implements some useful window management
"   items for neovim
Plug 'nvim-lua/plenary.nvim'

Plug 'nvim-lua/popup.nvim'
```

## Goals

Provide an API that is compatible with the vim `popup_*` APIs. After
stablization and any required features are merged into Neovim, we can upstream
this and wrap it with C functions to make the APIs compatible.

## Discussion:

- Should we support similar dictionaries in the neovim style.
    - Can you use "row" and "col", which are the neovim words for where you are going to place your window? Or will we just say these are different words because that's how vim does it?

## List of Neovim Features Required:

- [ ] Add Z-index for floating windows
    - [ ] When complete, we can add `zindex` parameter
- [ ] Key handlers (used for `popup_filter`)
- [ ] scrollbar for floating windows
    - [ ] scrollbar
    - [ ] scrollbarhighlight
    - [ ] thumbhighlight

Optional:

- [ ] Add forced transparency to a floating window.
    - Apparently overrides text?
    - This is for the `mask` feature flag


Unlikely (due to technical difficulties):

- [ ] Add `textprop` wrappers?
    - textprop
    - textpropwin
    - textpropid
- [ ] "close"
    - But this is mostly because I don't know how to use mouse APIs in nvim. If someone knows. please make an issue in the repo, and maybe we can get it sorted out.

Unlikely (due to not sure if people are using):
- [ ] tabpage

## Progress

Suported Features:

- [x] what
    - string
    - list of strings
- [x] popup_create-arguments
    - [x] border
    - [x] borderchars
    - [x] col
    - [x] cursorline
    - [x] highlight
    - [x] line
    - [x] {max,min}{height,width}
    - [?] moved
        - [x] "any"
        - [ ] "word"
        - [ ] "WORD"
        - [ ] "expr"
        - [ ] (list options)
    - [x] padding
    - [?] pos
        - Somewhat implemented. Doesn't work with borders though.
    - [x] posinvert
    - [x] time
    - [x] title
    - [x] wrap

## All known unimplemented vim features at the moment

- borderhighlight
- firstline
- hidden
- ~ pos
- fixed
- filter
- filtermode
- mapping
- callback
- mouse:
    - mousemoved
    - close
    - drag
    - resize

- (not implemented in vim yet) flip

Would love contributors ;)