Skip to content

Commit

Permalink
Warns on access of props.key and props.ref
Browse files Browse the repository at this point in the history
  • Loading branch information
ManasJayanth committed Dec 29, 2015
1 parent 51295bf commit 63a3ea8
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 0 deletions.
32 changes: 32 additions & 0 deletions src/isomorphic/classic/element/ReactElement.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
var ReactCurrentOwner = require('ReactCurrentOwner');

var assign = require('Object.assign');
var warning = require('warning');
var canDefineProperty = require('canDefineProperty');

// The Symbol used to tag the ReactElement type. If there is no native Symbol
Expand Down Expand Up @@ -159,6 +160,37 @@ ReactElement.createElement = function(type, config, children) {
}
}

if (__DEV__) {
// Create dummy `key` and `ref` property to `props` to warn users
// against its use
Object.defineProperty(props, 'key', {
get: function () {
warning(
false,
'%s: `key` is not a prop. Trying to access it will result ' +
'in `undefined` being returned. If you need to access the same ' +
'value within the child component, you should pass it as a different ' +
'prop. (http://stackoverflow.com/questions/33682774/how-to-access-the' +
'-key-property-from-a-reactjs-component)',
'displayName' in type ? type.displayName: 'Element'
);
}
});
Object.defineProperty(props, 'ref', {
get: function () {
warning(
false,
'%s: `ref` is not a prop. Trying to access it will result ' +
'in `undefined` being returned. If you need to access the same ' +
'value within the child component, you should pass it as a different ' +
'prop. (http://stackoverflow.com/questions/33682774/how-to-access-the' +
'-key-property-from-a-reactjs-component)',
'displayName' in type ? type.displayName: 'Element'
);
}
});
}

return ReactElement(
type,
key,
Expand Down
60 changes: 60 additions & 0 deletions src/isomorphic/classic/element/__tests__/ReactElement-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,66 @@ describe('ReactElement', function() {
expect(element.props).toEqual(expectation);
});

it('should warn when `key` is being accessed', function() {
spyOn(console, 'error');
var container = document.createElement('div');
var Child = React.createClass({
render: function() {
return <div> {this.props.key} </div>
},
});
var Parent = React.createClass({
render: function() {
return (
<div>
<Child key="0" />
<Child key="1" />
<Child key="2" />
</div>
);
},
});
expect(console.error.calls.length).toBe(0);
ReactDOM.render(<Parent />, container);
expect(console.error.calls.length).toBe(3);
expect(console.error.argsForCall[0][0]).toContain(
'Child: `key` is not a prop. Trying to access it will result ' +
'in `undefined` being returned. If you need to access the same ' +
'value within the child component, you should pass it as a different ' +
'prop. (http://stackoverflow.com/questions/33682774/how-to-access-the' +
'-key-property-from-a-reactjs-component)'
);
});

it('should warn when `ref` is being accessed', function() {
spyOn(console, 'error');
var container = document.createElement('div');
var Child = React.createClass({
render: function() {
return <div> {this.props.ref} </div>
},
});
var Parent = React.createClass({
render: function() {
return (
<div>
<Child ref="childElement" />
</div>
);
},
});
expect(console.error.calls.length).toBe(0);
ReactDOM.render(<Parent />, container);
expect(console.error.calls.length).toBe(1);
expect(console.error.argsForCall[0][0]).toContain(
'Child: `ref` is not a prop. Trying to access it will result ' +
'in `undefined` being returned. If you need to access the same ' +
'value within the child component, you should pass it as a different ' +
'prop. (http://stackoverflow.com/questions/33682774/how-to-access-the' +
'-key-property-from-a-reactjs-component)'
);
});

it('allows a string to be passed as the type', function() {
var element = React.createFactory('div')();
expect(element.type).toBe('div');
Expand Down

0 comments on commit 63a3ea8

Please sign in to comment.