滚动阴影

当内容在滚动时溢出时,应用顶部和底部的阴影。


安装

npx nextui-cli@latest add scroll-shadow
以上命令仅用于单独安装。如果 @nextui-org/react 已经全局安装,您可以跳过此步骤。

导入

使用

隐藏滚动条

您可以使用 hideScrollBar 属性来隐藏垂直和水平滚动条。

自定义阴影大小

默认情况下,阴影大小为 40 像素,但您可以使用 size 属性更改它。

水平方向

如果您需要在水平滚动上应用阴影,可以将 orientation 属性设置为 horizontal

阴影偏移

默认情况下,阴影偏移为 0 像素,但您可以使用 offset 属性更改它。这允许您在特定位置应用阴影。

API

ShadowScroll 属性

属性类型描述默认值
size数字阴影大小(以像素为单位)。40
offset数字显示阴影的滚动偏移量(以像素为单位)。0
hideScrollBar布尔值是否隐藏滚动条。false
orientationhorizontal | vertical滚动方向。vertical
isEnabled布尔值是否启用阴影。true
visibilityScrollShadowVisibility阴影可见性。(受控)auto

ShadowScroll 事件

属性类型描述
onVisibilityChange(visibility: ScrollShadowVisibility) => void当阴影可见性发生变化时调用的回调函数。

类型

Scroll Shadow Visibility

type ScrollShadowVisibility = "auto" | "top" | "bottom" | "left" | "right" | "both" | "none";