JSPM

@afegmdg/react-tui

0.0.3
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 11
  • Score
    100M100P100Q37176F
  • License MIT

A React custom renderer for the terminal.

Package Exports

  • @afegmdg/react-tui
  • @afegmdg/react-tui/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@afegmdg/react-tui) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

react-tui

A 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/neo-blessed and react-blessed but a complete own, new implementation using typescript. It does not use the blessed or neo-blessed library at all.

Summary

Installation

You can install react-tui through npm:

npm install @afegmdg/react-tui

Demo

For a quick demo of what you could achieve you can clone this repository and check the example:

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

  • 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