aui /

Filename Size Date modified Message
build
docs
integration
licenses
playbook
src
tests
75 B
[AUI-4050] Remove packages that are avialable through AUI dependency
49 B
AUI-4420: Get rid of the Bower
166 B
Sync dotfiles with aui repo.
169 B
chore: update linted directories.
1.6 KB
chore: most of the codebase follows 1tbs; let's not kid ourselves.
12 B
Introduce end-of-line normalisation
373 B
chore: ignore folders that have future relevance.
20 B
AUI-3972 Make aui-adg depend on aui via npm to fix its UMD distribution.
11 B
AUI-4420: Get rid of the Bower
82 B
AUI-4420, AUI-4437 - Migrate to using Yarn for mostly everything. Always resolve pacakges from the public registry.
6.0 KB
chore(build): Update the documentation and build scripts to elicit and test environment requirements before scripts run.
367 B
AUI-4866 - Bump docker image. Parallelise bitbucket pipelines tests.
25.5 KB
AUI-4434 - The next version of AUI is released under the Atlassian Developer Terms license.
2.9 KB
AUI-1888: Make AUI plugin transformless
568 B
AUI-4866 - Bump docker image. Parallelise bitbucket pipelines tests.
56.9 KB
fix: reverted options disabling minification in P2 plugin build
748 B
refactor: use multi-line YAML strings in docker-compose commands
56 B
chore: fix the eslintrc files' scoping of environment and globals.
18 B
5.7.x seems to require mvn 3.0.5.
5.9 KB
Merge remote-tracking branch 'origin/7.9.x'
294.6 KB
refactor: inject AUI's version via gulp and webpack only.

AUI - Atlassian UI

A set of components for building user interfaces in Atlassian products and services.

Documentation

Thorough documentation is available at the AUI website.

Compatibility

Caveats

  • Chrome latest stable
  • Firefox latest stable
  • Safari latest stable (on OS X only)
  • IE 11+

How do you get it?

Consuming the AUI library is supported through a few methods:

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:

  • dist/ contains pre-compiled javascript and css. This is the simplest way to use AUI.

  • lib/ contains individual AUI components. Use a CommonJS or AMD loader to load each component as your application needs.

  • src/ contains the raw JavaScript and LESS sources. It's unlikely you'll require these directly.

Install as an Atlassian plugin

AUI can be used as an Atlassian P2 plugin. This plugin requires Spring Scanner 2 to be available in the runtime it is installed in.

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 the distribution

AUI distributions are released as a zip file called the aui-flat-pack, 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:

Raising issues

Raise bugs or feature requests in the AUI project.

License

AUI is an Atlassian Developer Asset and is released under the Atlassian Developer Terms license. Some assets are released under the Atlassian Design Guidelines (ADG) license. See the licenses directory for information about AUI, ADG, and included libraries.