# @afegmdg/react-tui

> A React custom renderer for the terminal.

Latest version **0.0.3** (published 2022-08-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @afegmdg/react-tui
pnpm add @afegmdg/react-tui
yarn add @afegmdg/react-tui
bun add @afegmdg/react-tui
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2022-08-21 |
| First published | 2022-08-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=16.14.0 |
| Dependencies | 1 |
| Unpacked size | 118.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | AFE-GmdG |
| Maintainers | afe-gmdg |
| Keywords | react, tui, curses |

## Links

- npm: https://www.npmjs.com/package/@afegmdg/react-tui
- Repository: https://github.com/AFE-GmdG/react-tui
- Homepage: https://github.com/AFE-GmdG/react-tui#readme
- Issues: https://github.com/AFE-GmdG/react-tui/issues
- npm.io page: https://npm.io/package/@afegmdg/react-tui

## Dependencies (1)

- [ansi-escapes](https://npm.io/package/ansi-escapes.md) ^5.0.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.0.3 (latest) — 2022-08-21
- 0.0.2 — 2022-08-21
- 0.0.1 — 2022-08-20

## README

# react-tui

A [React](https://facebook.github.io/react/) custom renderer for the terminal.

This renderer is in early development phase ans should be considered as experimental. It will only work withReact's latest version (`~18.0.2`, using Fiber).

It's inspired by [blessed](https://github.com/chjj/blessed)/[neo-blessed](https://github.com/embarklabs/neo-blessed) and [react-blessed](https://github.com/Yomguithereal/react-blessed) but a complete own, new implementation using typescript. It does not use the blessed or neo-blessed library at all.

## Summary
* [Installation](#installation)
* [Demo](#demo)
* [Usage](#usage)

## Installation
You can install `react-tui` through npm:
```bash
npm install @afegmdg/react-tui
```

## Demo
For a quick demo of what you could achieve you can clone this repository and check the example:
```bash
git clone https://github.com/AFE-GmdG/react-tui.git
cd react-tui
npm install

npm run builddemo
npm run demo
```

## Usage
Currently you cannot use this version, since it's incomplete.

## Next steps
- [x] Figure out, how to bundle the library the correct way, so it can be used with other projects.
- [ ] Complete the reconciler implementation
  - [ ] no more `debugger` / `throw new Error("Method not implemented.")`
- [ ] Basic layout calculations
- [ ] Colored output
- [ ] Implement basic components
  - [ ] Text
  - [ ] Box
  - [ ] Button
  - [ ] Input

---
_Source: https://npm.io/package/@afegmdg/react-tui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._