Skip to content

tcsaddul/qx-typed

 
 

Repository files navigation

Introduction

This is a small test application that demonstrates how you can easily use Qooxdoo from a TypeScript project. This application can also serve as a template to build your own application.

The easiest way is to try it out and get started is:

  • Download this application
  • Download the CATS editor, specially designed for developing with TypeScript. You can get it from https://github.com/jbaron/cats
  • Open this application folder as a project in CATS.

From there on it feels very much like a tradditional Java or C# development cycle. Change the code, compile, run.

How to get started

All you really need to do is implement a function with the following signature:

someFunctionName(app: qx.application.Standolone): void

and then register it:

qx.registry.registerMainMethod(someFunctionName);

Within this function you can use all the Qooxdoo widgets you like and it is behaves just like a normal Qooxdoo application. The benefit is that because of TypeScript and CATS you get all kind of benefits like codecompletion, type checking and easy navigation.

You can use the provided test application (application.ts) as an example to see how to create some simple widgets.

Background

For the CATS editor, I wwanted to validate if Qooxdoo would be a good fit. So can Qooxdoo be used from TypeScript and having the best of both worlds: a proven set of widgets I was looking for with the strong typing that TypeScript brings to the table.

Additional I wanted to be able to use CATS to develop CATS without habing to use the normal Qooxdoo tooling set (generate.py stuff)

Although not reach a final decision yet, the first few attempts look promising.

License

This application uses much of Qooxdoo and for those part the same license applies as Qooxdoo. So either LGPL or EPL. See also qooxdoo.org for more details.

For the remaining part the Apache License is applicable (mainly the qooxdoo.d.ts file).

About

Using Qooxdoo within TypeScript

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 51.1%
  • TypeScript 48.9%