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

Privacy Agreement

Use with caution: Available
Used to provide a link to the privacy policy content and provide a confirmation checkbox.

Examples

Default

View va-privacy-agreement in Storybook

With Error

View va-privacy-agreement in Storybook

Usage

When to use Privacy Agreement

For all forms that collect Personally Identifiable Information (PII). As stated in the VA Privacy Policy:

The VA.gov web pages that collect personal information will have a hyperlink to the Limited Privacy Policy that applies to that particular web page.

This is a requirement of the Privacy Act of 1974.

How this component works

This component is used on the Review page of a form which is the last page in a form flow.

Behavior

  • Privacy Policy link. When clicked, the link will open in a new browser tab. This behavior is identified by an icon with the arrow pointing up and screen reader text “opens in new tab”.
  • Checkbox Toggle After reviewing the privacy policy content in a new browser tab, the user can select the checkbox to confirm that they have read and accept the privacy policy.

Placement

This component appears at the bottom of a form, above the link to “Finish this application later” which is directly above the button pair for submitting the form.

Instances of this component in production

An example of this component in use on VA.gov.
An example of this component in use on the 10-10EZ form on VA.gov

Code usage

Attributes and Properties

Property Attribute Type Default Description
checked checked boolean false Whether the checkbox is checked or not.
enableAnalytics enable-analytics boolean false Emit component-library-analytics events on the blur event.
showError show-error boolean false Whether to display the error message or not.

Events

Name Description
component-library-analytics The event used to track usage of the component. This is emitted when the checked value changes and enableAnalytics is true.
vaChange The event emitted when the checkbox changes.

Accessibility considerations

Privacy policy opens in new tab or window. This component must detail to all users that the privacy policy link opens in a new window. This indication should be visible and auditory.

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.
Note: This component was converted from React to a web-component in September 2022.
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.
92% complete (13 of 14)

Legend:

  • Complete
  • Incomplete
  • Not applicable
Edit this page in GitHub (Permissions required)
Last updated: Oct 04, 2022