https://github.com/grapp-dev/nui-components.nvim

A feature-rich and highly customizable library for creating user interfaces in Neovim.
https://github.com/grapp-dev/nui-components.nvim

layout-engine lua neovim neovim-plugin nvim nvim-lua nvim-plugin ui ui-components user-interface

Last synced: 3 months ago
JSON representation

A feature-rich and highly customizable library for creating user interfaces in Neovim.

• Host: GitHub
• URL: https://github.com/grapp-dev/nui-components.nvim
• Owner: grapp-dev
• License: mit
• Created: 2024-03-12T16:01:22.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-11T16:36:08.000Z (6 months ago)
• Last Synced: 2024-05-11T17:39:57.764Z (6 months ago)
• Topics: layout-engine, lua, neovim, neovim-plugin, nvim, nvim-lua, nvim-plugin, ui, ui-components, user-interface
• Language: Lua
• Homepage: https://nui-components.grapp.dev
• Size: 34.8 MB
• Stars: 248
• Watchers: 5
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# nui-components.nvim · [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/your/your-project/blob/master/LICENSE)



> A powerful tool that aims to make UI development in Neovim more accessible, intuitive, and enjoyable.

NuiComponents is a library built on top of [`nui.nvim`](https://github.com/MunifTanjim/nui.nvim), which provides an extensive set of tools for creating user interfaces in Neovim using Lua. With NuiComponents, developers can easily build complex UIs using a simple and intuitive API, which supports various UI elements. Moreover, the library includes advanced features like state management and form validations.

## Documentation

Full documentation can be found [here](https://nui-components.grapp.dev).

## Installation

To install NuiComponents, you should use your preferred plugin manager.

[Lazy](https://github.com/folke/lazy.nvim)

```lua

{

  "grapp-dev/nui-components.nvim",

  dependencies = {

    "MunifTanjim/nui.nvim"

  }

}

```

[Packer](https://github.com/wbthomason/packer.nvim)

```lua

use {

  "grapp-dev/nui-components.nvim",

  requires = {

    "MunifTanjim/nui.nvim"

  }

}

```

## Discord

Join [Discord](https://discord.gg/Rj2V3keVS4) to get involved with the community, ask questions, and share tips.

## For plugin developers

Consider publishing your plugin to [`luarocks`](https://github.com/nvim-neorocks/sample-luarocks-plugin) to simplify installation with compatible plugin managers like [`rocks.nvim`](https://github.com/nvim-neorocks/rocks.nvim) or `lazy.nvim` extended with [`luarocks.nvim`](https://github.com/vhyrro/luarocks.nvim).

## License

The MIT License.

See [LICENSE](LICENSE)