react-modal icon indicating copy to clipboard operation
react-modal copied to clipboard

[added] update README regarding onAfterOpen and Jest

Open postrad opened this issue 4 years ago • 1 comments

Changes proposed:

  • Providing an additional section in the README related to the post v3.14.1 change to the behavior of the onAfterOpen prop and how it can break Jest tests related to it.

I am not sure if this is the best way to communicate this change, but I can speak from experience that this was an unexpectedly disruptive one in my organization, and hopefully this can spare others the time it took me to discover the source of a number of failing tests when I made the minor update.

Acceptance Checklist:

  • [x] The commit message follows the guidelines in CONTRIBUTING.md.
  • [x] Documentation (README.md) and examples have been updated as needed.
  • [x] If this is a code change, a spec testing the functionality has been added.
  • [x] If the commit message has [changed] or [removed], there is an upgrade path above.

postrad avatar Jun 10 '21 21:06 postrad

Coverage Status

Coverage remained the same at 84.737% when pulling 8c0f219d3c6221de27c4c7e7c498d6d9ae6ae38f on postrad:docs/on-after-open-jest into b33923a8756b0acb2bab8a7150320c4285710c5e on reactjs:master.

coveralls avatar Jun 10 '21 21:06 coveralls