UI-Kit is 2 things:
assets/
) that you can include in your project:Link to precompiled minified files
<link rel="stylesheet" type="text/css" href="https://gov-au-ui-kit.apps.staging.digital.gov.au/latest/ui-kit.min.css"/>
<script type="text/javascript" src="https://gov-au-ui-kit.apps.staging.digital.gov.au/latest/ui-kit.min.js"></script>
GOV.AU UI-Kit is currently in early draft release. You can help us build it by contributing.
The /docs/ folder contains draft documentation on experimental work. For example, how to install UI-Kit for use with webpack
.
input
, label
, etc).For a full list of features see the CHANGELOG.
The framework is built on a solid accessible HTML foundation. We follow a philosophy of progressive enhancement over graceful degradation to produce accessible components by default.
UI Kit aims to be WCAG2 AA compliant, and AAA where possible.
We use automated testing:
We are working on:
Read cross browser and device support table.
The kit uses a conditional styling mixin for specific versions of IE. Use this when extending the kit.
We are working on:
This is not yet a complete design or design system. This is the starting point that will develop with your help.
Teams building Australian Government sites. This was designed for GOV.AU teams, but we welcome use outside of federal government.
The Digital Service Standard requires teams to build services using common design patterns. This is draft work on the framework and guidance that will eventually become the design patterns for digital content.
You should use this with the draft Content Style Guide for Digital Transformation Office projects.
We have a build process for the development of the framework which uses gulp on node.js.
To build it yourself, begin by installing the system dependencies:
Install node package dependencies:
npm install
Run a build:
npm run-script build
Run a build with livereloading:
npm start
Run accessibility tests:
npm test
Note: Check Pa11y's requirements to make sure you have the necessary dependencies installed to run the automated accessibility tests.
The compiled style guide can be found at ./build/index.html
and the UI Kit CSS
at ./build/latest/ui-kit.css
.
We have automated the build, with a few additions:
sass-lint
for lintingcssnano
for CSS compressionautoprefixer
for adding CSS vendor prefixesAusDTO/gulp-html
for HTML validationkss
for auto-building a living style guideOur CI build is available as a shell script at bin/cibuild.sh
.
We use Bourbon 4.2.7. We include its .scss
files directly rather than calling it via its node (or gem) package. Bourbon and Neat live under /assets/sass/vendor
.
Some of the key libraries we use are:
gulp ^3.9.1
gulp-sass ^2.3.1
kss ^3.0.0-beta.14
sass-lint ^1.7.0
^
= compatible with version (see semver).
#guides-uikit
.This framework is in active development.
Goal: build a lean and frugal CSS/SCSS framework to make building GOV.AU easier. It should:
See RELEASING.md and CHANGELOG.md.
We aim to provide stable, usable releases at the end of each sprint.
We are wary about breaking changes. We will work to ensure we will gracefully deprecate any changes that cause things to break.
We may create an installer wrapper (likely node-based), or release via git submodules.
© Copyright Commonwealth of Australia.
With the exception of the Commonwealth Coat of Arms and where otherwise noted, this work is licensed under the MIT license.
This repository includes Bourbon, Neat and Normalize.css. All also use the MIT license.
GOV.AU UI-Kit is maintained and funded by the Digital Transformation Agency.