scottmccaughey/usitc-ds

USITC Design System — resources, tooling and guidelines for building websites with USITC’s front-end framework.

USITC Design System

Resources, tooling and guidelines for building websites with USITC’s front-end framework.

Introduction

Our goal is to create a system that enables us to build consistent user experiences with ease, yet with enough flexibility to support the needs of USITC’s different websites and applications. This goal is embedded in our design and code decisions.

This style guide is living documentation that will be updated as we continue to improve and evolve our design system.

Using the USITC Design System

The USITC Design System is distributed via npm. As the design system grows, it may be split into individual npm packages, but at the present time you’ll need to add the entire system to your project.

After installing npm, you can install the USITC Design System with this command:

npm install --save @usitc/usitc-ds

SCSS

The style source files included are written in Sass (scss).

To use the Sass files, you can point your Sass include-path at your node_modules directory and import it like this:

@import '@usitc/usitc-ds/src/compiled-assets/scss/styles';

This will allow you to take advantage of the Sass functions and variables generated from our design tokens, and use them to write your own styles using our color system, spacing scale, etc.

You can also import specific portions of the code by importing those partials from the usitc-ds/src/compiled-assets/scss folder and its subfolders. Make sure you import any requirements along with these.

CSS

To use the compiled CSS, you can add this line to your HTML:

<link rel='stylesheet' href='/node_modules/@usitc/usitc-ds/src/compiled-assets/css/styles.css'>

---

This project was generated with Angular CLI version 6.0.8.

Development server

Run npm start for a dev server. Navigate to http://localhost:4300/. The app will automatically reload if you change any of the source files.