Floating UI 中箭头中间件与 Vue 3.5 useTemplateRef 的兼容性问题解析

在 Vue 3.5 版本中，官方引入了新的模板引用 API useTemplateRef()，这为开发者提供了更简洁的方式来处理模板引用。然而，当这个新特性与 Floating UI 的箭头中间件结合使用时，一些开发者遇到了兼容性问题。

问题现象

开发者在使用 Floating UI 的箭头中间件时，按照官方文档示例使用 ref() 可以正常工作，但切换到 Vue 3.5 推荐的 useTemplateRef() 后，箭头功能失效。控制台可能会报出引用相关的错误。

技术背景

Floating UI 是一个用于构建浮动元素（如工具提示、下拉菜单等）的 JavaScript 库。其箭头中间件允许开发者在浮动元素上添加箭头指示器，并自动计算箭头的位置和方向。

Vue 3.5 引入的 useTemplateRef() 是模板引用的新写法，它通过字符串键名自动关联模板中的 ref 属性，简化了模板引用的声明方式。

问题根源

经过实际测试验证，发现原始问题可能并非 API 本身的不兼容，而是由于以下常见原因导致：

1. 拼写错误：在中间件配置中误将 middleware 拼写为 mdidleware
2. 空格问题：在 useTemplateRef() 的参数中不小心包含了尾随空格
3. 引用时机：可能在某些情况下，箭头元素的引用尚未准备好就被传递给中间件

正确用法示例

以下是经过验证的正确使用方式：

import { useFloating, arrow } from '@floating-ui/vue'
import { useTemplateRef } from 'vue'

const arrowRef = useTemplateRef('arrowRef')
const floatingRef = useTemplateRef('floatingRef')
const triggerRef = useTemplateRef('triggerRef')

const { floatingStyles } = useFloating(triggerRef, floatingRef, {
  middleware: [
    arrow({
      element: arrowRef,
    }),
  ],
})

对应的模板部分：

<template>
  <div>
    <button ref="triggerRef">点击我</button>
    <div class="floating" ref="floatingRef" :style="floatingStyles">
      <div class="arrow" ref="arrowRef"></div>
      浮动内容
    </div>
  </div>
</template>

样式建议

为了使箭头正常显示，需要添加适当的 CSS 样式：

.floating {
  color: #000;
  background-color: #fff;
  padding: 10px;
  border-radius: 5px;
}

.arrow {
  position: absolute;
  transform: rotate(45deg);
  width: 20px;
  height: 20px;
  background: #fff;
  z-index: -1;
  pointer-events: none;
}

版本兼容性说明

经过测试，以下版本组合可以正常工作：

• Vue 3.5.10
• @floating-ui/vue 1.1.5

总结

Floating UI 的箭头中间件与 Vue 3.5 的 useTemplateRef() 完全可以协同工作。开发者遇到问题时，应该首先检查代码中的拼写错误和语法细节。新 API 的使用方式虽然简洁，但也需要开发者更加注意代码的准确性。

对于从传统 ref() 迁移到 useTemplateRef() 的开发者，建议逐步替换并测试每个引用的功能，以确保平稳过渡。