Skip to main content
U.S. flag

An official website of the United States government

Dot gov

The .gov means it’s official.
Federal government websites often end in .gov or .mil. Before sharing sensitive information, make sure you’re on a federal government site.

Https

The site is secure.
The https:// ensures that you are connecting to the official website and that any information you provide is encrypted and transmitted securely.

Components

Link - Deep content

Don't use: Deprecated
Contributors
Jennifer Lee

The Link - Deep content component is now deprecated.

This component was not widely adopted, has no research backing it, and thus has been deprecated.

Examples

Example of the link, deep content style.
An example of the link, deep content style.

Purpose

The purpose of the Link - Deep content icon (aka Copy deep link) is to help make navigating and finding information on very long pages a little easier. It does this in 2 ways, by:

  1. Letting users to easily copy the URL of a deep content (H3 subsection or information inside an accordion).
  2. Linking people (who received and clicked on the deep link URL) directly to the deep content.

Usage

The URLs of deep links must be unique while also providing some information scent. To meet the needs of both requirements, the URLs of deep links are autogenerated using this pattern:

  • Take the page root URL and add on the first 30 characters of the H3 section or accordion title text plus the entity ID number.
  • Example: va.gov/coronavirus-veteran-frequently-asked-questions/#are-va-national-cemeteries-ope-37235

See ticket #22385 for details.

Behavior

Diagram showing which text is read when a user interacts with the link deep content icon.
A screen reader should read the accordion text when the user selects the link, deep content icon.
  • On hover, the Link - Deep content icon state inverts.
  • When a user clicks/taps on the Link - Deep content icon, the icon shows a focus state and a message displays that the link has been copied.
  • The focus state and message remain for 10 seconds (or until the user acts on another Link - Deep content icon).

Clicking on the URL that was shared

When a recipient clicks/taps on the URL that was sent to them, they’re brought directly to the location of that deep content on the page.

  • When the deep content is inside an accordion, the accordion is open on landing.
  • When the deep content is not in an accordion but in an H3 subsection, the user-recipient is simply taken to that specific H3 subsection.

Code usage

Accessibility considerations

  • On clicking/tapping, use a live-region to announce the “Link copied” text and keep the focus on the button.
  • The accessible label will contain relevant, content specific titles for the screen reader to announce, e.g. “Copy link to [How can I stay informed about COVID-19 vaccines at VA]”.

Component checklist

Maturity

Guidance
Examples, usage, code usage, content considerations, and accessibility considerations are all complete.
Research
VFS team conducted research on this component which is linked from this page.
Stability
Component has been in production for more than 3 months with no significant issues found.
Adoption
Multiple teams have adopted this component.

Accessibility

Accessible use of color
Color is not used as the only visual means of conveying information (WCAG 2.0 1.4.1).
Accessible contrast
Text has a contrast ratio of at least 4.5:1 for small text and at least 3:1 for large text (WCAG 2.0 1.4.3). Visual information required to identify components and states (except inactive components) has a contrast ratio of at least 3:1 (WCAG 2.1 1.4.11).
Keyboard interactions
Follows WCAG 2.0 standards for keyboard accessibility guidelines and includes a description of the keyboard interactions. All interactive elements can be selected and activated using the keyboard.
Content zoom tested
Component has been tested with the display set to 400% at 1280px viewport width to ensure that the component does not have overlapping text or elements and all interactive elements still operate.
Tested in screen readers
Tested with screen readers to ensure there are no issues with reading order, spelling, dynamic content, and interactive elements.

Code assets

Variations
Storybook includes all variations (style, size, orientation, optional iconography, selection, error state, etc.)
Responsive
Component depicted in all responsive breakpoints.
Interactive states
Includes all interactive states that are applicable (hover, active, focus, keyboard focus, disabled).
Tokens
All design attributes (color, typography, layout, etc.) are available as tokens.
Internationalization
Describes i18n attributes.

Visual assets

Variations
Sketch library includes all variations (style, size, orientation, optional iconography, selection, error state, etc.)
Responsive
Component designed to work in all responsive breakpoints.
Interactive states
Includes all interactive states that are applicable (hover, active, focus, keyboard focus, disabled).
Tokens
All design attributes (color, typography, layout, etc.) are available as tokens.
46% complete (7 of 15)

Legend:

  • Complete
  • Incomplete
  • Not applicable
Edit this page in GitHub (Permissions required)
Last updated: Nov 08, 2023