For page components section

Use the following as a guideline for creating the sub-sections on a design manual page.

  • All sub-headers within the pages should be coded as jump/anchor links, to allow for easy deep linking from other design manual pages.
  • Only include sections/sub-sections that pertain to the specific item you are defining.
  • This structure may not align with every single item; use your discretion to add different sections as necessary to convey the needed design information.

Structure

Title (h1)

Definition

A brief (2-3 sentence) description of what the item is and generally what it is used for.

Use case(s) (h2)

Explain why and when that element should and should not be used.

  • Include default/most common use cases
  • Include variations on use cases, if applicable
  • If the element should only be used in a few specific circumstances, simply explain the acceptable use cases rather than detail the instances where it should not be used (the majority)
  • Include examples, where possible
  • Include an image of the default version

Behavior (h2)

Explain the details of any interactions involved with that item.

  • Creating accessible behaviors—sub-section dedicated to development and design considerations in order to make those behaviors 508 compliant and accessible
  • Small-screen behavior—include a sub-section (if necessary) that details any behaviors that are different on a smaller screen

  • Responsive—describe component behavior as it scales to smaller screens (i.e., how content stacks, in what order it should appear, etc.)

Content guidelines (h2)

Guidance for creating content associated with that component, including instructions around content goals, best practices around writing headlines/links (if applicable) and approximate length/word count maximums

Style (h2)

Create different sub-sections for defaults and variations on style, include different states for each as needed (onstate, hover state, etc.). If the component is comprised of several different areas, break out the styles for each area separately to make it easier to digest.

  • Small-screen style—include a sub-section (if necessary) that details any styles that are different on a smaller screen

Styles should be as detailed as necessary to create the component, including things like font, color, padding, etc. Per FEWD preference, put them in alpha order. If dynamic content has been defined for a property such as color, use the appropriate data file or include file to reference the property.

For example:

  • Alignment: centered horizontally and vertically on top of lightbox
  • Background: White #ffffff
  • Background lightbox: Gray-80 #75787b, 70% opacity
  • Color: Black #101820
  • Font: Avenir Next Regular
  • Padding: 30px
  • Text size body: 16px
  • Text size header: 22px
  • Top border: 3px CFPB Green #20aa3f

Include an example of the style (preferably a coded example, or if not, an image)

Code (h2)

Include live coded examples from Capital Framework as available, and links to resources to learn more about the live components

Include any print-specific styles or guidelines when necessary

Imagery

  • Include an image with use case to show a default example of the component
  • When possible, use a live coded example in place of an image
  • Image width should be no more than 50% of content area