Started documenting methods

Also added Getting Started section in docs
This commit is contained in:
paris 2014-05-02 22:51:38 +00:00
parent 21dde3cfa2
commit c9f5f235e2
2 changed files with 66 additions and 1 deletions

View File

@ -13,11 +13,29 @@ the experience of running a fully-feature terminal inside the browser.
Xterm.js serves as the foundation for the terminal found at www.sourcelair.com.
Contents:
Getting started
^^^^^^^^^^^^^^^
.. code-block:: javascript
var term = new Terminal(),
socket = new WebSocket('ws://docker/containers/mycontainer/attach/ws');
term.open(document.body);
term.on('data', function (data) {
socket.send(data);
});
socket.onmessage = function (e) {
term.write(e.data);
}
Contents
.. toctree::
:maxdepth: 1
methods
events

47
docs/methods.rst Normal file
View File

@ -0,0 +1,47 @@
-------
Methods
-------
focus()
^^^^^^^
Sends focus to the terminal
blur()
^^^^^^
Blurs the Terminal
open(element)
^^^^
Open the Xterm terminal, inside the given element.
resize(x, y)
^^^^^^^^^^^^
Resize the terminal, according to the given columns and rows.
insertRow(row)
^^^^^^^^^^^^^^
Insert the given row in the terminal.
on(event, callback)
^^^^^^^^^^^^^^^^^^^
Hook the given callback, to the given event.
off(event, callback)
^^^^^^^^^^^^^^^^^^^
Remove the Hook of the given callback, from the given event.
once(event, callback)
^^^^^^^^^^^^^^^^^^^
Hook the given callback to the given event, for just a single invocation.
write(data)
^^^^^^^^^^^
Write the given data to the terminal.
writeln(data)
^^^^^^^^^^^^^
Write the given data to the terminal, followed by a carriage return and a new line.
handler(data)
^^^^^^^^^^^^^
Fire the data event, for the given data.