Revamp core components storybook doc(pt. 4) #249
Merged
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 has wrong `top` position after we migrate to new addon-docs. Needs investigation.
benny0642
reviewed
Feb 7, 2020
| > | ||
| <Button | ||
| basic="Open popover" | ||
| onClick={handlePopoverOpen} /> |
There was a problem hiding this comment.
我在本機端按 Open popover 沒有打開 popover 耶
There was a problem hiding this comment.
拍謝 PR description 寫不夠清楚 XD" 其實有但它的 top 跑到下面去了。會在下一個 PR 修掉。
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.
This was referenced Feb 10, 2020
zhusee2
approved these changes
Feb 10, 2020
| export default { | ||
| title: '@ichef/gypcrete|List', | ||
| component: List, | ||
| subcomponents: { ListRow }, |
There was a problem hiding this comment.
Maybe also adds Section to props table?
| title: '@ichef/gypcrete|Popover', | ||
| component: PurePopover, | ||
| subcomponents: { | ||
| 'renderToLayer(closable(anchored(Popover))': Popover, |
There was a problem hiding this comment.
No props found for this component
I think that's because renderToLayer() HOC does not contain any prop type. We might need other ways to get those prop types out.
There was a problem hiding this comment.
Open an asana ticket: https://app.asana.com/0/347798529122928/1161326694404681
…ew-storybook Fix anchored popover top position when document is scrollable
chenesan
changed the base branch from
feature/core-docs-pt3
to
project/update-core-components-storybook-doc
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
Same as #246 but for
<List>,<Popover>,<Popup>,<SearchInput>,<Section>.Some side notes:
<Popover>will show with incorrecttopposition in new storybook doc. I'll try to look into it in next PR.<Popup>example since popups as closable and default to closed because they will block the doc.Changes
List,Popover,Popup,SearchInput,Section.Risk
None.
TODOs