Skip to content

Champii/Xpra-canvas-client

Repository files navigation

Xpra-html-client

Xpra library to make HTML5 clients

Largely copied and adapted from http://xpra.org/trac/ticket/473

Not realy usable yet, project under heavy development.

A demo project is using it right now, but in heavy development too : DexTop

Released under GPLv2


Concept

Xpra is a seemless X11 server, allowing you to remotely access to your applications.

This client is based on HTML5 canvas for modern browsers, and allow to render and interact with your X11 application directly inside your browser.

This library is Event based and try to provide a full and easy-to-learn encapsulation for every part of the Xpra protocol, and don't let the user deal with every other low-level programing problems.

Its core allows to deal with high-level Window encapsulations.


Features

  • Window object encapsulation
  • Event based interactions
  • Keyboard inputs
  • Window pixmap drawn and updated on offscreen canvas

Getting started

Check how to install xpra server: http://xpra.org/

$> websockify  8080 localhost:10000&
$> xpra start :10 --bind-tcp=0.0.0.0:10000

Here is a snippet to show how to use this library :

# Take a host and a port
@client = new Xpra '1.1.1.1', 1234

@client.on 'new-window', (win) ->
  # Deal with this plain window object
  win.on 'drawn', (region) ->
  win.on 'focus', ->

  console.log win
  # Show for exemple :
    # _events: Object
    # height: 316
    # offscreen: canvas
    # properties: Object
    # wid: 2
    # width: 484
    # x: 0
    # ray: 30

Supported events from now :

  • On client itselft :

    • 'new-window'
  • On windows :

    • 'focus'
    • 'drawn'

TODO

  • Full working keyboard events
  • Window on close
  • Configuration
  • Mouse
  • Focus
  • Resize

About

HTML5/Canvas Xpra client

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published