Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update "wells" page #1787

Merged
merged 1 commit into from
Oct 18, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 28 additions & 21 deletions docs/pages/wells.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,25 @@
---
layout: variation
section: patterns
status: Released
variation_groups:
- variations:
- variation_code_snippet: >-
<div class="o-well">
<p class="h4">Well title</p>
<p class="h4">Heading</p>
<p>
Lorem ipsum dolor sit amet, ei ius adhuc inani iudico, labitur
instructior ex pri. Cu pri inani constituto, cum aeque noster commodo
cu. <a href="#">Example link</a>.
</p>

<ul class="m-list m-list__links">
<li class="m-list_item">
<a class="m-list_link" href="#">Call-to-action link</a>
</li>
</ul>

</div>
variation_description: ''
variation_name: Standard well
variation_description: ""
variation_name: Well
variation_specs: >-
* Padding at breakpoints 601+: 30 (top), 30 (right) 60 (bottom), 30
(left)
Expand Down Expand Up @@ -45,17 +50,25 @@ variation_groups:
cu. <a href="#">Example link</a>.
</p>
</div>
variation_description:
The inkwell was originally developed for use on the
variation_description: The inkwell was originally developed for use on the
cf.gov home page, but was not implemented.
variation_name: Inkwell
variation_is_deprecated: true
variation_group_name: Wells
variation_group_name: Types
use_cases: >-
Grey wells should be used to feature content or specific calls to action.
They will help visually set apart the content within it, so use sparingly to
draw attention to that content.


Ideally, content within a well should not take up more than a third of page content.
guidelines: >-
Wells should generally be text-based. If content must include imagery or
videos, use the [featured content
module](/design-system/patterns/featured-content-module) instead. Examples of
types of content to include:
module](/design-system/patterns/featured-content-module) instead.


Examples of types of content to include:


* Headings (H2 - H5). Headings should be as succinct as possible and 35 characters or less (including spaces)
Expand All @@ -64,7 +77,11 @@ guidelines: >-

* Links
eyebrow: Featured content
accessibility: ""
related_items: "* [Featured content module](/design-system/patterns/featured-content-module)"
last_updated: 2019-10-21T20:38:39.851Z
title: Wells
status: Released
description: Wells are used to highlight specific information within a
designated section of a page. This breaks up the flow of content on the page
and helps to emphasize and set apart the content that is included. They are
Expand All @@ -73,13 +90,6 @@ description: Wells are used to highlight specific information within a
[learn](https://cfpb.github.io/design-system/pages/learn-pages), and [document
detail
pages](https://cfpb.github.io/design-system/pages/document-detail-pages).
use_cases: >-
Grey wells should be used to feature content or specific calls to action.
They will help visually set apart the content within it, so use sparingly to
draw attention to that content.


Ideally, content within a well should not take up more than a third of page content.
behavior: >-
Wells are full width. Note that at breakpoints 600 and under there are slight
padding adjustments to maximize real estate on smaller displays.
Expand All @@ -90,8 +100,5 @@ behavior: >-
| -- | -- | -- |

| ![](/design-system/images/uploads/wells_behavior_mockup_1.png) | ![](/design-system/images/uploads/wells_behavior_mockup_2.png) | ![](/design-system/images/uploads/wells_behavior_mockup_3.png) |
accessibility: ''
related_items: '* [Featured content module](/design-system/patterns/featured-content-module)'
last_updated: 2019-10-21T20:38:39.851Z
research: ''
research: ""
---
Loading