Installation

We recommend using npm to install the Design System and compiling the CSS from the source. This is because:

• npm makes it easier for you to stay up to date with any additions or bug fixes
• there are some easy component customisation options available to you if you compile the CSS yourself

What you need to do

1. Install Node.js.

   We recommend using the latest Long Term Support (LTS) version, or a minimum of version 8.10.0.

2. If your project does not already have a package.json file, create one by running this command from your project’s root folder:

   npm init

3. Install a SASS compiler. We recommend installing Dart Sass into your project.

   npm install sass --save-dev

   Dart Sass will give warnings when compiling CSS because of a breaking change to how Sass will handle division in the future. You can avoid these warnings by using an older version of Dart Sass.

   npm install sass@1.32.12 --save-dev

4. Install the Design System with this command:

   npm install @scottish-government/pattern-library --save-dev

   You’ll now have a copy of the Design System’s source code in your project’s node_modules folder.

Using the Design System

CSS and Sass

A precompiled CSS file containing the styles used by the Design System is included in the Design System’s npm package at /dist/styles/main.css.

The Design System’s components are also provided as SCSS files. See the documentation about CSS and Sass for more information about how to work with the Design System's SCSS.

JavaScript

A precompiled JavaScript file containing all of the scripts for Design System components is provided in the Design System’s npm package at /dist/scripts/pattern-library.js.

See the documentation about JavaScript for more information about how to use the Design System's JavaScript in your projects.