Recharts场景下自定义LabelList触发react/prop-types校验报错问题
Recharts自定义LabelList组件ESLint
react/prop-types报错解决方案 问题场景
- 在React函数组件内部定义Recharts自定义标签渲染函数
customLabel,解构props.x/props.y等值时,触发ESLint react/prop-types 规则报错,提示对应props缺少类型校验 - 手动为
customLabel声明自定义props接口时,组件签名无法匹配Recharts要求的 ContentRenderer类型定义 - 项目禁止通过注释临时禁用ESLint规则,且不能将
customLabel抽到外层组件全局作用域下定义
纯JS项目适配方案
直接使用项目中已安装的prop-types依赖为函数补全校验规则,完全符合ESLint规则要求,且不改变组件原有签名,可正常匹配Recharts的类型要求:
- 引入
prop-types库 - 为
customLabel函数挂载propTypes属性,声明所有解构用到的props类型
示例代码:
import PropTypes from 'prop-types'; const customLabel = (props) => { const { x, y, width, height, value } = props; const displayValue = typeof value === 'number' ? value.toLocaleString() : String(value ?? ''); return ( <text x={x} y={y} fill={"white"}> {displayValue} </text> ); }; // 补全props校验,直接消除ESLint报错 customLabel.propTypes = { x: PropTypes.number, y: PropTypes.number, width: PropTypes.number, height: PropTypes.number, value: PropTypes.oneOfType([PropTypes.number, PropTypes.string]), };
TS项目适配方案
直接复用Recharts库内置导出的类型,避免手写接口时和库的类型定义不兼容的问题:
- 从
recharts包中导入原生LabelProps类型 - 直接将
customLabel的props参数标注为导入的LabelProps类型 - 搭配
useCallback缓存函数引用,避免外层组件重渲染时生成新的函数引用触发不必要的图表重绘
示例代码:
import { useCallback } from 'react'; // 导入Recharts内置的标签props类型 import type { LabelProps } from 'recharts'; const customLabel = useCallback((props: LabelProps) => { const { x, y, value } = props; const displayValue = typeof value === 'number' ? value.toLocaleString() : String(value ?? ''); return ( <text x={x} y={y} fill="white"> {displayValue} </text> ); }, []);
注意点
TS模式下ESLint的 react/prop-types 规则会自动识别TS类型标注,不需要额外手动挂载propTypes属性,直接满足规则要求。自定义组件签名因为完全匹配Recharts内置的LabelProps类型,不会出现类型不兼容的报错。
内容的提问来源于stack exchange,提问作者Reuben Crimp
相关产品推荐
相关产品推荐

