Components/Data displayIntroduced in 1.3.0

ETerminal Terminal

import EUI 1.0

Examples

Commands and history

QML sourceQML

import EUI 1.0 import QtQuick 2.15 import QtQuick.Layouts 1.15 import QtQuick.Controls 2.15 ETerminal { height: 240 width: Math.min(600, parent.width) welcome: qsTr("Try help, echo hello, clear. Up/Down: history.") }

Preview

Run the code to try the component

Edit text, properties, or events, then select Run.

Code runs in this browser Licenses

Custom command

QML sourceQML

import EUI 1.0 import QtQuick 2.15 import QtQuick.Layouts 1.15 import QtQuick.Controls 2.15 ETerminal { height: 240 welcome: "Try status" width: Math.min(600, parent.width) commandHandler: function(command) { return command === "status" ? "Ready" : "Unknown: " + command } }

Preview

Run the code to try the component

Edit text, properties, or events, then select Run.

Code runs in this browser Licenses

Async command

QML sourceQML

import EUI 1.0 import QtQuick 2.15 import QtQuick.Layouts 1.15 import QtQuick.Controls 2.15 ETerminal { height: 240 welcome: "Try any command" width: Math.min(600, parent.width) commandHandler: function(command) { return Promise.resolve("Done: " + command) } }

Preview

Run the code to try the component

Edit text, properties, or events, then select Run.

Code runs in this browser Licenses

Command error

QML sourceQML

import EUI 1.0 import QtQuick 2.15 import QtQuick.Layouts 1.15 import QtQuick.Controls 2.15 ETerminal { height: 240 width: Math.min(600, parent.width) commandHandler: function(command) { return Promise.reject("Failed: " + command) } }

Preview

Run the code to try the component

Edit text, properties, or events, then select Run.

Code runs in this browser Licenses

Custom prompt

QML sourceQML

import EUI 1.0 import QtQuick 2.15 import QtQuick.Layouts 1.15 import QtQuick.Controls 2.15 ETerminal { height: 240 prompt: "eui >" historyLimit: 20 width: Math.min(600, parent.width) }

Preview

Run the code to try the component

Edit text, properties, or events, then select Run.

Code runs in this browser Licenses

Properties

PropertyDescriptionValues and default

promptstring

Prompt before terminal input.

Default"$"

welcomestring

Message displayed above terminal output.

Default""

historyLimitint

Maximum retained commands and output records; minimum 1.

Default200

commandHandlervar

Handler accepting a command and returning output or a Promise.

Defaultnull

busyboolRead only

Waiting for a command result; prevents another command from starting.

Defaultstate.busy

inputaliasRead only

Terminal command input control.

DefaultcommandInput

entriesvarRead only

Terminal output entries containing command, output and error.

Defaultstate.entries

Signals

SignaturePurpose

submitted(string command)

Emitted when a command is submitted; command is the entered command text.

completed(string command, string output, bool error)

Emitted when command execution finishes; command is the command, output is its output, and error indicates failure.

Methods

SignaturePurpose

clear()

Clear the current contents or selection.

write(text, error)

Append text to the terminal; display it as an error when error is true.

execute(command)

Execute the terminal command specified by command.