mirror of https://git.proxmox.com/git/mirror_xterm.js synced 2025-10-31 20:55:13 +00:00

Go to file

Paris abb7a49584 Add CXX environment		2016-06-09 10:22:49 +03:00
addons	Change CommonJS package structure	2016-05-03 12:48:16 +03:00
bin	Set up environment for testing	2016-06-09 10:04:53 +03:00
demo	Don't crash demo server on refresh	2016-06-08 19:28:55 -07:00
src	Fix buffer corruption after resizing rows	2016-06-08 19:08:32 -07:00
test	Set up environment for testing	2016-06-09 10:04:53 +03:00
.editorconfig	added *.css rules in .editorconfig for indent consistency	2015-11-11 10:36:20 +02:00
.gitignore	Update .gitignore to ingore npm logs	2016-02-09 14:42:33 +02:00
.travis.yml	Add CXX environment	2016-06-09 10:22:49 +03:00
bower.json	Bump version to 0.33	2016-04-26 12:17:41 +03:00
conf.json	Set up JSDoc documentation	2015-04-13 19:18:09 +03:00
Dockerfile	Implement fully featured terminal demo w/ static fallback	2016-06-07 08:41:41 +00:00
LICENSE	Updated LICENSE and REAMDE	2014-03-24 16:11:27 +00:00
package.json	Set up environment for testing	2016-06-09 10:04:53 +03:00
Procfile.dev	Implement fully featured terminal demo w/ static fallback	2016-06-07 08:41:41 +00:00
README.md	Add travis ci build status in xterm.js	2016-06-09 10:10:36 +03:00
xtermjs.png	Update README	2016-02-09 14:48:54 +02:00

README.md

xterm.js

Xterm.js is a full xterm clone, written in JavaScript.

It is used at SourceLair to help people develop their applications in their browsers.

Xterm.js supplies a modular, event-based interface that lets developers build addons and themes on top of it.

Demo

To launch the demo simply run:

npm install
npm start

Then open http://0.0.0.0:3000 in a web browser.

Addons

Addons are JavaScript modules that attach functions to the Terminal prototype to extend its functionality. There are a handful available in the main repository in the addons directory, you can even write your own (though they may break when the internals of xterm.js change across versions).

To use an addon, just include the JavaScript file after xterm.js and before the Terminal object has been instantiated. The function should then be exposed on the Terminal object:

<script src="node_modules/src/xterm.js"></script>
<script src="node_modules/addons/linkify/linkify.js"></script>

var xterm = new Terminal();
// init code...
xterm.linkify();

Contribution and License Agreement

If you contribute code to this project, you are implicitly allowing your code to be distributed under the MIT license. You are also implicitly verifying that all code is your original work.