JGuang

固钉

Affix · Ant Design

交互预览
npm install antd@6.6.5 @ant-design/icons@6.3.4 dayjs@1.11.23

固钉

将页面元素钉在可视范围。

何时使用

当内容区域比较长,需要滚动页面时,这部分内容对应的操作或者导航需要在滚动范围内始终展现。常用于侧边菜单和按钮组合。

页面可视范围过小时,慎用此功能以免出现遮挡页面内容的情况。

开发者注意事项:

自 5.10.0 起,由于 Affix 组件由 class 重构为 FC,之前获取 ref 并调用内部实例方法的写法都会失效。

代码演示

  • 基本 · basic
  • 固定状态改变的回调 · on-change
  • 滚动容器 · target

API

通用属性参考:通用属性

参数说明类型默认值版本全局配置
offsetBottom距离窗口底部达到指定偏移量后触发number-×
offsetTop距离窗口顶部达到指定偏移量后触发number0×
target设置 Affix 需要监听其滚动事件的元素,值为一个返回对应 DOM 元素的函数() => Window | HTMLElement | null() => window×
onChange固定状态改变时触发的回调函数(affixed?: boolean) => void-×

注意:Affix 内的元素不要使用绝对定位,如需要绝对定位的效果,可以直接设置 Affix 为绝对定位:

<Affix style={{ position: 'absolute', top: y, left: x }}>...</Affix>

FAQ

Affix 使用 target 绑定容器时,元素会跑到容器外。

从性能角度考虑,我们只监听容器滚动事件。如果希望任意滚动,你可以在窗体添加滚动监听:https://codesandbox.io/s/stupefied-maxwell-ophqnm?file=/index.js

相关 issue:#3938 #5642 #16120

Affix 在水平滚动容器中使用时, 元素 left 位置不正确。

Affix 一般只适用于单向滚动的区域,只支持在垂直滚动容器中使用。如果希望在水平容器中使用,你可以考虑使用 原生 position: sticky 实现。

相关 issue: #29108

原生通用属性

Tips: 以下通用属性适用于 antd 大部分组件,不支持的组件会单独说明。

参数说明类型默认值
style自定义样式CSSProperties-
className自定义类名string-
rootClassName添加在组件最外层的 classNamestring-
autoFocus自动获取焦点,仅对表单类、链接、交互容器等可聚焦元素生效booleanfalse

安装并复现示例

npm install antd@6.6.5 @ant-design/icons@6.3.4 dayjs@1.11.23

使用 ConfigProvider 和原生 App,并单独配置 dayjs 语言。每个示例在查看代码中列出完整源码文件和额外固定依赖。示例名称用于选择演示,不是组件通用属性。主题、语言与 SSR 初始化见资源安装指南。

原生类型参考

源码查看器包含未修改的原生实现和以下声明文件,继承类型仍位于原生包中。代码中的英文注释保留为源码参考。

  • vendor/components/affix/index.tsx
  • vendor/components/affix/style/index.ts
  • vendor/components/affix/utils.ts

来源与许可

https://github.com/ant-design/ant-design/tree/4a39f54842eade4e565ab336ef6097cd7e723cdd

保留原生中英文正文与可执行示例;官网专用的嵌入章节和令牌表格在本地展开。Ant Design 使用 MIT 许可,另列依赖的许可证也需保留。上传预览禁止向外发起请求,不提供后端服务。

本地示例适配

  • authored/demos/affix/basic.tsx: 为顶部与底部固钉提供独立滚动容器和有界偏移交互,避免嵌入式预览中固定按钮覆盖普通文档流的相邻按钮。 原始对照文件: vendor/components/affix/demo/basic.tsx.

复制示例清单中的适配 sourceFiles;上游对照源码保持不变。详见 LOCAL_CHANGES.md。