Getting started

Welcome to the Atlassian User Interface library.

Follow these steps to get up and running with AUI's library:

  1. Include AUI in your page. There are several ways of doing it.
    1. Serve from CDN
    2. Download the static files.

Serving AUI from CDN

AUI provides a CDN, which will make your pages load faster and resources won't be out of date. In order to serve AUI's resources from the CDN, you will need to include them in the HEAD of your HTML or template file, such as in the example below.

Serving specific files from CDN

Alternatively, to reduce the page weight, you might pull only the files you need:

AUI Core

Simply include the core CSS and JS files. Note that AUI depends on jQuery 1.7.2 or 1.8.3 being on the page - alter the below jQuery script as required.

Additional components

Datepicker:

Javascript Soy templates:

Experimental components

Previously, some Experimental components required an AMD loader to be present on the page before the Experimental resource was included. As of AUI 5.9, this is no longer required as most components are exposed on the global AJS object and markup-initialized components do not need to have their modules loaded with AMD. However, an AMD loader may still be used to obtain a reference to the component's JavaScript export (often a constructor).

Downloading and using AUI

  1. Download this zip.

    The zip file contains both core/stable components from AUI, plus some components with experimental APIs (in separate resources).

  2. Once you've downloaded the file and If you want everything, including AUI's dependencies, experimental features and compiled-JS Soy templates, add the following code to the HEAD of your templates or page:

  3. Update the path to point to the location of your copy.

Check out AUI's documentation to learn more about Atlassian User Interface components!