Improve docs consistency for Overlay, PageHead, Pagination, Popover, Portal, ProgressBar components #1805
Conversation
This file contains hidden or 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
|
59 tasks
size-limit report 📦
|
rezrah
changed the title
rezrah
changed the title
rezrah
changed the title
rezrah
changed the title
rezrah
commented
Jan 18, 2022
| # - title: Overlay | ||
| # url: /Overlay | ||
| - title: Overlay | ||
| url: /Overlay |
There was a problem hiding this comment.
Unclear why this was hidden. Does anyone know?
rezrah
changed the title
siddharthkp
reviewed
Jan 18, 2022
| @@ -45,7 +49,7 @@ By default, clicking a link in the pagination component will cause the browser t | |||
| </State> | |||
| ``` | |||
|
|
|||
| ## Customizing link URLs | |||
| ### Customizing link URLs | |||
colebemis
reviewed
Jan 18, 2022
colebemis
reviewed
Jan 19, 2022
colebemis
reviewed
Jan 19, 2022
Comment on lines
+119
to
+124
| <PropsTableRow | ||
| name="as" | ||
| defaultValue="div" | ||
| type="string" | ||
| description="Sets the underlying HTML tag for the component" | ||
| /> |
There was a problem hiding this comment.
Suggested change
| <PropsTableRow | |
| name="as" | |
| defaultValue="div" | |
| type="string" | |
| description="Sets the underlying HTML tag for the component" | |
| /> | |
| <PropsTableAsRow | |
| defaultElementType="div" | |
| /> |
There was a problem hiding this comment.
Same comment as before, this suggestion results in an empty row? @colebemis
colebemis
reviewed
Jan 19, 2022
Comment on lines
+24
to
+29
| <PropsTableRow | ||
| name="as" | ||
| defaultValue="div" | ||
| type="string" | ||
| description="Sets the underlying HTML tag for the component" | ||
| /> |
There was a problem hiding this comment.
Suggested change
| <PropsTableRow | |
| name="as" | |
| defaultValue="div" | |
| type="string" | |
| description="Sets the underlying HTML tag for the component" | |
| /> | |
| <PropsTableAsRow | |
| defaultElementType="div" | |
| /> |
colebemis
reviewed
Jan 19, 2022
Comment on lines
+153
to
+158
| <PropsTableRow | ||
| name="as" | ||
| defaultValue="div" | ||
| type="string" | ||
| description="Sets the underlying HTML tag for the component" | ||
| /> |
There was a problem hiding this comment.
Suggested change
| <PropsTableRow | |
| name="as" | |
| defaultValue="div" | |
| type="string" | |
| description="Sets the underlying HTML tag for the component" | |
| /> | |
| <PropsTableAsRow | |
| defaultElementType="div" | |
| /> |
There was a problem hiding this comment.
@colebemis This doesn't seem to work with html tags, getting an empty row. Any ideas? 
colebemis
reviewed
Jan 19, 2022
colebemis
reviewed
Jan 19, 2022
colebemis
reviewed
Jan 19, 2022
colebemis
reviewed
Jan 19, 2022
colebemis
reviewed
Jan 19, 2022
docs/content/ProgressBar.mdx
Outdated
| ### ProgressBar | ||
|
|
||
| <PropsTable> | ||
| <PropsTableRow name="progress" type="number" description="Used to set the size of the green bar" /> |
There was a problem hiding this comment.
As in a required prop? No, it's optional. Defaults to 0 if it's not passed in.
colebemis
reviewed
Jan 19, 2022
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.
Part of #1701
Added / Updated docs for:
Overlay(see it here)PageHead(see it here)Pagination(see it here)Popover(see it here)Portal(see it here)ProgressBar(see it here)Merge checklist