waveterm/xterm.js
0
0
Fork 0
mirror of https://github.com/wavetermdev/xterm.js.git synced 2026-08-05 13:43:48 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Added Getting started content from the xtermjs.org website
This commit is contained in:
Saswat Das
2016-12-18 04:48:19 +05:30
committed by GitHub
parent 4ee1e00808
commit d018a547a2
1 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17 -17
View File
@@ -54,25 +54,25 @@ Then open http://0.0.0.0:3000 in a web browser (use http://127.0.0.1:3000 if run
## Getting Started
To attact the xterm `Terminal` to a parent div
To start using xterm.js on your browser, add the `xterm.js` and `xterm.css` to the head of your html page. Then create a `<div id="terminal"></div>` onto which xterm can attach itself.
```html
<div id="terminal"></div>
```
```js
var term = new Terminal();
term.open(document.getElementById('#terminal'));
term.write('Hello from \033[1;3;31mxterm.js\033[0m $ ')
```
To get the data from xterm to send to a server or for proccessing you can
```js
function onDataReceived(data) {
// Your logic
}
term.on('data', onDataReceived);
<!doctype html>
<html>
<head>
<link rel="stylesheet" href="bower_components/xterm.js/dist/xterm.css" />
<script src="bower_components/xterm.js/dist/xterm.js"></script>
</head>
<body>
<div id="terminal"></div>
<script>
var term = new Terminal();
term.open(document.getElementById('#terminal'));
term.write('Hello from \033[1;3;31mxterm.js\033[0m $ ')
</script>
</body>
</html>
```
Finally instantiate the `Terminal` object and then call the `open` function with the DOM object of the `div`.
## Addons