{"componentChunkName":"component---src-templates-docs-js","path":"/warnings/unknown-prop.html","result":{"data":{"markdownRemark":{"html":"

The unknown-prop warning will fire if you attempt to render a DOM element with a prop that is not recognized by React as a legal DOM attribute/property. You should ensure that your DOM elements do not have spurious props floating around.

\n

There are a couple of likely reasons this warning could be appearing:

\n
    \n
  1. Are you using {...this.props} or cloneElement(element, this.props)? Your component is transferring its own props directly to a child element (eg. transferring props). When transferring props to a child component, you should ensure that you are not accidentally forwarding props that were intended to be interpreted by the parent component.
    2. \n
  2. You are using a non-standard DOM attribute on a native DOM node, perhaps to represent custom data. If you are trying to attach custom data to a standard DOM element, consider using a custom data attribute as described on MDN.
    3. \n
  3. React does not yet recognize the attribute you specified. This will likely be fixed in a future version of React. However, React currently strips all unknown attributes, so specifying them in your React app will not cause them to be rendered.
    4. \n
  4. You are using a React component without an upper case. React interprets it as a DOM tag because React JSX transform uses the upper vs. lower case convention to distinguish between user-defined components and DOM tags.
    5. \n
\n
\n

To fix this, composite components should “consume” any prop that is intended for the composite component and not intended for the child component. Example:

\n

Bad: Unexpected layout prop is forwarded to the div tag.

\n
function MyDiv(props) {\n  if (props.layout === 'horizontal') {\n    // BAD! Because you know for sure \"layout\" is not a prop that <div> understands.\n    return <div {...props} style={getHorizontalStyle()} />\n  } else {\n    // BAD! Because you know for sure \"layout\" is not a prop that <div> understands.\n    return <div {...props} style={getVerticalStyle()} />\n  }\n}
\n

Good: The spread operator can be used to pull variables off props, and put the remaining props into a variable.

\n
function MyDiv(props) {\n  const { layout, ...rest } = props\n  if (layout === 'horizontal') {\n    return <div {...rest} style={getHorizontalStyle()} />\n  } else {\n    return <div {...rest} style={getVerticalStyle()} />\n  }\n}
\n

Good: You can also assign the props to a new object and delete the keys that you’re using from the new object. Be sure not to delete the props from the original this.props object, since that object should be considered immutable.

\n
function MyDiv(props) {\n\n  const divProps = Object.assign({}, props);\n  delete divProps.layout;\n\n  if (props.layout === 'horizontal') {\n    return <div {...divProps} style={getHorizontalStyle()} />\n  } else {\n    return <div {...divProps} style={getVerticalStyle()} />\n  }\n}
","frontmatter":{"title":"Unknown Prop Warning","next":null,"prev":null},"fields":{"path":"content/warnings/unknown-prop.md","slug":"warnings/unknown-prop.html"}}},"pageContext":{"slug":"warnings/unknown-prop.html"}},"staticQueryHashes":[]}