Skip to content

Commit

Permalink
Merge pull request #2376 from department-of-veterans-affairs/featured…
Browse files Browse the repository at this point in the history
…-content-2306

Updates feature content guidance to be v3. [Fixes #2306]
  • Loading branch information
humancompanion-usds authored Jan 9, 2024
2 parents 65f443c + dac5e3e commit bebcf8d
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions src/_components/featured-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@ title: "Featured content"
status: use-deployed
intro-text: "The featured content component helps Veterans quickly identify must-read information on a page. Use this component to highlight a small chunk of the most important information on a page, like eligibility criteria or coverage under a particular VA benefit."
sketch-link: https://www.sketch.com/s/610156b6-f281-4497-81f3-64454fc72156/p/5D59FDA9-A9F3-492C-AF41-F48CF5117F04
uswds-v3: default
aka: Summary box
anchors:
- anchor: Examples
- anchor: Examples - v1
- anchor: Examples - v3
- anchor: Usage
- anchor: Variations
- anchor: Code usage
Expand All @@ -14,12 +17,24 @@ anchors:
web-component: va-featured-content
---

## Examples
## Examples - v1

### Default

{% include storybook-preview.html height="250px" story="components-va-featured-content--default" link_text="va-featured-content" %}

## Examples - v3

### Default

{% include storybook-preview.html height="250px" story="uswds-va-featured-content--default" link_text="va-featured-content" %}

## Usage

<a class="vads-c-action-link--blue" href="https://designsystem.digital.gov/components/summary-box/">Refer to the U.S. Web Design System for usage guidance</a>

### Additional guidance for VA

### When to use featured content

* **Highlight the most important information.** The Featured content component is for calling out key details that readers shouldn’t miss. It was originally intended to hold eligibility data exclusively. The content should be "evergreen", not time sensitive.
Expand Down Expand Up @@ -77,4 +92,8 @@ Code for this component is shown in Storybook. Follow the link provided in [exam

## Content considerations

* **Keep content brief.** If there are more than 5 bullet points, the bullet points are longer than 20 words, or the bullet points require a header, image or button consider using simple body text, headings, and lists instead.
* **Keep content brief.** If there are more than 5 bullet points, the bullet points are longer than 20 words, or the bullet points require a header, image or button consider using simple body text, headings, and lists instead.

## Accessibility considerations

<a class="vads-c-action-link--blue" href="https://designsystem.digital.gov/components/summary-box/#accessibility-summary-box">Refer to the U.S. Web Design System for accessibility guidance</a>

0 comments on commit bebcf8d

Please sign in to comment.