Need help with react-blessed?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

4.1K Stars 184 Forks MIT License 188 Commits 38 Opened issues


A react renderer for blessed.

Services available


Need anything else?

Contributors list


A React custom renderer for the blessed library.

This renderer should currently be considered as experimental, is subject to change and will only work with React's latest version (

, using Fiber).




You can install

 through npm:
# Be sure to install react>=17.0.0 & blessed>=0.1.81 before
npm install blessed react

Then just install react-blessed

npm install react-blessed


For a quick demo of what you could achieve with such a renderer you can clone this repository and check some of the examples:

git clone
cd react-blessed
npm install

To see which examples you can run:

npm run demo

Then choose one to run:

npm run demo animation


Rendering a basic application

import React, {Component} from 'react';
import blessed from 'blessed';
import {render} from 'react-blessed';

// Rendering a simple centered box class App extends Component { render() { return ( Hello World! ); } }

// Creating our screen const screen = blessed.screen({ autoPadding: true, smartCSR: true, title: 'react-blessed hello world' });

// Adding a way to quit the program screen.key(['escape', 'q', 'C-c'], function(ch, key) { return process.exit(0); });

// Rendering the React app using our screen const component = render(, screen);

Nodes & text nodes

Any of the blessed widgets can be rendered through

by using a lowercased tag title.

Text nodes, on the other hand, will be rendered by applying the

method with the given text on the parent node.


As with React's DOM renderer,

lets you handle the original blessed nodes, if you ever need them, through refs.
class CustomList extends Component {
  componentDidMount() {

// Focus on the first box


render() { return ( First box. Second box. ); } }


Any blessed node event can be caught through a

-prefixed listener:
class Completion extends Component {
  constructor(props) {

this.state = {progress: 0, color: 'blue'};

const interval = setInterval(() => {
  if (this.state.progress >= 100)
    return clearInterval(interval);

  this.setState({progress: this.state.progress + 1});
}, 50);


render() { const {progress} = this.state, label = Progress - ${progress}%;

// See the `onComplete` prop
return <progressbar label="{label}" oncomplete="{()"> this.setState({color: 'green'})}
                    style={{bar: {bg: this.state.color}}} /&gt;;

} }


For convenience,

lets you handle classes looking like what react-native proposes.

Just pass object or an array of objects as the class of your components likewise:

// Let's say we want all our elements to have a fancy blue border
const stylesheet = {
  bordered: {
    border: {
      type: 'line'
    style: {
      border: {
        fg: 'blue'

class App extends Component { render() { return ( First box. Second box. ); } }

You can of course combine classes (note that the given array of classes will be compacted): ```jsx // Let's say we want all our elements to have a fancy blue border const stylesheet = { bordered: { border: { type: 'line' }, style: { border: { fg: 'blue' } } }, magentaBackground: { style: { bg: 'magenta' } } };

class App extends Component { render() {

// If this flag is false, then the class won't apply to the second box
const backgroundForSecondBox = this.props.backgroundForSecondBox;

return ( First box. Second box. );

} } ```

Using blessed forks

Because blessed is not actively maintained in quite a while, you might want to use one of it's forks. To do that, import

function instead:
import React, {Component} from 'react';
import blessed from 'neo-blessed';
import {createBlessedRenderer} from 'react-blessed';

const render = createBlessedRenderer(blessed);

Using the devtools

can be used along with React's own devtools for convenience. To do so, just install
in your project and all should work out of the box when running the Electron app, as soon as a
program is running on one of your shells.


  • Full support (meaning every tags and options should be handled by the renderer).
  • react-blessed-contrib
    to add some sugar over the blessed-contrib library (probably through full-fledged components).


  •  : To enable interactions, add 
    mouse={ true }
    keys={ true }


Contributions are obviously welcome.

Be sure to add unit tests if relevant and pass them all before submitting your pull request.

# Installing the dev environment
git clone [email protected]:Yomguithereal/react-blessed.git
cd react-blessed
npm install

Running the tests

npm test



We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.