- Notifications
You must be signed in to change notification settings - Fork8
CSS Implementation of USDA's FPAC Design System
License
USDA-FSA/fsa-style
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
USDA FPAC'sVisual Language andHTML/CSS Framework, as documented by theFPAC Design System.
The Design System comprises of two core repositories:
- fsa-design-system: Source code for theDesign System web site, documenting the FSA Style and accompanying guidelines.
- fsa-style: Style assets (HTML, CSS, Images) available for download or install, as documented by theDesign System web site.
The components and style guide of the Design System follow industry-standard web accessibility guidelines and use the best practices of existing style libraries and modern web design. They are designed for use by FPAC product teams who want to create beautiful, easy-to-use, online experiences that are consistent to the FSA Style.
It was created and maintained within FPAC's ISSDOB/FBCSS division, and was initially influenced by thev1.x.x versionU.S. Web Design System created and maintained by the wonderful folks at18F.
Information about the most recent release can always be found in therelease history. We include details about significant updates and any backwards incompatible changes along with a list of all changes.
Two options are available for usage of fsa-style HTML, CSS, Images, and Web Fonts:
If you havenode installed on your machine, you can use npm to install the Standards. Addfsa-styleto your project’spackage.json as a dependency:
npm install --save fsa-style
The package will be installed innode_modules/fsa-style. You can either use the un-compiled filesfound in thesrc/ or the compiled files in thedist/ directory. For example, if you're interested in using the Sass files (.scss) you would use thesrc/ directory; otherwise,dist/ is what you want.
node_modules/fsa-style/├── dist/│ ├── css/│ ├── fonts/│ ├── img/│ ├── js/│ ├── boilerplate.html│ └── index.html└── src/ ├── fonts/ ├── img/ ├── js/ ├── stylesheets/ ├── boilerplate.html └── index.htmlThe main Sass (SCSS) source file is here:
node_modules/fsa-style/src/stylesheets/fsa-style.scssThe compiled and minified CSS files' location:
node_modules/fsa-style/dist/css/fsa-style.cssnode_modules/fsa-style/dist/css/fsa-style.min.cssLastly, refer toUsing the Boilerplate for basic guidance on HTML structure.
If you don't have Node or the ability to incorporate source files into a build process (Grunt, Gulp, Webpack, etc), follow these steps to manually use the FSA Style.
Download the latest assets:https://github.com/usda-fsa/fsa-style/releases/download/2.6.0/fsa-style-2.6.0.zip
index.html is a Visual Index of this CSS Framework's Visual Language, including basic HTML elements expressed in that style. Viewable athttp://usda-fsa.github.io/fsa-style/index.html.
boilerplate.html provides a non-designed starting point. It serves as general guidance for the HTML structure most typically required of an FPAC digital product. Viewable athttp://usda-fsa.github.io/fsa-style/boilerplate.html.
Add the downloaded ZIP's assets to a relevant place in your code base — likely a directory where you keep third-party libraries:
fsa-style-x.x.x/├── css/│ ├── fsa-style.css│ ├── fsa-style.css.map│ ├── fsa-style.min.css│ └── fsa-style.min.css.map├── fonts/├── img/└── js/ └── vendor/
Note thatfonts andimg must be alongsidecss as the CSS files reference them at a specific relative path; e.g.,../img/file.png
Refer toUsing the Boilerplate for further steps.
http://usda-fsa.github.io/fsa-style/boilerplate.html
Reference this basic list for the general requirements for your typical HTML structure. Reviewing this list is perhaps best done while viewing itsHTML source.
- HTML5 doctype:
<!DOCTYPE html>. - Wrap
<html>start element in IE conditional comment. - Enable Responsive Web Design via
<meta name="viewport" content="width=device-width, initial-scale=1">. - Reference CSS file(s) via
<link>tag. - Reference IE conditional commented JS files to polyfill features below IE9.
- Include IE conditional commented Browser Upgrade message.
- Include "skipnav" anchor link, with
hrefattribute pointing to<main>element. - Wrap primary contents with
<main>...</main>. - Build your thing!
For complete instructions on how to contribute code, please readCONTRIBUTING.md.
If you have questions or concerns about our contributing workflow, please contact us byfiling a GitHub issue.
This Design System was initially based on theDraft U.S. Web Design Standards created and maintained by theU.S. Digital Service and18F designers and developers.
The Draft U.S. Web Design Standards are designed for use by government product teams who want to create beautiful, easy-to-use online experiences for the public. To learn more about the project, check outtheir blog post.
Further Design System sources of inspiration - some government-oriented, some not.
- UK’s Government Digital Service’sUI Elements
- Consumer Financial Protection Bureau’sDesign Manual
- U.S. Patent and Trademark Office’sDesign Patterns
- Healthcare.govStyle Guide
- Vets.govPlaybook: Design
- SalesForce -Lightning Design System
- MailChimp -Patterns
- Code for America -Website Style Guide
- Google -Material Design
About
CSS Implementation of USDA's FPAC Design System
Topics
Resources
License
Contributing
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors5
Uh oh!
There was an error while loading.Please reload this page.