Repository files navigation

Write interactive CLI apps with React

Package	Description	Version
@react-slate/core	The core functionality and logic.

https://zamotany.github.io/react-slate/

• Render React apps to:
  • terminal withrender
  • terminal in fullscreen mode withrenderFullscreen
  • a string withrenderToString
  • a JSON treerenderToJson
• Usefor await to continuously render your app usingrenderToString orrenderToJson.
• Render your app to alternative screen buffer and go back to the previous content upon exit withrenderFullscreen.
• Log messages to main screen buffer withconsole when exiting when in fullscreen mode (renderFullscreen).
• Build layouts with FlexBox (https://github.com/vislyhq/stretch).
• Disable colors withNO_COLOR environment variable.
• Use standard ANSI colors, RBG, Hex and CSS keywords to style your app.
• Use built-in<Progress /> and<Spinner /> components.
• Get layout information usingonLayout prop.
• Handle clicks usingonClick prop.
• Detect mouse wheel events usingonWheel prop.
• Support for absolute positioning and depth (zIndex).
• Built with TypeScript.

Please check outRoadmap for in-progress and planned features.

• Web components are not compatible.
• Strings must be wrapped in a<Text> component.

yarn add react @react-slate/core

importReactfrom'react';import{render,View,Text}from'@react-slate/core';functionApp(){return(<Viewwidth="100%"flexDirection="row"justifyContent="center"><Textcolor="green"bold>Hello world!</Text></View>);}render(<App/>);