feat: added doc for scroll-area #1249
Open
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
✅ Deploy Preview for harness-xd-review ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for harness-design ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
harish-viswa
force-pushed
the
docs/scroll-area
branch
from
932fe85 to
a12603a
Compare
harish-viswa
force-pushed
the
docs/scroll-area
branch
from
9002828 to
6874734
Compare
knagurski
reviewed
Apr 2, 2025
Comment on lines
+46
to
+60
| ## Anatomy | ||
|
|
||
| The ScrollArea component can be used to create scrollable areas. | ||
|
|
||
| ```typescript jsx | ||
| <ScrollArea className="h-64 w-64"> | ||
| <div className="p-4"> | ||
| <p>Scrollable content goes here.</p> | ||
| <p>Scrollable content goes here.</p> | ||
| <p>Scrollable content goes here.</p> | ||
| <p>Scrollable content goes here.</p> | ||
| <p>Scrollable content goes here.</p> | ||
| </div> | ||
| </ScrollArea> | ||
| ``` |
There was a problem hiding this comment.
No need for an Anatomy section for single part components.
Suggested change
| ## Anatomy | |
| The ScrollArea component can be used to create scrollable areas. | |
| ```typescript jsx | |
| <ScrollArea className="h-64 w-64"> | |
| <div className="p-4"> | |
| <p>Scrollable content goes here.</p> | |
| <p>Scrollable content goes here.</p> | |
| <p>Scrollable content goes here.</p> | |
| <p>Scrollable content goes here.</p> | |
| <p>Scrollable content goes here.</p> | |
| </div> | |
| </ScrollArea> | |
| ``` |
knagurski
reviewed
Apr 2, 2025
|
|
||
| ## API Reference | ||
|
|
||
| ### ScrollArea |
There was a problem hiding this comment.
Can drop the name from here for single-part components.
Suggested change
| ### ScrollArea |
knagurski
reviewed
Apr 2, 2025
Comment on lines
+70
to
+76
| type="hover" // [Optional] Scrollbar visibility behavior ('auto' | 'always' | 'scroll' | 'hover') | ||
| dir="ltr" // [Optional] Reading direction ('ltr' | 'rtl') | ||
| scrollHideDelay={600} // [Optional] Delay before hiding scrollbar (in ms) | ||
| className="h-[300px] w-[400px]" // [Optional] Container dimensions and styles | ||
| viewportClassName="p-4" // [Optional] Viewport styles | ||
| scrollThumbClassName="bg-gray-400" // [Optional] Scroll thumb styles | ||
| asChild={false} // [Optional] Change the rendered element |
There was a problem hiding this comment.
Use [OPTIONAL] instead of [Optional]
knagurski
reviewed
Apr 2, 2025
There was a problem hiding this comment.
While we're editing this file, can we remove ScrollBar from the exports in this file?
knagurski
requested changes
Apr 2, 2025
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.
closes #1229