Update README for issue close modal when user click on overlay #352
Conversation
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
claydiffrient
suggested changes
Mar 10, 2017
There was a problem hiding this comment.
Thanks so much @SLyHuy for the PR. I think we need to change it up a bit though. If you could make the changes I suggested, I'd be happy to merge it.
README.md
Outdated
| @@ -220,7 +220,7 @@ When using React Test Utils with this library, here are some things to keep in m | |||
| - You need to use the `.portal` property, as in `ReactDOM.findDOMNode(renderedModal.portal)` or `TestUtils.scryRenderedDOMComponentsWithClass(Modal.portal, 'my-modal-class')` to acquire a handle to the inner contents of your modal. | |||
|
|
|||
| By default the modal is closed when clicking outside of it (the overlay area). If you want to prevent this behavior you can | |||
There was a problem hiding this comment.
Hmm... maybe this whole section should read more like:
By default the modal will attempt to close when clicking outside of it (on the overlay area). Because the open and closed state of the modal should be controlled outside of the modal, you need to provide the `onRequestClose` function prop to actually set the state. If you want to prevent the overlay close behavior, you should pass the `shouldCloseOnOverlayClick` props as `false`.
SLyHuy
commented
Mar 10, 2017
README.md
Outdated
| @@ -220,7 +220,7 @@ When using React Test Utils with this library, here are some things to keep in m | |||
| - You need to use the `.portal` property, as in `ReactDOM.findDOMNode(renderedModal.portal)` or `TestUtils.scryRenderedDOMComponentsWithClass(Modal.portal, 'my-modal-class')` to acquire a handle to the inner contents of your modal. | |||
|
|
|||
| By default the modal is closed when clicking outside of it (the overlay area). If you want to prevent this behavior you can | |||
claydiffrient
approved these changes
Mar 10, 2017
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
#351