Skip to content
This repository has been archived by the owner on May 24, 2024. It is now read-only.

[terra-alert] Update notification banner documentation #3933

Merged
merged 4 commits into from
Oct 11, 2023
Merged

Conversation

trandrew1023
Copy link
Contributor

@trandrew1023 trandrew1023 commented Oct 10, 2023

Summary

What was changed:

  • Added clarification for notification titles
  • Documentation and example cleanup
  • Updated examples to be more realistic

Why it was changed:

  • Unclear on how to use title prop since it is meant to be a custom title

Testing

This change was tested using:

  • WDIO
  • Jest
  • Visual testing (please attach a screenshot or recording)
  • Other (please describe below)
  • No tests are needed

Reviews

In addition to engineering reviews, this PR needs:

  • UX review
  • Accessibility review
  • Functional review

Additional Details


UXPLATFORM-9751

Thank you for contributing to Terra.
@cerner/terra

<ActionExample title="Notification Banner with Action" />
<DismissibleExample title="Dismissible Notification Banner" />
<ActionAndDismissibleExample title="Dismissible Notification Banner with Actions" />
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed this since it was a bad example of a custom notification without title and there are already examples of notification with action and dismiss

</>

</div>
<LiveRegionsExampleCode />
Copy link
Contributor Author

@trandrew1023 trandrew1023 Oct 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to toggle button to show example code rather than leaving code on page by default

Copy link
Contributor

@smason0 smason0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Just a few small comments

@github-actions github-actions bot temporarily deployed to preview-pr-3933 October 11, 2023 19:11 Destroyed
@chrismichalewicz
Copy link

@trandrew1023 Reviewed this and it looks good functionally. There were minimal updates that required a11y review but checked the "Show live revion example code" toggle and it communicated and functioned as expected in Edge/Jaws. As the changes were minimal and provided clarity to the title prop rather than specific examples I went ahead and updated the UX label as well.

@adoroshk adoroshk merged commit 5fb3c90 into main Oct 11, 2023
@adoroshk adoroshk deleted the update-alert-doc branch October 11, 2023 21:00
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
📦 terra-alert ⭐ Accessibility Reviewed Accessibility has been reviewed and approved. ⭐ Functionally Reviewed ⭐ UX Reviewed UX Reviewed and approved.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants