Adding Modal component #18156
Closed
Adding Modal component #18156
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
georgewrmarshall
added
the
team-design-system
|
CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes. |
ui/components/component-library/badge-wrapper/badge-wrapper.types.ts
Outdated
Show resolved
Hide resolved
Builds ready [5d6cf3e]
Page Load Metrics (1637 ± 43 ms)
Bundle size diffs
|
Codecov Report
@@ Coverage Diff @@
## develop #18156 +/- ##
===========================================
- Coverage 64.11% 64.04% -0.07%
===========================================
Files 910 916 +6
Lines 35516 35604 +88
Branches 9008 9031 +23
===========================================
+ Hits 22768 22800 +32
- Misses 12748 12804 +56
... and 2 files with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
8 tasks
georgewrmarshall
force-pushed
the
feat/15432/modal-component
branch
from
5d6cf3e to
284bce6
Compare
Builds ready [284bce6]
Page Load Metrics (1567 ± 70 ms)
Bundle size diffs
|
georgewrmarshall
force-pushed
the
feat/15432/modal-component
branch
from
284bce6 to
b3ab924
Compare
8 tasks
|
What's the status / ETA on this modal component? |
|
@eriknson hoping to get this into a reviewable state soon. Rough eta 2 weeks |
georgewrmarshall
force-pushed
the
feat/15432/modal-component
branch
from
b3ab924 to
7cc9685
Compare
georgewrmarshall
changed the title
8 tasks
georgewrmarshall
force-pushed
the
feat/15432/modal-component
branch
from
7cc9685 to
bb6f0b9
Compare
georgewrmarshall
force-pushed
the
feat/15432/modal-component
branch
from
bb6f0b9 to
752a27d
Compare
georgewrmarshall
force-pushed
the
feat/15432/modal-component
branch
from
752a27d to
bb3d17b
Compare
georgewrmarshall
removed
the
DO-NOT-MERGE
georgewrmarshall
force-pushed
the
feat/15432/modal-component
branch
2 times, most recently
from
232972c to
98cffd6
Compare
georgewrmarshall
force-pushed
the
feat/15432/modal-component
branch
from
98cffd6 to
174ee0d
Compare
| @@ -333,6 +333,7 @@ | |||
| "qrcode.react": "^1.0.1", | |||
| "react": "^16.12.0", | |||
| "react-dom": "^16.12.0", | |||
| "react-focus-lock": "^2.9.4", | |||
There was a problem hiding this comment.
Using react-focus-lock library to lock focus to the ModalContent component or to whatever component uses the modalContentRef ref to improve the accessibility for keyboard only and screen reader users
| @@ -25,6 +25,9 @@ export const ModalContent = ({ | |||
| { [`mm-modal-content--size-${size}`]: !width }, | |||
| className, | |||
| )} | |||
| as="section" | |||
| role="dialog" | |||
| aria-modal="true" | |||
| backgroundColor={BackgroundColor.backgroundDefault} | |||
| borderRadius={BorderRadius.LG} | |||
| width={width || BLOCK_SIZES.FULL} | |||
There was a problem hiding this comment.
screenreader and semantic html improvements copied from Chakra UI
| @@ -21,6 +21,7 @@ export const ModalOverlay: React.FC<ModalOverlayProps> = ({ | |||
| width={BLOCK_SIZES.FULL} | |||
| height={BLOCK_SIZES.FULL} | |||
| onClick={onClick} | |||
| aria-hidden="true" | |||
| {...props} | |||
There was a problem hiding this comment.
screenreader improvements copied from Chakra UI
|
|
||
| # Modal | ||
|
|
||
| The `Modal` focuses the user's attention exclusively on information via a window that is overlaid on primary content. It uses `ModalOverlay`, `ModalContent` and `ModalHeader` to create a modal dialog. |
There was a problem hiding this comment.
Change to
Suggested change
| The `Modal` focuses the user's attention exclusively on information via a window that is overlaid on primary content. It uses `ModalOverlay`, `ModalContent` and `ModalHeader` to create a modal dialog. | |
| The `Modal` focuses the user's attention exclusively on information via a window that is overlaid on primary content. It should be used with the `ModalOverlay`, `ModalContent` and `ModalHeader` components to create a complete modal. |
georgewrmarshall
requested review from
darkwing
and removed request for
hmalik88
Builds ready [9cbf2c3]
Page Load Metrics (1506 ± 32 ms)
Bundle size diffs [🚨 Warning! Bundle size has increased!]
|
darkwing
reviewed
Apr 27, 2023
|
Should we add a story with large amounts of content so we see how scrolling looks in the modal? |
garrettbear
reviewed
Apr 27, 2023
georgewrmarshall
force-pushed
the
feat/15432/modal-component
branch
from
6278584 to
cc9383e
Compare
georgewrmarshall
force-pushed
the
feat/15432/modal-component
branch
from
cc9383e to
fcd858e
Compare
Great point! I think you have identified a BIG BUG with this Modal implementation thank you!! |
Builds ready [fcd858e]
Page Load Metrics (1605 ± 42 ms)
Bundle size diffs [🚨 Warning! Bundle size has increased!]
|
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation
Adding
Modalcomponent based on insight report. This PR adds the final components to complete the newModalcomponent as well as stories, documentation and tests. It also introduces aModalFocuscomponent that uses the react-focus-lock library to improve the accessibility of our Modal component for keyboard only users.Screenshots/Screencaps
After
after.mov
Text coverage for
ModalandModalFocusManual Testing Steps
Modalin the search barstories,controlsanddocsPre-merge author checklist
Pre-merge reviewer checklist
If further QA is required (e.g. new feature, complex testing steps, large refactor), add the
Extension QA Boardlabel.In this case, a QA Engineer approval will be be required.