Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/458679 #538

Closed
wants to merge 3 commits into from
Closed

Fix/458679 #538

wants to merge 3 commits into from

Conversation

anastasiya29
Copy link
Contributor

Fix prop-types for errorComponent (this is a Placeholder prop in the react package)

Motivation

This fixes a bug where passing a custom error component via the errorComponent prop (as described in the docs) caused an "Invalid prop" error.

How Has This Been Tested?

Unit tests added.
Manual tests on react sample app.

  1. Create a new CustomError component
  2. Update Layout.js to pass a react component to the errorComponent prop to Placeholder <Placeholder errorComponent={CustomError} />
  3. Verify that Home page renders without errors in disconnected and in EE
  4. Update ContentBlock component to throw an error
  5. Verify that CustomError is rendered on Home page instead of ContentBlock
  6. Update Layout.js to pass a renderProp function to the errorComponent prop to Placeholder <Placeholder errorComponent={() => <div>Error</div>} />
  7. Verify that "Error" is rendered on Home page instead of ContentBlock

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update (non-breaking change; modified files are limited to the /docs directory)

Checklist:

  • [ x] I have read the Contributing guide.
  • [ x] My code follows the code style of this project.
  • [ x] My code/comments/docs fully adhere to the Code of Conduct.
  • My change is a code change and it requires an update to the documentation.
  • My change is a documentation change and it requires an update to the navigation.

Copy link
Contributor

@ambrauer ambrauer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just the one comment re: coverage, and appears there may be linting errors based on the failed checks? Otherwise looks good to me.

packages/sitecore-jss-react/package.json Show resolved Hide resolved
@ambrauer
Copy link
Contributor

Also, should this fix be mentioned in doc release notes?

@anastasiya29 anastasiya29 deleted the fix/458679 branch February 17, 2021 19:58
@anastasiya29 anastasiya29 mentioned this pull request Feb 17, 2021
anastasiya29 added a commit that referenced this pull request Feb 24, 2021
Add PR #538 to bug fixes and restore incorrect removal of PR #459 from breaking changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants