Getting Started

This page is an overview of the Feathers UI documentation and related resources. Feathers UI is a cross-platform framework of UI components for creative frontend projects.

Introduction

Learn how to download Feathers UI and how to create your first project.

• Install Feathers UI, along with all of its required dependencies.
• Create a new project in the following environments:
  • Terminal / Command Line
  • Visual Studio Code
  • HaxeDevelop
  • Moonshine IDE

Basic Concepts

Get familiar with UI components, layouts, working with data, styling, and more.

• UI components
• Layouts and containers
• Data collections
• Styles and skins
• Themes

If you're not yet familiar with the Haxe programming language, the the OpenFL library, the following resources are available.

• Introduction to Haxe
• Introduction to OpenFL

Advanced Concepts

Dive deeper into the Feathers UI architecture.

• Custom UI components
• Create a new theme

API Reference

This documentation section is useful when you want to learn more details about a particular Feathers UI class, property, or method. For example, feathers.controls.Button API reference can provide you with details about all properties, styles, and events that are available on a Button component.

• Feathers UI API Reference

Sample projects

A variety of examples are available to show you how to integrate the various pieces of the Feathers UI framework into your application.

• Feathers UI Sample Projects

Staying Informed

The Feathers UI blog is the official source for all announcements and updates about Feathers UI.

You can also follow Feathers UI on social media to keep track of the latest updates, and maybe some fun extras.

• @feathersui@fosstodon.org on Mastodon

If you want to dive into the nitty-gritty details of every feature and bug fix in the newest release (and all past releases), check out the CHANGELOG.md file on GitHub.

Finally, if you're curious about what's planned for the next release, check out the Feathers UI Roadmap.

Need extra, in-depth help?

Gain full access to the core Feathers UI framework developers — including priority email access and VIP forum/chat sections — by purchasing a Premium Support contract. As a bonus, you may be able to add your logo as an official sponsor on the Feathers UI website.

Anything missing?

If something is missing in the documentation, or if you found some part particularly confusing, please open an issue on the feathersui-website repository, or drop a message to @feathersui on Mastodon.