Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(Ref): restore docs for a component #4039

Merged
merged 3 commits into from
Aug 17, 2020
Merged

docs(Ref): restore docs for a component #4039

merged 3 commits into from
Aug 17, 2020

Conversation

layershifter
Copy link
Member

In #3774 we started to use third party package for Ref component however docs for it also gone. And it was unclear... (#3915).

This PR restores docs for Ref component and adds a clear statement when it should be used.

@github-actions
Copy link

size-limit report

Path Size
bundle-size/dist/Button.size.js 66.39 KB (0%)
bundle-size/dist/Icon.size.js 30.58 KB (0%)
bundle-size/dist/Image.size.js 61.63 KB (0%)
bundle-size/dist/Modal.size.js 76.65 KB (0%)
bundle-size/dist/Portal.size.js 47.78 KB (0%)

@codecov-commenter
Copy link

codecov-commenter commented Aug 17, 2020

Codecov Report

Merging #4039 into master will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #4039   +/-   ##
=======================================
  Coverage   99.84%   99.84%           
=======================================
  Files         183      183           
  Lines        3276     3276           
=======================================
  Hits         3271     3271           
  Misses          5        5           
Impacted Files Coverage Δ
src/modules/Popup/lib/createReferenceProxy.js 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bf87dd2...088ae10. Read the comment docs.

repoPath={componentInfo.repoPath}
type={componentInfo.type}
/>
{componentInfo.repoPath && (
Copy link
Member Author

Choose a reason for hiding this comment

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

Hides this block as code is not hosted in this repo:

image

@@ -31,7 +31,7 @@ class ReferenceProxy {
* @see https://popper.js.org/popper-documentation.html#referenceObject
*/
const createReferenceProxy = _.memoize(
(reference) => new ReferenceProxy(isRefObject(reference) ? reference : toRefObject(reference)),
(reference) => new ReferenceProxy(isRefObject(reference) ? reference : { current: reference }),
Copy link
Member Author

Choose a reason for hiding this comment

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

A small follow up fix for #4023.

component: 'docs/src/components/ComponentDoc',
priority: 0.8,
getData: async () => {
const componentsInfo = getComponentGroupInfo(baseInfo.displayName)
const sidebarSections = getSidebarSections(baseInfo.displayName)
const componentsInfo = {
Copy link
Member Author

Choose a reason for hiding this comment

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

It's annoying to do this manually, but in any case this is not a long term solution

@layershifter layershifter merged commit b96e411 into master Aug 17, 2020
@layershifter layershifter deleted the docs/ref-docs branch August 17, 2020 10:41
@jluxenberg
Copy link
Contributor

@layershifter Sorry I didn't have time last week to get this buttoned up. Thanks for getting this over the finish line and merged!

@layershifter
Copy link
Member Author

@jluxenberg no worries, thanks for contributing 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants