我有一个React组件,它将配置对象作为prop,它看起来像这样:
{
active: true,
foo: {
bar: 'baz'
}
}
在某些情况下,我想通过传入active: false
的其他对象来禁用组件显示的功能,如下所示:
{
active: false
}
这很好用,不是问题。
但是,我还想确保使用我的组件的客户端代码提供正确的配置对象:
如何为此类案例定义道具类型?
我试过了:
MyComponent.propTypes = {
config: PropTypes.oneOf([
{
active: false
},
PropTypes.shape({
active: true,
foo: PropTypes.shape({
bar: PropTypes.string.isRequired
})
}).isRequired
]).isRequired
};
但这给了我以下警告:
警告:道具类型失败:提供给
在MyComponent中config
的值为[object Object]
的道具MyComponent
无效,预期为[{"有效":true},null]
我知道为什么这不起作用:因为PropTypes.oneOf
不期望动态道具类型匹配器作为值,而只是一个有效参数数组。
问题是,有没有办法使这项工作?
我已经制作了一个可运行的沙箱示例,您可以在其中试用上面的示例代码:https://codesandbox.io/s/n9o0wl5zlj
答案 0 :(得分:2)
您可以使用自定义propType函数,例如:
MyComponent.proptypes = {
active: PropTypes.bool,
foo: function(props, propName, componentName) {
if (props['active'] && !props['propName']) {
return new Error(
`${propName} is required when active is true in ${componentName }.`
);
}
}
}
答案 1 :(得分:2)
正如wgcrouch
在他的回答中所建议的那样,prop-types
lib不提供此功能,因此使用自定义道具类型是可行的方法。
幸运的是,正如Tom Fenech在我的问题评论中指出的那样,这个特殊问题已经解决了,所以我可以使用npm包:react-required-if。
我的工作解决方案如下:
import React from 'react';
import PropTypes from 'prop-types';
import requiredIf from 'react-required-if';
function MyComponent({ config }) {
if (!config.active) {
return null;
}
return <h1>Hello {config.foo.bar}!</h1>;
}
MyComponent.propTypes = {
config: PropTypes.shape({
active: PropTypes.bool.isRequired,
foo: requiredIf(
PropTypes.shape({
bar: PropTypes.string.isRequired
}),
props => props.active
)
})
};
export default MyComponent;