Table of Contents

• Installation
• Usage
• License

Installation

npm i -D @dash4/plugin-terminal

Usage

dash4.config.js

const { PluginTerminal } = require('@dash4/plugin-terminal');

async function getConfig() {
  return {
    tabs: [
      {
        title: 'Root',
        rows: [
          [
            new PluginTerminal({
              cmd: 'node ./bin/chalk.js',
              dark: true,
              autostart: true,
            }),
          ],
        ],
      },
    ],
  };
}

module.exports = getConfig;

options:

// command which should be executed
cmd: string;
// current working directory of the child process.
cwd?: string;
// define a custom title for the window
title?: string;
// define a custom subtitle for the window
subtitle?: string;
// define commands (keycodes) which are allowed to enter
allowedCommands?: Array<{
  // keycode could be "a" or 13 (enter)
  keyCode: number | string;
  // translated keyCode for terminal
  // for example if keyCode = 13 the terminalOutput is "\r"
  terminalOutput?: string;
  // title will be displayed in button
  title: string;
  // allows you to modifie (validate) the entered input before execution
  input?: (value: string) => string;
}>;
// enable/disable dark mode
dark?: boolean;
// if true the given command will be executed on start
autostart?: boolean;
// grid with per breakpoint
// [12,6,3] means 100% width on small viewports, 50% on medium viewports and 33.3% on large viewports
width?: number[];
// define fixed height
height?: number;

License

The @dash4/plugin-terminal is MIT licensed