开启checkJs后使用React.forwardRef编写函数组件出现TS报错如何解决
报错根本原因
这些报错不属于运行逻辑问题,是TS在开启checkJs模式时,对无显式泛型的React.forwardRef返回值的静态类型推导存在默认偏差,没有关联后续赋值的propTypes定义,整个推导链路从根源上错配了组件的props类型,每处报错的触发逻辑对应为:
- 解构
padding时报“属性不存在”:TS在JS文件中遇到没有显式标注泛型的forwardRef时,会自动把渲染函数的props参数推导为仅包含children?: ReactNode的基础空类型,没有读取后续定义的业务props结构,因此访问解构出的padding时触发属性不存在的错误。 - 给
Box.propTypes赋值时报错:TS已经将Box的类型锁定为ForwardRefExoticComponent<RefAttributes<View>>,这个类型自带的propTypes字段校验规则为匹配RefAttributes(仅和ref相关的属性),而定义的propTypes全是padding这类业务属性,TS判定两者没有公共属性,触发类型不匹配报错。 - 使用
<Box>组件时报错:前期推导的Box允许接收的props仅包含children和ref,未包含定义的业务属性结构,因此实际传入业务属性时会触发类型不兼容报错。
保留
checkJs: true的修复方案 不需要关闭JS检查,只需要补全TS的类型推导链路,让其正确识别组件的props结构即可:
- 给
React.forwardRef补上两个固定位置的泛型参数:- 第一个泛型参数:ref最终挂载的元素类型(对应示例中的
View组件类型) - 第二个泛型参数:组件实际接收的业务props结构
对应修改后的代码参考:
export const Box = React.forwardRef<View, { padding?: number, children?: React.ReactNode }>(({ padding, children }, ref) => { return ( <View ref={ref} style={{ padding }}> {children} </View> ); }); - 第一个泛型参数:ref最终挂载的元素类型(对应示例中的
- 如果不想直接在泛型参数里硬写props结构,也可以通过JSDoc的方式标注props、ref的类型,TS在
checkJs模式下同样可以正确识别推导,达到和显式写泛型一致的效果。 - 完成类型标注后,TS会自动把
Box组件的propTypes字段的校验规则,从匹配ref相关属性切换为匹配定义的业务props结构,此时再给Box.propTypes赋值对应结构的定义,原有的类型不匹配报错会自动消失;同时TS推导出来的<Box>组件允许接收的props会自动包含声明过的业务属性,实际使用时传参也不会再触发类型不兼容的红波浪线报错。
补充说明
TS的静态推导是从上到下锁死类型的,不会等执行Box.propTypes = propTypes的赋值逻辑后,再回头更新前面推导好的组件类型。如果没有显式给forwardRef标注正确的props泛型,TS永远会用默认的空props类型去校验所有相关逻辑,最终触发连环报错。
内容的提问来源于stack exchange,提问作者user14586094
相关产品推荐
相关产品推荐

