@piopli/terminal-ui v1.2.0

TerminalUI

Simple and lightweight terminal UI component.

Installation

npm install @piopli/terminal-ui

Usage

Example:

<div data-terminalui>
  <div data-terminalui-command>
    echo "Lorem ipsum dolor, sit amet consectetur adipisicing elit."
  </div>
  <div data-terminalui-output>
    Lorem ipsum dolor, sit amet consectetur adipisicing elit.
  </div>
</div>

You can use CSS-only version or include JavaScript to get some dynamic functionality.

CSS-only

Just include styles.css file in your project.

JavaScript

import terminalui from '@piopli/terminal-ui';

const terminal = terminalui();
terminal.init();

Configuration

Available options:

• selector - custom selector to handle only selected TerminalUI objects with created instance
• prompt - custom terminal prompt, default: $
• failSilently - specify if instance should throw error or fail silently if no matching containers are found, default: true

Example configuration:

const terminal = terminalui({
  selector: '.custom-terminalui-selector',
  prompt: '>',
  failSilently: true,
});