smart-terminal
v0.2.3
Published
It sits unobtrusively on the bottom right hand of the screen, and lets users know its listening. If something interesting happens it performs its magic to let the users know what happened.
Downloads
28
Readme
smart-terminal
It sits unobtrusively on the bottom right hand of the screen, and lets users know its listening. If something interesting happens it performs its magic to let the users know what happened.
installation
You can install into your application by running npm install --save-dev smart-terminal
Why
I made this terminal for my own consumption, but you are free to use it too!
Usage
npm install --save smart-terminal
import SmartTerminal from 'smart-terminal'
var smartTerminal = new SmartTerminal(null, null)
smartTerminal.show()
smartTerminal.appendMessage("Some message")
If you want to show some pending operation you can do
smartTerminal.showPending()
You can also chain stuff:
smartTerminal.clear().appendMessage("Some message")
Features
- It writes text
- Has fluent style api
Events api
If you want to use it in a component with no reference you can "hand code it with" DOMEvents:
var smartTerminal = new SmartTerminal(null, null)
document.body.addEventListener(SmartTerminal.EVENTS.APPEND_MESSAGE, function (event: CustomEvent) {
smartTerminal.appendMessage(event.detail)
})
//somewhere in your code
let event = new CustomEvent(SmartTerminal.EVENTS.APPEND_MESSAGE,
{detail: "this message came from a DOM event of type SmartTerminal.EVENTS.APPEND_MESSAGE"})
document.body.dispatchEvent(event)
Note: by convention, you should use the strings SmartTerminal.EVENTS.
Roadmap
Gradual typing on output text to give it a geeky feel