PropTypes ใ็จใใๅใใงใใฏ
ใใฎ่จไบใฏๅคใใชใฃใฆใใใไปๅพๆดๆฐใใใพใใใๆฐใใ React ๆฅๆฌ่ชใใญใฅใกใณใใงใใ ja.react.dev ใใๅฉ็จใใ ใใใ
PropTypes ใฏใขใใณใช React ใงใฏใใพใไฝฟใใใชใใชใฃใฆใใพใใ้็ๅใใงใใฏใซใฏ TypeScript ใๅฉ็จใใฆใใ ใใใ
ๆณจๆ:
React.PropTypes ใฏ React v15.5 ใซใใใฆๅฅใใใฑใผใธใซ็งปๅใใพใใใไปฃใใใซ
prop-types
ใฉใคใใฉใชใๅฉ็จใใใใใซใใฆใใ ใใใใณใผใใ่ชๅใงๅคๆใใใใใฎ codemod ในใฏใชใใใๆไพใใฆใใพใใ
ใขใใชใฑใผใทใงใณใๆ้ทใใใซใคใใฆใๅใใงใใฏใซใใฃใฆๅคใใฎไธๅ
ทๅใ่ฆใคใใใใใใใซใชใใพใใใขใใชใฑใผใทใงใณใซใใฃใฆใฏใFlow ใใใใฏ TypeScript ใฎใใใช JavaScript ๆกๅผตใไฝฟใฃใฆใขใใชใฑใผใทใงใณๅ
จไฝใฎๅใใงใใฏใ่กใใใจใใงใใใงใใใใใใใใใใใไฝฟ็จใใใจใใReact ใฏ็ตใฟ่พผใฟใฎๅใใงใใฏๆฉ่ฝใๅใใฆใใพใใใณใณใใผใใณใใฎ props ใซๅใใงใใฏใ่กใใใใซใ็นๅฅใช propTypes
ใใญใใใฃใๅฒๅฝใฆใใใจใใงใใพใใ
import PropTypes from 'prop-types';
class Greeting extends React.Component {
render() {
return (
<h1>Hello, {this.props.name}</h1>
);
}
}
Greeting.propTypes = {
name: PropTypes.string
};
ใใฎไพใงใฏใฏใฉในใณใณใใผใใณใใไฝฟใฃใฆใใพใใใๅๆงใฎๆฉ่ฝใฏ้ขๆฐใณใณใใผใใณใใ React.memo
ใใใณ React.forwardRef
ใงไฝใฃใใณใณใใผใใณใใงใไฝฟ็จใงใใพใใ
PropTypes
ใฏๅใๅใฃใใใผใฟใๆๅนใใฉใใใ็ขบ่ชใใใใใซไฝฟ็จใงใใ็จฎใ
ใฎใใชใใผใฟใผใใจใฏในใใผใใใฆใใพใใไธ่จใฎไพใงใฏใPropTypes.string
ใไฝฟ็จใใฆใใพใใ็กๅนใชๅคใใใญใใใฃใซไธใใใใๅ ดๅใJavaScript ใฎใณใณใฝใผใซใซ่ญฆๅๆใๅบๅใใใพใใใใใฉใผใใณในไธใฎ็็ฑใใใpropTypes
ใฎใใงใใฏใฏ้็บใขใผใใงใฎใฟ่กใใใพใใ
PropTypes
PropTypes ใซใใฃใฆๆไพใใใฆใใๆงใ ใชใใชใใผใฟใผใฎๅฎไพใ็ดนไปใใพใใ
import PropTypes from 'prop-types';
MyComponent.propTypes = {
// You can declare that a prop is a specific JS type. By default, these
// are all optional.
optionalArray: PropTypes.array,
optionalBool: PropTypes.bool,
optionalFunc: PropTypes.func,
optionalNumber: PropTypes.number,
optionalObject: PropTypes.object,
optionalString: PropTypes.string,
optionalSymbol: PropTypes.symbol,
// Anything that can be rendered: numbers, strings, elements or an array
// (or fragment) containing these types.
optionalNode: PropTypes.node,
// A React element.
optionalElement: PropTypes.element,
// A React element type (ie. MyComponent).
optionalElementType: PropTypes.elementType,
// You can also declare that a prop is an instance of a class. This uses
// JS's instanceof operator.
optionalMessage: PropTypes.instanceOf(Message),
// You can ensure that your prop is limited to specific values by treating
// it as an enum.
optionalEnum: PropTypes.oneOf(['News', 'Photos']),
// An object that could be one of many types
optionalUnion: PropTypes.oneOfType([
PropTypes.string,
PropTypes.number,
PropTypes.instanceOf(Message)
]),
// An array of a certain type
optionalArrayOf: PropTypes.arrayOf(PropTypes.number),
// An object with property values of a certain type
optionalObjectOf: PropTypes.objectOf(PropTypes.number),
// An object taking on a particular shape
optionalObjectWithShape: PropTypes.shape({
color: PropTypes.string,
fontSize: PropTypes.number
}),
// An object with warnings on extra properties
optionalObjectWithStrictShape: PropTypes.exact({
name: PropTypes.string,
quantity: PropTypes.number
}),
// You can chain any of the above with `isRequired` to make sure a warning
// is shown if the prop isn't provided.
requiredFunc: PropTypes.func.isRequired,
// A required value of any data type
requiredAny: PropTypes.any.isRequired,
// You can also specify a custom validator. It should return an Error
// object if the validation fails. Don't `console.warn` or throw, as this
// won't work inside `oneOfType`.
customProp: function(props, propName, componentName) {
if (!/matchme/.test(props[propName])) {
return new Error(
'Invalid prop `' + propName + '` supplied to' +
' `' + componentName + '`. Validation failed.'
);
}
},
// You can also supply a custom validator to `arrayOf` and `objectOf`.
// It should return an Error object if the validation fails. The validator
// will be called for each key in the array or object. The first two
// arguments of the validator are the array or object itself, and the
// current item's key.
customArrayProp: PropTypes.arrayOf(function(propValue, key, componentName, location, propFullName) {
if (!/matchme/.test(propValue[key])) {
return new Error(
'Invalid prop `' + propFullName + '` supplied to' +
' `' + componentName + '`. Validation failed.'
);
}
})
};
ๅไธใฎๅญ่ฆ็ด ใ่ฆๆฑใใ
PropTypes.element
ใไฝฟใใใจใงใใณใณใใผใใณใใซๅไธใฎๅญ่ฆ็ด ใใๆธกใใชใใใจใๆๅฎใใใใจใใงใใพใใ
import PropTypes from 'prop-types';
class MyComponent extends React.Component {
render() {
// This must be exactly one element or it will warn.
const children = this.props.children;
return (
<div>
{children}
</div>
);
}
}
MyComponent.propTypes = {
children: PropTypes.element.isRequired
};
props ใฎใใใฉใซใๅค
defaultProps
ใจใใใใญใใใฃใๅฒใๅฝใฆใใใจใงใprops
ใซๅคใๆธกใใใชใใฃใ้ใฎใใใฉใซใๅคใๅฎ็พฉใใใใจใใงใใพใใ
class Greeting extends React.Component {
render() {
return (
<h1>Hello, {this.props.name}</h1>
);
}
}
// Specifies the default values for props:
Greeting.defaultProps = {
name: 'Stranger'
};
// Renders "Hello, Stranger":
const root = ReactDOM.createRoot(document.getElementById('example'));
root.render(<Greeting />);
ES2022 ไปฅ้ใฏใReact ใฎใณใณใใผใใณใใฏใฉในๅ
ใงใdefaultProps
ใ้็ใชใใญใใใฃใจใใฆๅฎฃ่จใใใใจใใงใใพใใ่ฉณ็ดฐใฏใฏใฉในใฎใใใชใใฏ้็ใใฃใผใซใใๅ็
งใใฆใใ ใใใใใใฏใขใใณใชๆงๆใงใใๅคใใใฉใฆใถใงใฏใณใณใใคใซๆ้ ใๅฟ
่ฆใงใใ
class Greeting extends React.Component {
static defaultProps = {
name: 'stranger'
}
render() {
return (
<div>Hello, {this.props.name}</div>
)
}
}
defaultProps
ใไฝฟใใฐใthis.props.name
ใ่ฆชใณใณใใผใใณใใใๅคใๆๅฎใใใชใใฃใๅ ดๅใงใๅคใไปฃๅ
ฅใใใฆใใใใจใไฟ่จผใงใใพใใpropTypes
ใซใใๅใใงใใฏใฏ defaultProps
ใ่งฃๆฑบใใๅพใซ่กใใใใใใdefaultProps
ใซใๅใใงใใฏใ้ฉ็จใใใพใใ
้ขๆฐใณใณใใผใใณใ
ๆฎๆฎตใฎ้็บใง้ขๆฐใณใณใใผใใณใใๅฉ็จใใฆใใๅ ดๅใๆญฃใใ PropTypes ใ้ฉ็จใใใใใใซๅฐใใชๅคๆดใๅ ใใๅฟ ่ฆใใใใใใใใพใใใ
ไปฅไธใฎใใใชใณใณใใผใใณใใใใใจใใพใใใ๏ผ
export default function HelloWorldComponent({ name }) {
return (
<div>Hello, {name}</div>
)
}
PropTypes ใๅ ใใใใใซใฏใใจใฏในใใผใใใๅใซใณใณใใผใใณใใไปฅไธใฎใใใซๅฅใฎ้ขๆฐใจใใฆๅฎฃ่จใใๅฟ ่ฆใใใใพใ๏ผ
function HelloWorldComponent({ name }) {
return (
<div>Hello, {name}</div>
)
}
export default HelloWorldComponent
ใใใง HelloWorldComponent
ใซ PropTypes ใๅ ใใใใจใใงใใใใใซใชใใพใ๏ผ
import PropTypes from 'prop-types'
function HelloWorldComponent({ name }) {
return (
<div>Hello, {name}</div>
)
}
HelloWorldComponent.propTypes = {
name: PropTypes.string
}
export default HelloWorldComponent