Affix固钉 - 图1

Affix 固钉

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

何时使用

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

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

代码演示

Affix固钉 - 图2

Affix固钉 - 图3

基本

最简单的用法。

  1. <template>
  2.   <a-affix :offset-top="top">
  3.     <a-button type="primary" @click="top += 10">Affix top</a-button>
  4.   </a-affix>
  5.   <br />
  6.   <a-affix :offset-bottom="bottom">
  7.     <a-button type="primary" @click="bottom += 10">Affix bottom</a-button>
  8.   </a-affix>
  9. </template>
  10. <script lang="ts">
  11. import { defineComponent, ref } from 'vue';
  12. export default defineComponent({
  13.   setup() {
  14.     const top = ref<number>(10);
  15.     const bottom = ref<number>(10);
  16.     return {
  17.       top,
  18.       bottom,
  19.     };
  20.   },
  21. });
  22. </script>

Affix固钉 - 图4

滚动容器

用 target 设置 Affix 需要监听其滚动事件的元素，默认为 window。

  1. <template>
  2.   <div id="components-affix-demo-target" ref="containerRef" class="scrollable-container">
  3.     <div class="background">
  4.       <a-affix :target="() => containerRef">
  5.         <a-button type="primary">Fixed at the top of container</a-button>
  6.       </a-affix>
  7.     </div>
  8.   </div>
  9. </template>
  10. <script lang="ts">
  11. import { defineComponent, ref, VNode } from 'vue';
  13. export default defineComponent({
  14.   setup() {
  15.     const containerRef = ref<VNode>();
  16.     return {
  17.       containerRef,
  18.     };
  19.   },
  20. });
  21. </script>
  22. <style>
  23. #components-affix-demo-target.scrollable-container {
  24.   height: 100px;
  25.   overflow-y: scroll;
  26. }
  27. #components-affix-demo-target .background {
  28.   padding-top: 60px;
  29.   height: 300px;
  30.   background-image: url('https://zos.alipayobjects.com/rmsportal/RmjwQiJorKyobvI.jpg');
  31. }
  32. </style>

Affix固钉 - 图5

固定状态改变的回调

可以获得是否固定的状态。

  1. <template>
  2.   <a-affix :offset-top="120" @change="change">
  3.     <a-button>120px to affix top</a-button>
  4.   </a-affix>
  5. </template>
  6. <script lang="ts">
  7. import { defineComponent } from 'vue';
  8. export default defineComponent({
  9.   setup() {
  10.     const change = (affixed: boolean) => {
  11.       console.log(affixed);
  12.     };
  14.     return {
  15.       change,
  16.     };
  17.   },
  18. });
  19. </script>

API

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

事件

事件名称说明回调参数版本
change固定状态改变时触发的回调函数Function(affixed)无

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

  1. <a-affix :style="{ position: 'absolute', top: y, left: x}">
  2.   ...
  3. </a-affix>

FAQ

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

从性能角度考虑，我们只监听容器滚动事件。

相关 issue：#3938 #5642 #16120