Draft U.S. Web Design Standards

The Draft U.S. Web Design Standards is a library of open source UI components and a visual style guide for U.S. federal government websites.

These tools follow industry-standard web accessibility guidelines and reuse the best practices of existing style libraries and modern web design. Created and maintained by U.S. Digital Service and 18F designers and developers, the Draft Web Design Standards are designed to support government product teams in creating beautiful and easy-to-use online experiences for the American people. Learn more about this project in our announcement blog post.

Design files of all the assets included on this site are available for download here: https://github.com/18F/web-design-standards-assets.

The structural setup of this repo is based off of https://github.com/18F/pages.

Reuse of open source style guides

Much of the guidance in Draft Web Design Standards leans on open source designs, code, and patterns from other civic and government organizations, including:

Consumer Financial Protection Bureau’s Design Manual
U.S. Patent and Trademark Office’s Design Patterns
Healthcare.gov Style Guide
UK’s Government Digital Service’s UI Elements
Code for America’s Chime Styleguide
Pivotal Labs Component Library

Getting started

To begin using the Draft Web Design Standards, include the CSS and JavaScript files in each HTML page in your project. Download the the Draft Web Design Standards assets: https://playbook.cio.gov/designstandards/assets/releases/wds-v0.9.0.zip. Add the assets directory to a relevant place in your code base.

Refer to these files by adding a <link> and a <script> element into your HTML pages:

<link rel="stylesheet" href="/path/to/your/assets/css/main.css">
<link rel="stylesheet" href="/path/to/your/assets/css/google-fonts.css">
<script src="/path/to/your/assets/js/components.js"></script>

Install with NPM

If you have node installed on your machine, you can use npm to install the Web Design Standards. In your package.json list the following under dependencies:

  "uswds": "git@github.com:18F/web-design-standards.git#v0.9.0"

On subsequent runs of npm install, the package will be installed in node_modules under uswds. The CSS will be not compiled after it is installed. Instead, you are able to compile it however it fits into your project.

An npm task called build-sass is supplied, though you are not required to use it, that will compile the Sass to a CSS file named uswds.css (in node_modules/uswds/assets/css/uswds.css).

If you simply want to compile the Sass you could do something like:

cd node_modules/uswds && npm run build-sass

Note: You might get an npm warning related to lodash, but you can generally ignore it.

Setup for your local environment

Requirements

You will need Ruby ( > version 2.2.3 ). You may consider using a Ruby version manager such as rbenv or rvm to help ensure that Ruby version upgrades don't mean all your gems will need to be rebuilt.

On OS X, you can also use Homebrew to install Ruby in /usr/local/bin, which may require you to update your $PATH environment variable. Here are the commands to follow to install via homebrew:

$ brew update
$ brew install ruby

Installation

Now that you have verified that you have Ruby installed, clone and run the following go script commands to initialize and serve the library locally.

$ git clone git@github.com:18F/web-design-standards.git
$ cd web-design-standards
$ ./go serve

You should now be able to visit http://127.0.0.1:4000/ and view the draft web design standards locally.

Questions or need help with setup? Feel free to open an issue here https://github.com/18F/web-design-standards/issues.

Contributing to the code base

See CONTRIBUTING.

Deployment and workflow

The staging branch 18f-pages-staging is automatically deployed to our staging site: https://pages-staging.18f.gov/designstandards/.
The production branch 18f-pages is automatically deployed to our production site: https://playbook.cio.gov/designstandards/.

All development and pull requests should be done against the 18f-pages-staging branch.

18f-pages-staging is already set to the default branch in this repository.

Deployments to production will be done by site admins, using pull requests from 18f-pages-staging to 18f-pages.

Got feedback?

Please create a GitHub Issue.

If you'd rather email, you can reach us at uswebdesignstandards@gsa.gov.

Licenses and attribution

A few parts of this project are not in the public domain

The Source Sans Pro font files in assets/fonts are a customized subset of Source Sans Pro, licensed under the SIL Open Font License, and copyright Adobe Systems Incorporated, with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries.

The Merriweather font files in assets/fonts are from Google Web Fonts, licensed under the SIL Open Font License, and copyright Sorkin Type Co with Reserved Font Name 'Merriweather'.

The files in assets/img are from Font Awesome by Dave Gandy under the SIL Open Font License 1.1.

The files in assets/_scss/lib/bourbon are from Bourbon, copyright thoughtbot, inc., under the MIT license.

The files in assets/_scss/lib/neat are from Neat, copyright thoughtbot, inc., also under the MIT license.

The file assets/css/normalize.min.css is from Normalize.css, copyright Nicolas Gallagher and Jonathan Neal, under the MIT license.

The file assets/js/component.js includes politespace.js from Politespace, copyright Zach Leatherman, under the MIT license.

The file assets/js/vendor/html5shiv.js is from HTML5 Shiv, copyright Alexander Farkas (aFarkas), under the MIT license.

The file assets/js/vendor/jquery-1.11.3.min.js is from jQuery, copyright The jQuery Foundation, under the MIT license.

The file assets/js/vendor/rem.min.js is from REM unit polyfill, copyright Chuck Carpenter, under the MIT license.

The file assets/js/vendor/respond.js is from Respond.js, copyright Scott Jehl, under the MIT license.

The file assets/js/vendor/selectivisr-min.js is from Selectivizr, copyright Keith Clark, under the MIT license.

The files assets-styleguide/js/vendor/prism.js and assets-styleguide/css/prism.css are from Prism, copyright Lea Verou, under the MIT license.

The rest of this project is in the public domain

The rest of this project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.

Twintails/web-design-standards