https://github.com/s1n7ax/nvim-react

Reactive UI framework for neovim
https://github.com/s1n7ax/nvim-react

neovim nvim ui

Last synced: 3 days ago
JSON representation

Reactive UI framework for neovim

• Host: GitHub
• URL: https://github.com/s1n7ax/nvim-react
• Owner: s1n7ax
• Created: 2022-11-07T10:53:27.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-25T19:02:36.000Z (4 months ago)
• Last Synced: 2024-08-02T13:32:50.738Z (3 months ago)
• Topics: neovim, nvim, ui
• Language: Lua
• Homepage:
• Size: 69.3 KB
• Stars: 53
• Watchers: 4
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# nvim-react (:construction: WIP)

Reactive UI rendering framework for Neovim

## Features

- [x] Functional components

- [x] Signals (something like `useState` in [ReactJS][reactjs])

- [ ] Complex data stores (:construction: WIP)

- [ ] Lifecycle callbacks

- [ ] Keymap events

- [ ] Highlighting

## Development

Open the project

```bash

nvim -c "luafile dev/init.lua"

```

Try `w` keymap

### Run tests

:warning: Running tests requires [plenary.nvim][plenary] to be checked out in

the parent directory of _this_ repository :warning:

You can then run:

```bash

nvim \

--headless \

--noplugin \

-u tests/minimal.vim \

-c "PlenaryBustedDirectory tests/ {minimal_init = 'tests/minimal.vim'}"

```

Or if you want to run a single test file:

```bash

nvim \

--headless \

--noplugin \

-u tests/minimal.vim \

-c "PlenaryBustedDirectory tests/path_to_file.lua {minimal_init = 'tests/minimal.vim'}"

```

[plenary]: https://github.com/nvim-lua/plenary.nvim

[reactjs]: https://reactjs.org