diff --git a/products/identity-personalization/onsite-notifications/badge-indicator/badge-indicator-FE-documentation.md b/products/identity-personalization/onsite-notifications/badge-indicator/badge-indicator-FE-documentation.md index 1342fbbdf68..3e2be02f73f 100644 --- a/products/identity-personalization/onsite-notifications/badge-indicator/badge-indicator-FE-documentation.md +++ b/products/identity-personalization/onsite-notifications/badge-indicator/badge-indicator-FE-documentation.md @@ -1,6 +1,6 @@ # Badge indicator FE documentation - My VA Health Care inbox link implementation -**Last updated:** October 29, 2024 - Removed note about content. +**Last updated:** November 12, 2024 - Added revisions, final content for MVP. This document outlines specs for implementing the badge indicator on the "Go to your inbox" link in the Health Care section on My VA. The link provides access the health care secure messaging inbox. For full documentation on the Health Care section of My VA, see [My VA: Health Care Use Cases](https://github.com/department-of-veterans-affairs/va.gov-team/tree/master/products/identity-personalization/my-va/use-cases/health-care-use-cases). @@ -22,21 +22,37 @@ This document outlines specs for implementing the badge indicator on the "Go to [Mobile](https://www.figma.com/design/15yOY4VEzitxm5tRMDiAzz/My-VA?node-id=0-853&t=A6qFKMrzSt4ukLYn-1) -## Error state - API-related failure(s): +## Error state - API and service related failure(s): -A [slim warning 'alert' component](https://design.va.gov/components/alert/#warning-alert) will display instead of the "Go to your inbox" link of the health care section of My VA if there is an API/systems related error that prevents the count of unread messages from being displayed. It is expected that this would prevent the reading of messages in a user's inbox as well, but there may be edge case scenarios in which users _might_ be able to still read messages on MHV. After consultation with DSC, the decision was made to use a single warning alert that replaces the "go to your inbox" link with a catch-all message regardless of error code. +There are two possible scenarios with errors preventing the display of a message count: +- Inbox access is likely unavailable +- Inbox access is likely available + +### If inbox access is likely unavailable + +A [slim warning 'alert' component](https://design.va.gov/components/alert/#warning-alert) will display above the "Go to your inbox" link of the health care section of My VA, as well as a "?" displayed inside of the badge indicator adjacent to the link. _(For uses outside of Health care and My VA, error messaging using alerts may make sense as well but could require a different pattern/component)._ +[Desktop](https://www.figma.com/design/15yOY4VEzitxm5tRMDiAzz/My-VA?node-id=2850-45132&t=xr9SwjaLf9FYMxCT-1) + +[Mobile]( + +### If inbox access is likely available + With some error scenarios, it's possible secure messaging access may still be possible, even if a count cannot be given. -[Desktop](https://www.figma.com/design/15yOY4VEzitxm5tRMDiAzz/My-VA?node-id=2715-34412&t=3UjLr4lC05r8oBlP-1) +[Desktop](https://www.figma.com/design/15yOY4VEzitxm5tRMDiAzz/My-VA?node-id=2799-35365&t=xr9SwjaLf9FYMxCT-1) -[Mobile](https://www.figma.com/design/15yOY4VEzitxm5tRMDiAzz/My-VA?node-id=2622-33921&t=3UjLr4lC05r8oBlP-1) +[Mobile]( ### Content -We can't access your messages right now. We're sorry. Check back soon. +Alert + +Badge Indicator + + ---