Capital Framework

⚠️ Heads up: In an effort to unify our design resources, we will disable this repo and migrate Capital Framework's code to cfpb/design-system in Summer 2019. Until the migration occurs, please continue to use this repo.

The Consumer Financial Protection Bureau's user interface framework.

atomic-component	buttons	core	expandables	forms	grid

icons	layout	notifications	pagination	tables	typography

Installation

npm install capital-framework

Components can also be installed individually:

npm install cf-buttons
npm install cf-expandables

Project scaffolding

Want some boilerplate? There is a Yeoman generator through the generator-cf project:

npm install -g yo generator-cf
mkdir my-new-project && cd $_
yo cf

Using Less files directly

If you don't want to use the generator-cf Yeoman generator, you can download the Capital Framework source files and import them into your project.

Run npm install capital-framework. This will download Capital Framework to your project's node_modules folder. You can then import the framework into your application's primary Less file:

@import (less) "node_modules/capital-framework/src/capital-framework.less";

// the rest of your stylesheet...

You may want to install individual Capital Framework Components, so that you can leave out things you don't need, or to make it possible to update the components one-at-a-time in the future.