Affix 固钉

将页面元素固定在特定可视区域。

基础用法

固钉默认固定在页面顶部。

通过设置 offset 属性来改变吸顶距离,默认值为 0。

指定容器

通过设置 target 属性,让固钉始终保持在容器内,超过范围则隐藏。

请注意容器避免出现滚动条。

固定位置

Affix 组件提供 2 个固定的位置参数 top 和 bottom。

通过设置 position 属性来改变固定位置,默认值为 top 。

Affix API

Affix Attributes

属性名说明类型默认值
offset偏移距离,pxnumber0
position固定位置enumtop
target目标容器选择器,设置后固钉始终留在容器内,超出范围即隐藏string—
z-index固定时的 z-indexnumber / string100
teleported是否把固钉元素传送到 append-tobooleanfalse
append-to传送目标CSSSelector / HTMLElementbody
class-name / style根元素类名与样式string / object—

Affix Events

事件名说明参数
onChange固定状态变化时触发Function
onScroll滚动时触发Function

Affix Slots

插槽名说明React 写法
default自定义默认内容children

Affix Exposes

名称说明类型
update手动更新固钉状态Function
updateRoot重新测量 root 尺寸信息Function

通过 ref 拿到 expose:const ref = useRef<AffixExpose>(null),再调用 ref.current?.update()。