Skip to content
This repository has been archived by the owner on Mar 4, 2020. It is now read-only.

docs(props): put props on a single page, fix props links #1892

Merged
merged 19 commits into from
Sep 20, 2019

Conversation

lucivpav
Copy link
Contributor

@lucivpav lucivpav commented Sep 5, 2019

Fixes #1878. Furthermore, all props under one tab were collapsed on a single page, instead of having a dropdown prop selection.

@codecov
Copy link

codecov bot commented Sep 5, 2019

Codecov Report

Merging #1892 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           master   #1892   +/-   ##
======================================
  Coverage    69.9%   69.9%           
======================================
  Files         888     888           
  Lines        7775    7775           
  Branches     2244    2244           
======================================
  Hits         5435    5435           
  Misses       2330    2330           
  Partials       10      10

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 c826c3a...10a343a. Read the comment docs.

1 similar comment
@codecov
Copy link

codecov bot commented Sep 5, 2019

Codecov Report

Merging #1892 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           master   #1892   +/-   ##
======================================
  Coverage    69.9%   69.9%           
======================================
  Files         888     888           
  Lines        7775    7775           
  Branches     2244    2244           
======================================
  Hits         5435    5435           
  Misses       2330    2330           
  Partials       10      10

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 c826c3a...10a343a. Read the comment docs.

@codecov
Copy link

codecov bot commented Sep 5, 2019

Codecov Report

Merging #1892 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           master   #1892   +/-   ##
======================================
  Coverage    70.3%   70.3%           
======================================
  Files         893     893           
  Lines        7894    7894           
  Branches     2311    2287   -24     
======================================
  Hits         5550    5550           
  Misses       2331    2331           
  Partials       13      13

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 a0a3558...15732df. Read the comment docs.

@levithomason
Copy link
Member

It seems like we could fix this easier by just iterating all the props on a single page, opposed to having a dropdown to select the component props you want to see.

Thoughts?

@lucivpav
Copy link
Contributor Author

It seems like we could fix this easier by just iterating all the props on a single page, opposed to having a dropdown to select the component props you want to see.

Thoughts?

I agree, that way the logic gets easier. I suggest we also have an outline of the components for which we have props. That is because the Props page can be long and it would be hard to navigate.
image
So the outline would be similar compared to what we already have in Accessibility tab.
image

@layershifter do you think we should get rid of the props dropdown and list all the props on a single page instead?

@lucivpav
Copy link
Contributor Author

Shift suggests that we could use a submenu of Props to list the various options. Something like:
image
Then we can use react-router instead of programmatically maintaining correct dropdown value etc.
Codesandbox example: https://codesandbox.io/s/stardust-ui-example-vgy5i

@vercel vercel bot temporarily deployed to staging September 19, 2019 14:22 Inactive
@lucivpav lucivpav changed the title fix(docs): props links docs(props): put props on a single page Sep 19, 2019
@lucivpav lucivpav changed the title docs(props): put props on a single page docs(props): put props on a single page, fix props links Sep 19, 2019
Co-Authored-By: Oleksandr Fediashov <[email protected]>
@vercel vercel bot temporarily deployed to staging September 20, 2019 12:03 Inactive
@vercel vercel bot temporarily deployed to staging September 20, 2019 12:07 Inactive
@vercel vercel bot temporarily deployed to staging September 20, 2019 12:09 Inactive
@vercel vercel bot temporarily deployed to staging September 20, 2019 12:13 Inactive
@vercel vercel bot temporarily deployed to staging September 20, 2019 13:03 Inactive
@lucivpav lucivpav merged commit 06ce120 into master Sep 20, 2019
@lucivpav lucivpav deleted the fix/props-links branch September 20, 2019 14:25
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Props links do not point to the exact location
3 participants