gh-action-test v2.4.5
NSW Design System
NSW Design system is a collection of reusable UI components used on the NSW government websites.
See live examples of NSW Digital Design system components and guidance on how to use them on you website at NSW Design System.
Using the design system
How you use the NSW Design System depends on your team's capabilities. We recommend using npm but also provided in a CDN, and a downloadable starter kit which includes all the compiled assets.
Installing with NPM
npm is a package manager for Node-based projects. We recommend npm packages because it makes it easy to update and install the design system from the command line.
1. Install Node/npm.
- More information can be found via the nodejs [Installation guides](https://nodejs.org/en/download/)Generate a
package.jsonfile using thenpm initcommand in the terminal. You will be prompted to enter several pieces of information, like the name of your application, version, description etc.Add
nsw-design-systemto your project’spackage.json:npm install --save nsw-design-system
The NSW Design System is now installed as a dependancy of your project, check out how to import styles and javascript in to your project build.
Importing styles into your project
The NSW Design System styles need to be added to the main Sass file in your project.
Use the below snippet to import the NSW Design System (ideally placed before any other imports or sass):
@import 'node_modules/nsw-design-system/src/main';Adding the font
In your main html document add this line of code inside the <head> tag
<link href="https://fonts.googleapis.com/css?family=Montserrat:400,600&display=swap" rel="stylesheet">Using the icons
The design system icons use sprite SVG, add this line of code inside the <head> tag in your main html document
<script>
// SVG Sprite Loader
var svgAjax = new XMLHttpRequest();
svgAjax.open("GET", "https://cdn.jsdelivr.net/npm/nsw-design-system/dist/assets/svg/sprite.svg", true);
svgAjax.send();
svgAjax.onload = function(e) {
var fragment = document.createRange().createContextualFragment(svgAjax.responseText);
var svg = fragment.querySelector('svg')
svg.setAttribute('aria-hidden', true);
svg.style.cssText = 'position: absolute; width: 0; height: 0; overflow: hidden;'
document.body.insertBefore(fragment, document.body.childNodes[0]);
};
</script>Importing javascript into your project
Some of the NSW Design System components require javascript to provide advanced functionality. To ensure the page is ready for javascript to run, include the follow scripts tags at the end of the html document.
<script src="node_modules/nsw-design-system/src/main.js"></script>
<script>window.NSW.initSite()</script>
</body>
</html>Depending on your project set up, you might wish to copy the file into your project from node_modules or add the reference to your build workflow.
Using JSDelivr CDN
The bundled css and js files are also hosted in JSDelivr.
You can add the files to your main html document
<html>
<head>
...
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/nsw-design-system@2/dist/css/main.css">
</head>
<body>
...
<script src="https://cdn.jsdelivr.net/npm/nsw-design-system@2/dist/js/main.min.js"></script>
<script>window.NSW.initSite()</script>
</body>
</html>Download starter kit
You can download the compiled design system assets (HTML, CSS, JavaScript) in the HTMLStarterkit zip file from the latest release.
Getting updates
To be notified when there’s a new release, you can either join the NSW Design System community or watch the NSW Design System Github