Skip to content

jvorcak/react-console

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MIT-licensed console emulator in React. Documentation and more advanced features coming soon!

react-console

React component that emulates console behaviour

NPM JavaScript Style Guide

Install

npm install --save @webscopeio/react-console

Demo

https://webscopeio.github.io/react-console/

Screenshot

Webscope React Console

Props

Props Type Description
commands* Object
prompt string
welcomeMessage string
autoFocus boolean
noCommandFound (...str: string[]) => Promise
wrapperStyle Object styles for the wrapper
promptStyle Object styles for the prompt
inputStyle Object styles for the input
wrapperClassName string className for the wrapper
promptClassName string className for the prompt
inputClassName string className for the input

*are mandatory

Usage

import React, { Component } from 'react'

import ReactConsole from 'react-console'

export default class App extends Component {
  render () {
    return (
      <div>
        <ReactConsole
          autoFocus
          welcomeMessage="Welcome"
          commands={{
            echo: {
              description: 'Echo',
              fn: (...args) => {
                return new Promise((resolve, reject) => {
                  setTimeout(() => {
                    resolve(`${args.join(' ')}`)
                  }, 2000)
                })
              }
            },
            test: {
              description: 'Test',
              fn: (...args) => {
                return new Promise((resolve, reject) => {
                  setTimeout(() => {
                    resolve('Hello world \n\n hello \n')
                  }, 2000)
                })
              }
            }
          }}
        />
      </div>
    )
  }
}

License

MIT © jvorcak

About

💻Simple console emulator in React

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 43.9%
  • JavaScript 43.9%
  • CSS 7.8%
  • HTML 4.4%