Class TermListeners

Handles keyboard and selection events for the terminal.

Index

Constructors

Methods

previousListenerAction nextListenerAction autocompleteListenerAction returnListenerAction attachInputListeners

Constructors

constructor

new TermListeners(terminal: Terminal): TermListeners
Parameters
- terminal: Terminal
  the terminal to attach listeners to
Returns TermListeners
- Defined in src/listeners.ts:15

Methods

previousListenerAction

previousListenerAction(event: Event): void
Update input and move history to the previous command.
Parameters
- event: Event
  the event that triggered the action
Returns void
- Defined in src/listeners.ts:24

nextListenerAction

nextListenerAction(event: Event): void
Update input and move history to the next command.
Parameters
- event: Event
  the event that triggered the action
Returns void
- Defined in src/listeners.ts:47

autocompleteListenerAction

autocompleteListenerAction(event: Event): void
Attempt to autocomplete the current input in the terminal.
Parameters
- event: Event
  the event that triggered the action
Returns void
- Defined in src/listeners.ts:71

returnListenerAction

returnListenerAction(event: Event): void
Execute with the current terminal input.
Parameters
- event: Event
  the event that triggered the action
Returns void
- Defined in src/listeners.ts:100

attachInputListeners

attachInputListeners(previousKey?: string, nextKey?: string): void
Attaches listeners to the terminal's input element.
Parameters
- OptionalpreviousKey: string = "ArrowUp"
  the key used to select the previous command; defaults to ArrowUp
- OptionalnextKey: string = "ArrowDown"
  the key used to select the next command; defaults to ArrowDown
Returns void
- Defined in src/listeners.ts:168