React TS useRef获取DOM高度报never类型clientHeight属性错误
报错核心原因
该类型报错本质是TypeScript对useRef的类型推导逻辑导致的:
- 原代码中
const sectionRef = React.useRef(null);未给useRef传入泛型参数,TS会将这个ref的类型推导为MutableRefObject<null>,即ref的current属性仅允许存储null值,后续对current的属性访问操作,都会被TS收窄为never类型,自然无法识别clientHeight、offsetTop这些DOM元素才具备的属性。
注:该报错仅在TS严格模式下触发,纯JavaScript开发环境不会出现类型检查类报错。
修复实现步骤
- 给
useRef传入关联的DOM元素对应的内置TypeScript类型作为泛型,明确ref可以指向的元素类型。 - 保留原有的空值判断逻辑,兼容组件初始挂载阶段ref.current为null的场景。
- 将创建好的ref绑定到目标DOM节点上,否则ref.current永远不会拿到实际的DOM对象。
完成上述调整后,原类型报错就会消失,同时可以正常读取DOM元素的高度、顶部偏移量等参数供业务逻辑使用。
修正后的完整代码示例
// 针对section元素,指定对应的TS内置类型 const sectionRef = React.useRef<HTMLSectionElement>(null); const [height, setHeight] = useState<number>(0); const scrollHandler = () => { const targetRef = sectionRef.current; if (!targetRef) return; // 后续读取offsetTop等偏移量属性时,TS会提供正确的类型提示 const offsetTop = targetRef.offsetTop; // 滚动逻辑实现 } useEffect(() => { const targetRef = sectionRef.current; // 组件挂载完成后读取元素高度存入状态 if (targetRef) { setHeight(targetRef.clientHeight); } window.addEventListener('scroll', scrollHandler); // 组件卸载时移除事件监听,避免内存泄漏 return () => { window.removeEventListener('scroll', scrollHandler); } }, []); // 将ref绑定到对应DOM节点 return <section ref={sectionRef}>需要测量尺寸的页面区块</section>
常见注意点
- 所有DOM元素对应的TS内置类型都是全局可用的,不需要手动定义:比如div对应
HTMLDivElement、按钮对应HTMLButtonElement、图片对应HTMLImageElement,根据实际绑定的元素选择对应类型传入泛型即可。 - 初始化ref时传入
null是React官方推荐的写法,只要泛型指定正确,TS不会把类型推导为never。 - 不要为了消错随意给ref指定
any类型,会丢失所有DOM属性的类型提示,违背TS的类型检查初衷。
内容的提问来源于stack exchange,提问作者Andrea Costanzo
相关产品推荐
相关产品推荐

