Package Exports

web-term-ui
web-term-ui/web-term-ui.es.min.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (web-term-ui) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

WebTerm UI

A Web Terminal UI Lib

Demo | Playground | Version

Xterm.js is Good, but it is a nightmare when building pure front-end terminal UI, So You need This Lib.

Features

Support block cursor style
Support inline wrap
Support Multiple-length characters
Support history record
Support Custom storageProvider
Support Dark/Light Mode
Support text Editor
Support set fontSize

Usage

npm i web-term-ui

import {WebTerm} from 'web-term-ui';
const term = new WebTerm({
    title: 'This is a Demo. Type "help" to get Help.\n',
    container: '#container',
    header: '/ admin$ ',
});
term.on('enter', v => {
    if (v === 'vi') term.vi('', `"Ctrl/Cmd + s" to Save, "Esc" to Exit`);
    else term.write(`Exec "${v}"`);
});
term.on('tab', () => {
    term.insertEdit('[test]');
});

CDN

<script src="https://cdn.jsdelivr.net/npm/web-term-ui"></script>
<script>console.log(window.WebTermUi);</script>

More usage please refer to typing

editor

import {WebTerm} from 'web-term-ui';
const term = new WebTerm({
    title: 'This is a Demo. Type "help" to get Help.\n',
    container: '#container',
    header: '/ admin$ ',
});

const editor = term.edit('Hello', {
    title: 'Edit <h1>Demo</h1>',
    html: true,
}); // title and html is optional
editor.on('')

Options

export interface IWebTermStyle {
    padding?: number;
    color?: string;
    background?: string;
    selectionColor?: string;
    selectionBackground?: string;
    fontSize?: number;
}
export interface IWebTermOptions {
    title?: string;
    titleHtml?: boolean;
    container?: string | HTMLElement;
    historyMax?: number;
    storageProvider?: {
        read: () => IPromiseMaybe<string>;
        write: (history: string) => IPromiseMaybe<boolean>;
    };
    header?: string;
    theme?: "dark" | "light";
    style?: IWebTermStyle;
    parseCommand?: boolean;
}

API

{
    theme: "dark" | "light";
    title: string;
    get value(): string;
    get header(): string;
    get fontSize(): number;
    setTheme(theme: "light" | "dark"): void;
    setColor(opt: Pick<IWebTermStyle, "background" | "color" | "selectionBackground" | "selectionColor">): void;
    setFontSize(size: number): void;
    clearInputHistory(): void;
    write(content: IContent, { html, clear, }?: {
        html?: boolean;
        clear?: boolean;
    }): void;
    insertText(content: string): void;
    setCursorPos(index: number): void;
    edit(v?: string, opt?: {
        title?: string;
        html?: boolean;
    }): Editor;
    clearTerminal(): void;
    newLine(html?: boolean): void;
    setHeader(header: string): void;
    scrollToBottom(): void;
    focus(): void;
    writeBelow(content: IContent, html?: boolean): void;
    pushBelow(content: IContent, html?: boolean): void;
    clearBelow(): void;
    resize(): void;
    parseCommand(v: string): ICommandInfo[];
}

Editor

declare class Editor {
    setFontSize(v: number): void;
    get value(): string;
    get fullValue(): string;
    get beforeValue(): string;
    get headerWidth(): number;
    focus(): void;
    pushText(v: string): void;
    insertText(content: string): void;
    replaceText(v: string): void;
    clearContent(relocate?: boolean): void;
    setCursorToHead(): void;
    setCursorPos(n: number): void;
    resize(fromInit?: boolean): void;
}

Editor Events

{
    key: [
        "Enter" | "ArrowUp" | "ArrowDown" | "Tab"
    ];
    input: [
    ];
    "cursor-change": [
        ICursorChangeData
    ];
    "edit-done": [
        string
    ];
    "edit-cancel": [
    ];
}

Events

export interface IWebTermEvents {
    'enter': [string],
    'tab': [string]; // before cursor value
    "input": [
        string, // full value
        string, // before cursor value
    ];
    "cursor-change": [
        ICursorChangeData
    ];
    "command": [
        ICommandInfo,
        ICommandInfo[]
    ];
}

interface ICursorChangeData {
    x: number;
    y: number;
    word: string;
    wordWidth: number;
    beforeValue: string;
    value: string;
}