Fix anchored popover top position when document is scrollable #250
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
Anchored popover is a <Popover> wrapped with two HOCs:
`closable()(anchored()(Popover)`
Before this commit it will form following DOM structure:
```html
<body>
<div class="gyp-base-layer">
<div class="gyp-closable>
<div class="gyp-popover gyp-popover--top">
</div>
</div>
</body>
```
`gyp-popover` is absolutely positioned, with `top` value which
is relative to its document top left corner. `gyp-closable` is
`position: fixed` with `width: 100vw` and `height: 100vh`.
It works when document is too short to scroll, such as previous
storybook doc canvas. But when the element triggering popover is
over the screen(i.e. we have to scroll to click it), the position
of anchored popover will be wrong because the `position: absoulte`
of `gyp-popover` is relative to `gyp-closable`, which is
`position: fixed`, so the `top` value is wrong.
The position of `gyp-popover` should always be relative to the
document. So in this fix we change the `closable` HOC code to change
DOM structure as:
```html
<body>
<div class="gyp-base-layer">
<div class="gyp-closable" />
<div class="gyp-popover" />
</div>
</body>
```
Let the `gyp-popover` be relative to `gyp-base-layer`, which is absolute
to `document.body`.
Note that this bug won't happen on Cloud2 since on Cloud2 the
`document.body` height is always `100vh`, which is not scrollable.
chenesan
commented
Feb 10, 2020
| @@ -85,7 +85,7 @@ it('intercepts event propagation if instructed', () => { | |||
| <ClosableFoo closable={{ stopEventPropagation: true }} /> | |||
| </div> | |||
| ); | |||
| wrapper.find('div#foo').simulate('click'); | |||
| wrapper.find('div.gyp-closable').simulate('click'); | |||
There was a problem hiding this comment.
This is because wrapped component (#foo) is not the child of div.gyp-closable now. To test stopPropagtion we have no choice but testing on div.closable itself.
zhusee2
reviewed
Feb 10, 2020
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Purpose
As title. In #249 I mentioned this bug.
Anchored popover is a wrapped with two HOCs:
closable()(anchored()(Popover)Before this commit it will form following DOM structure:
gyp-popoveris absolutely positioned, withtopvalue whichis relative to its document top left corner.
gyp-closableisposition: fixedwithwidth: 100vwandheight: 100vh.It works when document is too short to scroll, such as previous
storybook doc canvas. But when the element triggering popover is
over the screen(i.e. we have to scroll to click it), the position
of anchored popover will be wrong because the
position: absoulteof
gyp-popoveris relative togyp-closable, which isposition: fixed, so thetopvalue is wrong.The position of
gyp-popovershould always be relative to thedocument. So in this fix we change the
closableHOC code to changeDOM structure as:
Let the
gyp-popoverbe relative togyp-base-layer, which is absoluteto
document.body.Note that this bug won't happen on Cloud2 since on Cloud2 the
document.bodyheight is always100vh, which is not scrollable.And, this fix only affect
<Popover>component because currentlyonly
<Popover>using theclosablemixin.Changes
/packages/core/src/mixins/closable/DOM structure.intercepts event propagation if instructedtest to match the fix.UI screenshots
You can verify them in popover storybook doc on
feature/core-docs-pt4and this branch respectively.Before the fix:
After the fix:
Risk
Might influence cloud2 popover UI. Though I have manually tested this and it looks fine.
TODOs