滚动阴影
当内容在滚动时溢出时,应用顶部和底部的阴影。
安装
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 |
orientation | horizontal | vertical | 滚动方向。 | vertical |
isEnabled | 布尔值 | 是否启用阴影。 | true |
visibility | ScrollShadowVisibility | 阴影可见性。(受控) | auto |
ShadowScroll 事件
属性 | 类型 | 描述 |
---|---|---|
onVisibilityChange | (visibility: ScrollShadowVisibility) => void | 当阴影可见性发生变化时调用的回调函数。 |
类型
Scroll Shadow Visibility
type ScrollShadowVisibility = "auto" | "top" | "bottom" | "left" | "right" | "both" | "none";