ForwardRefs supports propTypes #12911
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| /** | ||
| * Copyright (c) 2013-present, Facebook, Inc. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| * | ||
| * @emails react-core | ||
| */ | ||
|
|
||
| 'use strict'; | ||
|
|
||
| describe('forwardRef', () => { | ||
| let PropTypes; | ||
| let React; | ||
| let ReactNoop; | ||
|
|
||
| beforeEach(() => { | ||
| jest.resetModules(); | ||
| PropTypes = require('prop-types'); | ||
| React = require('react'); | ||
| ReactNoop = require('react-noop-renderer'); | ||
| }); | ||
|
|
||
| it('should update refs when switching between children', () => { | ||
| function FunctionalComponent({forwardedRef, setRefOnDiv}) { | ||
| return ( | ||
| <section> | ||
| <div ref={setRefOnDiv ? forwardedRef : null}>First</div> | ||
| <span ref={setRefOnDiv ? null : forwardedRef}>Second</span> | ||
| </section> | ||
| ); | ||
| } | ||
|
|
||
| const RefForwardingComponent = React.forwardRef((props, ref) => ( | ||
| <FunctionalComponent {...props} forwardedRef={ref} /> | ||
| )); | ||
|
|
||
| const ref = React.createRef(); | ||
|
|
||
| ReactNoop.render(<RefForwardingComponent ref={ref} setRefOnDiv={true} />); | ||
| ReactNoop.flush(); | ||
| expect(ref.current.type).toBe('div'); | ||
|
|
||
| ReactNoop.render(<RefForwardingComponent ref={ref} setRefOnDiv={false} />); | ||
| ReactNoop.flush(); | ||
| expect(ref.current.type).toBe('span'); | ||
| }); | ||
|
|
||
| it('should support rendering null', () => { | ||
| const RefForwardingComponent = React.forwardRef((props, ref) => null); | ||
|
|
||
| const ref = React.createRef(); | ||
|
|
||
| ReactNoop.render(<RefForwardingComponent ref={ref} />); | ||
| ReactNoop.flush(); | ||
| expect(ref.current).toBe(null); | ||
| }); | ||
|
|
||
| it('should support rendering null for multiple children', () => { | ||
| const RefForwardingComponent = React.forwardRef((props, ref) => null); | ||
|
|
||
| const ref = React.createRef(); | ||
|
|
||
| ReactNoop.render( | ||
| <div> | ||
| <div /> | ||
| <RefForwardingComponent ref={ref} /> | ||
| <div /> | ||
| </div>, | ||
| ); | ||
| ReactNoop.flush(); | ||
| expect(ref.current).toBe(null); | ||
| }); | ||
|
|
||
| it('should support propTypes and defaultProps', () => { | ||
| function FunctionalComponent({forwardedRef, optional, required}) { | ||
| return ( | ||
| <div ref={forwardedRef}> | ||
| {optional} | ||
| {required} | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| const RefForwardingComponent = React.forwardRef(function NamedFunction( | ||
| props, | ||
| ref, | ||
| ) { | ||
| return <FunctionalComponent {...props} forwardedRef={ref} />; | ||
| }); | ||
| RefForwardingComponent.propTypes = { | ||
| optional: PropTypes.string, | ||
| required: PropTypes.string.isRequired, | ||
| }; | ||
| RefForwardingComponent.defaultProps = { | ||
| optional: 'default', | ||
| }; | ||
|
|
||
| const ref = React.createRef(); | ||
|
|
||
| ReactNoop.render( | ||
| <RefForwardingComponent ref={ref} optional="foo" required="bar" />, | ||
| ); | ||
| ReactNoop.flush(); | ||
| expect(ref.current.children).toEqual([{text: 'foo'}, {text: 'bar'}]); | ||
|
|
||
| ReactNoop.render(<RefForwardingComponent ref={ref} required="foo" />); | ||
| ReactNoop.flush(); | ||
| expect(ref.current.children).toEqual([{text: 'default'}, {text: 'foo'}]); | ||
|
|
||
| expect(() => | ||
| ReactNoop.render(<RefForwardingComponent ref={ref} optional="foo" />), | ||
| ).toWarnDev( | ||
| 'Warning: Failed prop type: The prop `required` is marked as required in ' + | ||
| '`ForwardRef(NamedFunction)`, but its value is `undefined`.\n' + | ||
| ' in ForwardRef(NamedFunction) (at **)', | ||
| ); | ||
| }); | ||
|
|
||
| it('should warn if not provided a callback during creation', () => { | ||
| expect(() => React.forwardRef(undefined)).toWarnDev( | ||
| 'forwardRef requires a render function but was given undefined.', | ||
| ); | ||
| expect(() => React.forwardRef(null)).toWarnDev( | ||
| 'forwardRef requires a render function but was given null.', | ||
| ); | ||
| expect(() => React.forwardRef('foo')).toWarnDev( | ||
| 'forwardRef requires a render function but was given string.', | ||
| ); | ||
| }); | ||
|
|
||
| it('should warn if no render function is provided', () => { | ||
| expect(React.forwardRef).toWarnDev( | ||
| 'forwardRef requires a render function but was given undefined.', | ||
| ); | ||
| }); | ||
|
|
||
| it('should warn if the render function provided has propTypes or defaultProps attributes', () => { | ||
| function renderWithPropTypes() { | ||
| return null; | ||
| } | ||
| renderWithPropTypes.propTypes = {}; | ||
|
|
||
| function renderWithDefaultProps() { | ||
| return null; | ||
| } | ||
| renderWithDefaultProps.defaultProps = {}; | ||
|
|
||
| expect(() => React.forwardRef(renderWithPropTypes)).toWarnDev( | ||
| 'forwardRef render functions do not support propTypes or defaultProps. ' + | ||
| 'Did you accidentally pass a React component?', | ||
| ); | ||
| expect(() => React.forwardRef(renderWithDefaultProps)).toWarnDev( | ||
| 'forwardRef render functions do not support propTypes or defaultProps. ' + | ||
| 'Did you accidentally pass a React component?', | ||
| ); | ||
| }); | ||
| }); |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't it be
const propTypes = type.propTypesafter thetypeof typecheck, as that's the only value that it gets assigned?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current approach avoids reading
propTypesfrom a possiblenullorundefinedvalue (although that shouldn't actually happen in practice). I don't think it's a problem as-is.