feathersui / feathersui-openfl-js

Wrapper that allows JavaScript developers to use Feathers UI for OpenFL

Feathers UI (npm version) 1.3.0

Feathers UI is a framework of graphical user interface (GUI) components for creative, cross-platform, frontend projects. It is especially well-suited for games, interactive data visualizations, and other rich, multimedia experiences.

⚠️ This version of Feathers UI is intended for JavaScript developers. It's not as actively tested as the Haxe version of the same library, and some bugs should be expected.

Get started

The following instructions describe how to use Feathers UI with JavaScript.

Installation (npm)

Open a terminal, and then install Feathers UI using the following command:

npm install feathersui-openfl

This command will also automatically install any additional required dependencies, like OpenFL and Actuate, if necessary.

Installation (CDN)

Alternatively, Feathers UI may be added to any HTML file using a few <script> tags:

<script src="https://unpkg.com/[email protected]/dist/openfl.min.js"></script>
<script src="https://unpkg.com/[email protected]/dist/actuate.min.js"></script>
<script src="https://unpkg.com/[email protected]/dist/feathersui-openfl.min.js"></script>

Choose an editor or IDE

Visual Studio Code is recommended, but any editor or IDE that supports JavaScript should work with Feathers UI.

Sample code

class HelloWorld extends feathers.controls.Application {
  constructor() {
    super();

    this.layout = new feathers.layout.AnchorLayout();

    this.button = new feathers.controls.Button();
    this.button.layoutData = feathers.layout.AnchorLayoutData.center();
    this.button.text = "Click Me";
    this.button.addEventListener(
      feathers.events.TriggerEvent.TRIGGER,
      this.button_triggerHandler
    );
    this.addChild(this.button);
  }

  button_triggerHandler = (event) => {
    feathers.controls.TextCallout.show("Hello World", this.button);
  };
}

var stage = new openfl.display.Stage(0, 0, null, null, {
  allowHighDPI: true,
});
document.body.appendChild(stage.element);
stage.addChild(new HelloWorld());

Help & Support

• Documentation
• Community Forum
• Discord Chat
• Stack Overflow

News & Updates

• Blog
• Twitter

feathersui-openfl-js's Issues

Any plans to generate TypeScript types definitions?

I love Feathers since early Starling versions. Using openfl haxe version for some pet-projects.
Currently looking forward to do some frontend stuff with TypeScript and it would be cool if there is a TS version of Feathers (I see, that there is a repo with JS version)