Attributes

This plugin provides rich properties to make it more flexible.

name

  • Type: string
  • Default: terminal
  • Description: Terminal instance name. This property is also required in the API.

Tips

Multiple Terminal instances can be created on the same page, but their name attributes must be different and globally unique.

context

  • Type: string
  • Default: /vue-web-terminal
  • Description: Context content, supports special characters

context-suffix

  • Type: string
  • Default: >
  • Description: Contextual suffix symbol, used to separate from user input.

show-header

  • Type: boolean
  • Default: true
  • Description: Whether to display the window header

Tips

This switch will affect the drag function. The default drag function can only be used when the header is displayed.

title

  • Type: string
  • Default: vue-web-terminal
  • Description: The title displayed in the window header. This property will only take effect after the show-header property is enabled.

drag-conf

  • Type: DragConfig
  • Default: null
  • Description: Drag window configuration DragConfig。

Tips

This configuration is only effective when show-header is turned on.

If this property is not configured, the window width and height will fill the parent element 100%, and the window width and height are equal to the parent element width and height.

init-log

  • Type: Message[] | null
  • Default: null
  • Description: The log displayed when the Terminal is initialized is an array of message objects Message. If it is set to null, it will not be displayed.

command-store

  • Type: Command[]
  • Default: Internal Commands
  • Description: A Command array, a custom command library, the search prompt function will scan this library

log-size-limit

  • Type: number
  • Default: 200
  • Description: Limit the maximum number of logs displayed.

enable-default-command

  • Type: boolean
  • Default: true
  • Description: Whether to enable the default Internal Commands switch. If you need to customize the logic of these commands, you can turn this switch off. The functions of the default commands can also be implemented through the API.

line-space

  • Type: number
  • Default: 15
  • Description: Log line space, in px

cursor-style

  • Type: string | TerminalCursorStyle
  • Default: block
  • Description: Cursor style, optional values: block | underline | bar | none
type TerminalCursorStyle = 'block' | 'underline' | 'bar' | 'none'
  • Type: boolean
  • Default: true
  • Description: Whether to turn on cursor blinking.

enable-fold

  • Type: boolean
  • Default: true
  • Description: Whether to enable the log folding function.

enable-hover-stripe

  • Type: boolean
  • Default: false
  • Description: Whether the logs in the same group are highlighted when the mouse hovers.

scroll-mode

  • Type: string
  • Default: smooth
  • Description: Window scroll bar mode, native CSS property value

command-formatter

  • Type: CommandFormatterFunc
  • Default: null
  • Description: Command display formatting function, generally used to highlight input commands, pass in the current command and return a new command, supports HTML. If not set, the internally defined highlight style will be used
type CommandFormatterFunc = (cmd: string) => string;

enable-input-tips

  • Type：boolean
  • Default：true
  • Description：Whether to enable the command input prompt function.

enable-help-box

  • Type：boolean
  • Default：true
  • Description：Whether to open the command sample prompt panel in the upper right corner of the window.

input-tips-select-handler

  • Type：InputTipsSelectHandlerFunc
  • Default：null
  • Description：Customize the logic processing function when the user selects an output prompt item.
/**
 * Input prompt selection processing function
 *
 * @param command       The complete command line entered by the current user
 * @param cursorIndex   Current cursor position
 * @param item          User selection prompt
 * @param callback      After filling, this function needs to be called to return a new command line
 */
type InputTipsSelectHandlerFunc = (command: string, cursorIndex: number, item: InputTipItem, callback: (cmd: string) => void) => void

input-tips-search-handler

  • Type：InputTipsSearchHandlerFunc
  • Default：null
  • Description：Customize the processing function of the search prompt content when the user enters.
/**
 * Implementation of user-defined command search prompt
 *
 * @param command       The complete command line entered by the current user
 * @param cursorIndex   Current cursor position
 * @param commandStore  Command collection
 * @param callback      Search end callback, the callback format is an array
 */
type InputTipsSearchHandlerFunc = (command: string, cursorIndex: number, commandStore: Command[], callback: (tips: InputTipItem[], openTips?: boolean) => void) => void

push-message-before

  • Type: PushMessageBeforeFunc
  • Default: null
  • Description: Hook function triggered before the push message is displayed. In this function, you can modify the properties of the message object.
type PushMessageBeforeFunc = (message: Message, name: String) => void;

command-sort-handler

  • Type: CommandSortHandlerFunc
  • Default: null
  • Description: Command line library sorting, custom command library display sorting rules.
type CommandSortHandlerFunc = (a: any, b: any) => number;

input-filter

  • Type: InputFilterFunc
  • Default: null
  • Description: Custom input filtering, the return value is the filtered string, must be plain text, no html tags.
type InputFilterFunc = (str1: string, str2: string, event: InputEvent) => string | null;