romgrk / kui.nvim

UI neovim framework for kitty

kui.nvim

This project is a neovim UI framework, aiming to use the Kitty graphics protocol to build complex graphical interfaces. This depends on the user having a terminal with support for the kitty graphics protocol as well as libcairo installed.

See kirby.nvim for a more complex example.

See https://github.com/romgrk/kui-demo.nvim for a template showing how to implement the demo above.

Plugins

These plugins are based on kui:

• kirby.nvim

Status & features

Status: experimental, good enough for small use cases

Features:

• Container system (transpiled from Pixi.JS via TypescriptToLua)
• Images (I don't remember if I implemented it, TBC)
• Masks
• Graphics (lines, rects, ovals, paths)
• Basic text (size, family, weight, color)
• Advanced text (highlighted text (think code syntax), proper layout & rendering)
• Medium-performance rendering (think 30FPS animations, medium surface)
• High-performance rendering (think 60FPS animations, large surface)

License

MIT

Includes code from:

• pixi.js: MIT
• colord: MIT
• hologram.nvim: MIT
• tstoluaplugin.nvim: MIT

kui.nvim's Issues

docs: add section for Status of Project

this is a plugin with HUGE potential, and it will be helpful to have these sections in a wiki or in a section of the README.md for plugin authors AND plugin users to see the status of this project, and where / how can they use it (directly or indirectly).

sections to consider:

• status of project (scope, missing features, completed features, required help, references etc)
• usage (plugins using this if any) [ consider adding the demo to this section as well ]

Question: How it renders?

Seems like kui-demo.nvim and kirby.nvim are float. But I want to draw on buffer. If user move(resize, close etc.) buffer, rendered side also effect. Is it possible?