diff --git a/docs/index.rst b/docs/index.rst index 45d5df7..8dcf8ca 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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 diff --git a/docs/methods.rst b/docs/methods.rst new file mode 100644 index 0000000..6e89afd --- /dev/null +++ b/docs/methods.rst @@ -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. \ No newline at end of file