🚀 React component that renders a Terminal 🖥
Installation
Install package with NPM or YARN and add it to your development dependencies:
npm install --save-dev react-terminal
OR
yarn install --dev react-terminal
Usage
import { ReactTerminal } from "react-terminal";
function MyComponent(props) {
// Define commands here
const commands = {
whoami: "jackharper",
cd: (directory) => `changed path to ${directory}`
};
return (
<ReactTerminal
commands={commands}
/>
);
}
Props
name | description | default |
---|
theme | Colour theme of the terminal | "light" |
showControlButtons | Whether to show the control buttons at the top of the terminal | true |
prompt | Terminal prompt | >>> |
commands | List of commands to be provided as a key value pair where value can be either a string or callback | null |
welcomeMessage | A welcome message to show at the start, before the prompt begins | null |
errorMessage | Message to show when unidentified command executed | "not found!" |
Report a bug
If you found a bug in this library, please file an GitHub issue here.