The main dependency of this library is jQuery (version 2 and above) - you have to install it independently.
To get started with AUI, there are only 2 simple steps:
- Choose a deployment option
- Start using AUI's components
Choose a deployment option
Depending on the version of AUI, there will be a number of options for how you can consume the AUI library.
Here are a few of the options available to you:
- Install as a Node package
- Install as an Atlassian plugin
- Download a distribution
- Consume through a CDN
Install as a Node package
AUI is released to npmjs.com.
Install it through your favourite package manager:
npm install @atlassian/aui
yarn add @atlassian/aui
In the Node package, you will find:
Install as an Atlassian plugin
AUI can be used as an Atlassian P2 plugin.
This plugin requires the following technologies to be available in the runtime it is installed in to:
- Web Resource Manager (aka the WRM) version 3.6.0 or higher
- Spring Scanner version 2 or higher
All Atlassian Server products come with AUI pre-installed, so you don't need to do much to re-use it in your plugin.
Each AUI component has a
web-resource key you can include it by. Consult each component's documentation
on the AUI website for the key.
Download a distribution
AUI distributions are released as a zip file called the
hosted through Atlassian's Maven nexus.
Note that this is equivalent to the
dist/ folder available in the Node package.
Consume through a CDN
Use of AUI is not officially supported through a Content Delivery Network (CDN).
However, because AUI is published to npmjs.com, the AUI distributions are also published through some public CDN services such as:
Once you've included AUI in to your project, check out AUI's documentation to learn about how to use the AUI components.
If you have any questions or run in to troubles using AUI, ask a question in our developer community.