@@ -67,9 +67,13 @@ The `ScrollArea` component serves as the main container for the scrollable area.
67
67
68
68
``` typescript jsx
69
69
< ScrollArea
70
- className = " h-[300px] w-[400px]" // Container dimensions and styles
71
- viewportClassName = " p-4" // [Optional] Viewport styles
72
- scrollThumbClassName = " bg-gray-400" // [Optional] Scroll thumb styles
70
+ type = " hover" // [Optional] Scrollbar visibility behavior ('auto' | 'always' | 'scroll' | 'hover')
71
+ dir = " ltr" // [Optional] Reading direction ('ltr' | 'rtl')
72
+ scrollHideDelay = {600 } // [Optional] Delay before hiding scrollbar (in ms)
73
+ className = " h-[300px] w-[400px]" // [Optional] Container dimensions and styles
74
+ viewportClassName = " p-4" // [Optional] Viewport styles
75
+ scrollThumbClassName = " bg-gray-400" // [Optional] Scroll thumb styles
76
+ asChild = {false } // [Optional] Change the rendered element
73
77
>
74
78
{/* Scrollable content */ }
75
79
< / ScrollArea >
@@ -83,18 +87,53 @@ The `ScrollArea` component serves as the main container for the scrollable area.
83
87
required: true ,
84
88
value: " ReactNode" ,
85
89
},
90
+ {
91
+ name: " type" ,
92
+ description: " Describes the nature of scrollbar visibility" ,
93
+ required: false ,
94
+ value: " 'auto' | 'always' | 'scroll' | 'hover'" ,
95
+ defaultValue: " 'hover'" ,
96
+ },
97
+ {
98
+ name: " dir" ,
99
+ description: " The reading direction of the scroll area" ,
100
+ required: false ,
101
+ value: " 'ltr' | 'rtl'" ,
102
+ },
103
+ {
104
+ name: " scrollHideDelay" ,
105
+ description:
106
+ " The duration from when the user stops interacting with scrollbar to when it's hidden" ,
107
+ required: false ,
108
+ value: " number" ,
109
+ defaultValue: " 600" ,
110
+ },
86
111
{
87
112
name: " className" ,
88
- description: " Additional class names for the scroll area" ,
113
+ description: " Additional class names for the scroll area container " ,
89
114
required: false ,
90
115
value: " string" ,
91
116
},
92
117
{
93
118
name: " viewportClassName" ,
94
- description: " Additional class names for the viewport" ,
119
+ description:
120
+ " Class names for the viewport element that wraps the content" ,
95
121
required: false ,
96
122
value: " string" ,
97
123
},
124
+ {
125
+ name: " scrollThumbClassName" ,
126
+ description: " Class names for the scroll thumb element" ,
127
+ required: false ,
128
+ value: " string" ,
129
+ },
130
+ {
131
+ name: " asChild" ,
132
+ description:
133
+ " Change the default rendered element for the one passed as a child" ,
134
+ required: false ,
135
+ value: " boolean" ,
136
+ },
98
137
]}
99
138
/>
100
139
@@ -104,9 +143,10 @@ The `ScrollBar` component is used to display a custom scrollbar inside the scrol
104
143
105
144
``` typescript jsx
106
145
< ScrollBar
107
- orientation = " vertical" // Scrollbar orientation
108
- className = " bg-gray-100" // [Optional] Scrollbar styles
109
- scrollThumbClassName = " bg-gray-400" // [Optional] Scroll thumb styles
146
+ orientation = " vertical" // [Optional] Scrollbar orientation ('horizontal' | 'vertical')
147
+ className = " bg-gray-100" // [Optional] Scrollbar styles
148
+ scrollThumbClassName = " bg-gray-400" // [Optional] Scroll thumb styles
149
+ forceMount // [Optional] Force mounting when more control is needed
110
150
/ >
111
151
```
112
152
@@ -122,10 +162,21 @@ The `ScrollBar` component is used to display a custom scrollbar inside the scrol
122
162
},
123
163
{
124
164
name: " className" ,
125
- description:
126
- " Additional class names for styling the scrollbar's appearance" ,
165
+ description: " Additional class names for the scrollbar" ,
127
166
required: false ,
128
167
value: " string" ,
129
168
},
169
+ {
170
+ name: " scrollThumbClassName" ,
171
+ description: " Class names for the scroll thumb element" ,
172
+ required: false ,
173
+ value: " string" ,
174
+ },
175
+ {
176
+ name: " forceMount" ,
177
+ description: " Used to force mounting when more control is needed" ,
178
+ required: false ,
179
+ value: " boolean" ,
180
+ },
130
181
]}
131
182
/>
0 commit comments