@zqui/react-terminal v0.0.11

🖥️ React Terminal

A sleek and customizable terminal emulator component for React applications.

🗺️ Demo

Check out the live demo here: Live Demo

🚀 Features

• 🎨 Customizable themes (7+ built-in themes)
• 🔍 Command prediction (with tab autocomplete)
• 📂 Built-in file system simulation
• ⌨️ Built-in commands (ls, cd, cat, etc.)
• 🔧 Extensible with custom commands (async commands supported)
• ⏮️ Command history navigation
• 🔄 Async command loading animation

📦 Installation

npm install @zqui/react-terminal

🛠️ Usage

// App.tsx
import { TerminalContextProvider } from '@zqui/react-terminal';

// !Don't forget to wrap your app's entry point with TerminalContextProvider!
function App() {
  return (
      <TerminalContextProvider>
        {/* Rest of your components */}
      </TerminalContextProvider>
  );
}

// SomeComponent.tsx
import Terminal from '@zqui/react-terminal';

function SomeComponent() {
  return (
    <Terminal
      prompt="user@anon:"
      theme="dark"
      welcomeMessage="Welcome to React Terminal Emulator!"
    />
  )
}

🎛️ Props

IUserCommands

type IUserCommands = Record<
  string,
  | string
  | React.JSX.Element
  | ((args?: any) => React.JSX.Element | string | void | Promise<string | void>)
>;

This type defines a record where each key represents a command, and the value can be a simple string, a React element, or a function that returns a string, a React element, or a Promise.

Example:

const commands = {
  hello: "Hello, World!", // Simple string response
  greet: (name) => `Hello, ${name}!`, // Function that returns a string
  react: <strong>React is awesome!</strong>, // React element
  asyncTask: async () => {
    await someAsyncOperation();
    return "Task completed!"; // Async function returning a string
  },
};

IDirectoryStructure

interface IFile {
  content: string | JSX.Element;
}

interface IDirectory {
  [key: string]: IFile | IDirectory;
}

type IDirectoryStructure = IDirectory;

IDirectoryStructure represents the structure of the terminal's file system. It consists of a recursive structure of directories and files. Each directory contains files or other directories. A file has a content field, which can be a string or a React element.

Example:

const fileSystem = {
  home: {
    "README.md": { content: "# Welcome to the Home Directory" }, // File with string content
    projects: {
      "project1.txt": { content: "Project 1 details" }, // File within a nested directory
      "project2.md": { content: <em>Project 2 documentation</em> }, // File with React element content
    },
  },
  etc: {
    config: {
      "settings.json": { content: '{"theme": "dark"}' }, // JSON file content
    },
  },
};

ITheme

interface ITheme {
  terminalBg: string;
  topBarBg: string;
  promptColor: string;
  pwdColor: string;
  textColor: string;
  predictionColor: string;
}

ITheme allows customization of various terminal colors. Each property corresponds to a CSS color value:

• terminalBg: Background color of the terminal.
• topBarBg: Background color of the top bar.
• promptColor: Color of the prompt string.
• pwdColor: Color of the present working directory display.
• textColor: Default text color.
• predictionColor: Color of the command prediction text.

Example:

const customTheme: ITheme = {
  terminalBg: "#1e1e1e", // Dark background
  topBarBg: "#333333", // Darker top bar
  promptColor: "#00FF00", // Bright green prompt
  pwdColor: "#FFD700", // Golden color for directory path
  textColor: "#FFFFFF", // White text color
  predictionColor: "#AAAAAA", // Grey prediction text
};

🌈 Themes

The terminal comes with several built-in themes:

• 🌞 Light
• 🌚 Dark
• 👨‍💻 Hacker
• 🌅 Sunset
• ❄️ Nordica
• 🍬 Pastel Dream
• 🎨 Monokai
• 🌊 Solarized

You can also create custom themes by passing an ITheme object.

🔧 Custom Commands

You can add custom commands to the terminal:

const customCommands = {
  hello: "Hello, World!",
  greet: (name) => `Hello, ${name}!`,
  asyncTask: async () => {
    await someAsyncOperation();
    return "Task completed!";
  },
};

<Terminal commands={customCommands} />

🛠️ Built-in Commands

The terminal includes several built-in commands to provide essential functionalities:

• 🧹 clear: Clears the terminal screen, removing all previous commands and outputs.

• 🗣️ echo [text]: Prints the provided text to the terminal. Useful for displaying messages or values of variables.

• 📁 cd [directory]: Changes the current working directory to the specified directory. Use cd .. to move to the parent directory.

• 📂 ls: Lists the contents of the current directory, including files and subdirectories.

• 📄 cat [file]: Displays the content of the specified file. Use this to read and view file contents directly in the terminal.

• 📌 pwd: Prints the current working directory path.

• 📂 mkdir [directory]: Creates a new directory with the specified directory name in the current location.

• 🗑️ rm [file/directory]: Removes the specified file or directory. Be careful, as this action is irreversible!

• 📅 date: Displays the current date and time.

• 🎨 setTheme [theme]: Changes the terminal's theme to the specified theme, allowing users to switch between different visual styles on the fly.

🛠️ Troubleshooting

• Async commands not working properly? Try switching off StrictMode.
• Terminal doesn't have proper height? By default it takes the full width & height of its parent, try giving the parent some height & width.
• Built in commands not working? Make sure to provide the directoryStructure prop.
• Command prediction not working properly? Well, that's just a bug for now :cry:.

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

📄 License

This project is MIT licensed.