ant-design/components/affix/index.zh-CN.md

---
category: Components
subtitle: 固钉
type: 导航
title: Affix
cover: https://gw.alipayobjects.com/zos/alicdn/tX6-md4H6/Affix.svg
---

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

## 何时使用

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

页面可视范围过小时，慎用此功能以免遮挡页面内容。

## API

| 成员 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| offsetBottom | 距离窗口底部达到指定偏移量后触发 | number | - |
| offsetTop | 距离窗口顶部达到指定偏移量后触发 | number | - |
| target | 设置 `Affix` 需要监听其滚动事件的元素，值为一个返回对应 DOM 元素的函数 | () => HTMLElement | () => window |
| onChange | 固定状态改变时触发的回调函数 | function(affixed) | - |

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

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

## FAQ

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

从性能角度考虑，我们只监听容器滚动事件。如果希望任意滚动，你可以在窗体添加滚动监听：<https://codesandbox.io/s/2xyj5zr85p>

相关 issue：[#3938](https://github.com/ant-design/ant-design/issues/3938) [#5642](https://github.com/ant-design/ant-design/issues/5642) [#16120](https://github.com/ant-design/ant-design/issues/16120)
-												docs: update documentation format

											
										
										
											2016-03-31 14:17:09 +08:00
+								---
 								category: Components
-												docs: update docs details

											
										
										
											2016-09-21 11:28:38 +08:00
+								subtitle: 固钉
-												:globe_with_meridians: site: transition component category, close #11629

											
										
										
											2018-11-04 16:20:35 +08:00
+								type: 导航
-												docs: update docs details

											
										
										
											2016-09-21 11:28:38 +08:00
+								title: Affix
-												docs: Update components cover (#24744)

* docs: Update components cover

#24629

* docs: Update components cover
											
										
										
											2020-06-05 13:50:09 +08:00
+								cover: https://gw.alipayobjects.com/zos/alicdn/tX6-md4H6/Affix.svg
-												docs: update documentation format

											
										
										
											2016-03-31 14:17:09 +08:00
+								---
-												Add components index.md

											
										
										
											2015-08-01 14:08:04 +08:00
-												update text

											
										
										
											2015-08-05 21:18:34 +08:00
+								将页面元素钉在可视范围。
 								## 何时使用
 								当内容区域比较长，需要滚动页面时，这部分内容对应的操作或者导航需要在滚动范围内始终展现。常用于侧边菜单和按钮组合。
 								页面可视范围过小时，慎用此功能以免遮挡页面内容。
-												add Affix

											
										
										
											2015-08-03 16:49:42 +08:00
+								## API
-												docs: Layout and Affix clean version (#19844)


											
										
										
											2019-11-21 10:24:22 +08:00
+								| 成员 | 说明 | 类型 | 默认值 |
 								| --- | --- | --- | --- |
 								| offsetBottom | 距离窗口底部达到指定偏移量后触发 | number | - |
 								| offsetTop | 距离窗口顶部达到指定偏移量后触发 | number | - |
 								| target | 设置 `Affix` 需要监听其滚动事件的元素，值为一个返回对应 DOM 元素的函数 | () => HTMLElement | () => window |
-												docs: sort api (#27251)

* chore: improve sort api table scripts

* sort api

* add ignore

* Revert "sort api"

This reverts commit 343505d5f09d69349ce1fbdaea2a9faa7e852207.

* sort api

* Update package.json

* sort api

* Delete sort-api.js

* sort api

* sort api

* sort api

* fix

* Update index.zh-CN.md

* fix input-number

* fix input-number

* sort func

* fix

* Method moved to the end

* carousel method
											
										
										
											2020-10-21 10:33:43 +08:00
+								| onChange | 固定状态改变时触发的回调函数 | function(affixed) | - |
-												docs: update docs of Affix

											
										
										
											2016-09-10 12:45:33 +08:00
 								**注意：**`Affix` 内的元素不要使用绝对定位，如需要绝对定位的效果，可以直接设置 `Affix` 为绝对定位：
 								```jsx
-												:lipstick: prittier all files

											
										
										
											2019-05-07 14:57:32 +08:00
+								<Affix style={{ position: 'absolute', top: y, left: x }}>...</Affix>
-												docs: update docs of Affix

											
										
										
											2016-09-10 12:45:33 +08:00
+								```
-												docs: Add FAQ of Affix window scroll (#16125)

* update doc

* Update index.en-US.md

* update desc

											
										
										
											2019-04-17 10:19:57 +08:00
 								## FAQ
 								### Affix 使用 `target` 绑定容器时，元素会跑到容器外。
 								从性能角度考虑，我们只监听容器滚动事件。如果希望任意滚动，你可以在窗体添加滚动监听：<https://codesandbox.io/s/2xyj5zr85p>
 								相关 issue：[#3938](https://github.com/ant-design/ant-design/issues/3938) [#5642](https://github.com/ant-design/ant-design/issues/5642) [#16120](https://github.com/ant-design/ant-design/issues/16120)