Vue类组件中访问DOM ref的clientWidth/clientHeight时出现TypeScript类型报错
问题本质
这个报错是Vue结合TypeScript开发类组件时的典型类型推断问题:
Vue内置的$refs属性默认使用了过于宽泛的联合类型定义Vue | Element | Vue[] | Element[],静态编译时TS无法精准判断你通过ref绑定的目标到底是子组件实例,还是原生DOM元素。因此当你直接访问DOM专属的clientWidth、clientHeight属性时,由于这些属性并非联合类型的所有成员都具备,就会抛出类型报错。
需要注意的是,这个报错属于编译期的类型检查提示,和实际运行逻辑无关——因为你实际绑定的是一个原生div元素,运行时$refs拿到的就是真实DOM对象,所以原本的PDF导出功能本来就能正常跑通。
可落地的解决方法
方法1:快速修复现有代码(改动量最小)
给$refs拿到的变量做显式类型断言,明确告诉TS这个ref对应的是原生div元素即可:
downloadPdf(){ let pdf = new jsPDF("p", "pt", "a4", true); let invoice = document.getElementById('invoice') as HTMLDivElement; // 把$refs拿到的值断言为HTMLDivElement,就可以正常访问DOM属性 const invoiceRef = this.$refs.invoice as HTMLDivElement; let width = invoiceRef.clientWidth; let height = invoiceRef.clientHeight; html2canvas(invoice).then(canvas => { let image = canvas.toDataURL('image/png'); pdf.addImage(image, 'PNG', 0, 0, width * 0.55, height * 0.55); pdf.save('invoice'); }) }
优化提示:你代码里已经通过document.getElementById('invoice')拿到了和$refs指向的同一个DOM元素,完全可以直接复用这个值获取宽高,不需要额外再从$refs里取一次,既减少重复的类型断言代码,也避免不必要的重复DOM查询:
downloadPdf(){ let pdf = new jsPDF("p", "pt", "a4", true); // 明确断言拿到的DOM是HTMLDivElement类型 const invoice = document.getElementById('invoice') as HTMLDivElement; let width = invoice.clientWidth; let height = invoice.clientHeight; html2canvas(invoice).then(canvas => { let image = canvas.toDataURL('image/png'); pdf.addImage(image, 'PNG', 0, 0, width * 0.55, height * 0.55); pdf.save('invoice'); }) }
方法2:长期维护友好的写法(类组件场景推荐)
直接在组件类里显式声明$refs的类型结构,这样整个组件内所有用到这个ref的地方都不需要重复写类型断言,TS也会提供完整的代码提示:
@Component({ name: 'CreateInvoice', components: { } }) export default class CreateInvoice extends Vue { // 显式声明当前组件所有$refs对应的类型 public $refs!: { invoice: HTMLDivElement } downloadPdf(){ let pdf = new jsPDF("p", "pt", "a4", true); // TS会自动识别this.$refs.invoice是HTMLDivElement类型,不会再报类型错误 let width = this.$refs.invoice.clientWidth; let height = this.$refs.invoice.clientHeight; const invoice = this.$refs.invoice; html2canvas(invoice).then(canvas => { let image = canvas.toDataURL('image/png'); pdf.addImage(image, 'PNG', 0, 0, width * 0.55, height * 0.55); pdf.save('invoice'); }) } // 其余业务逻辑保持不变 }
注意事项
- 不要用
as any的方式跳过类型检查,那样会完全失去TypeScript的静态校验能力,后续如果ref绑定的元素类型改动,很容易引发无感知的运行时问题,尽量断言成精准的原生元素类型(比如HTMLDivElement、HTMLInputElement) - 目前你的代码是在用户触发下载操作时执行PDF导出逻辑,此时DOM已经完成挂载,访问ref对应的元素不存在空值问题,不需要额外加空值判断
- 如果后续同一个组件有多个ref,可以在
$refs的类型声明里把所有ref的类型都列出来,一次声明全局生效,不用在每个用到的地方重复写断言
内容的提问来源于stack exchange,提问作者DanielCaps
相关产品推荐
相关产品推荐

