Welcome to Ubuntu HTML5 API Docs version 0.1
These pages provide reference docs for the Ubunbtu HTML5 framework.
Ubuntu HTML5 widgets
The Ubuntun HTML5 framework provides a set of "widgets" you use to build an application in the Ubuntu style (see design.ubuntu.com for descriptions of Ubuntu app "building blocks" with links to APIs for each supported implementation toolkit). For example, an Ubuntu HTML5 app has a dynamic Header with Tabs that together provide navigation through the app's Pages. Pages may contain Lists, Popovers, Buttons, Shapes, and a lot more. The app has a Footer (also called a Toolbar) to which you can add Buttons. There are many options and the list keeps growing!
What you need to know
To write Ubuntu HTML5 apps, you need to know:
- How to declare each widget type in HTML
- How to initialize the Ubuntu HTML5 framework at app load time
These topics are introduced here and explained in the class documentation.
Elements and special attributes
Many of these classes/objects have additional methods. For example, the List class provides methods to add items to the list, remove an item, apply a function to all items, and more.
How these docs are organized
The single most important class is UbuntuUI, so start there.
Then, an Ubuntu HTML5 app is structured as a PageStack of Pages, so be sure to visit those classes.
Ubuntu HTML5 CSS
Be sure to check out the Ubuntu HTML5 CSS files you import into your app. They provide a set of styles that theme the HTML5 widgets to the Ubuntu app design and style.
Let's grow this!
Let's work together to keep HTML5 as a top-notch app development framework on Ubuntu. Everyone can help by filing bugs, triaging them, and of course, fixing them. So let's get to work writing apps!