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

[added] The ability to decide whether the modal should be closed when clicking the overlay area #128

Merged
merged 1 commit into from
Mar 26, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,22 @@ var App = React.createClass({
ReactDOM.render(<App/>, appElement);
```

By default the modal is closed when clicking outside of it (the overlay area). If you want to prevent this behavior you can
pass the 'shouldCloseOnOverlayClick' prop with 'false' value.
```xml
<Modal
isOpen={bool}
onRequestClose={fn}
closeTimeoutMS={n}
shouldCloseOnOverlayClick={false}
style={customStyle}>

<h1>Force Modal</h1>
<p>Modal cannot be closed when clickig the overlay area</p>
<button onClick={handleCloseFunc}>Close Modal...</button>
</Modal>
```

# Demos
* http://reactjs.github.io/react-modal/
* http://reactjs.github.io/react-modal/bootstrap
6 changes: 4 additions & 2 deletions lib/components/Modal.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,16 @@ var Modal = module.exports = React.createClass({
appElement: React.PropTypes.instanceOf(SafeHTMLElement),
onRequestClose: React.PropTypes.func,
closeTimeoutMS: React.PropTypes.number,
ariaHideApp: React.PropTypes.bool
ariaHideApp: React.PropTypes.bool,
shouldCloseOnOverlayClick: React.PropTypes.bool
},

getDefaultProps: function () {
return {
isOpen: false,
ariaHideApp: true,
closeTimeoutMS: 0
closeTimeoutMS: 0,
shouldCloseOnOverlayClick: true
};
},

Expand Down
10 changes: 6 additions & 4 deletions lib/components/ModalPortal.js
Original file line number Diff line number Diff line change
Expand Up @@ -146,10 +146,12 @@ var ModalPortal = module.exports = React.createClass({
},

handleOverlayClick: function() {
if (this.ownerHandlesClose())
this.requestClose();
else
this.focusContent();
if (this.props.shouldCloseOnOverlayClick) {
if (this.ownerHandlesClose())
this.requestClose();
else
this.focusContent();
}
},

requestClose: function() {
Expand Down
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,12 @@
"karma-mocha": "0.2.0",
"karma-safari-launcher": "^0.1.1",
"mocha": "2.3.3",
"react": "^0.14.0",
"react-addons-test-utils": "^0.14.0",
"react-dom": "^0.14.0",
"react": "^0.14.0",
"reactify": "^1.1.1",
"rf-release": "0.4.0",
"sinon": "^1.17.3",
"uglify-js": "2.4.24",
"webpack-dev-server": "1.11.0"
},
Expand All @@ -65,4 +66,4 @@
"react": "global:React",
"react-dom": "global:ReactDOM"
}
}
}
55 changes: 53 additions & 2 deletions specs/Modal.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ var Modal = require('../lib/components/Modal');
var Simulate = TestUtils.Simulate;
var ariaAppHider = require('../lib/helpers/ariaAppHider');
var button = ReactDOM.button;
var sinon = require('sinon');

describe('Modal', function () {

Expand Down Expand Up @@ -74,6 +75,7 @@ describe('Modal', function () {
equal(props.isOpen, false);
equal(props.ariaHideApp, true);
equal(props.closeTimeoutMS, 0);
equal(props.shouldCloseOnOverlayClick, true);
ReactDOM.unmountComponentAtNode(node);
ariaAppHider.resetForTesting();
});
Expand All @@ -94,13 +96,13 @@ describe('Modal', function () {

it('supports custom className', function() {
var modal = renderModal({isOpen: true, className: 'myClass'});
equal(modal.portal.refs.content.className.contains('myClass'), true);
notEqual(modal.portal.refs.content.className.indexOf('myClass'), -1);
unmountModal();
});

it('supports overlayClassName', function () {
var modal = renderModal({isOpen: true, overlayClassName: 'myOverlayClass'});
equal(modal.portal.refs.overlay.className.contains('myOverlayClass'), true);
notEqual(modal.portal.refs.overlay.className.indexOf('myOverlayClass'), -1);
unmountModal();
});

Expand Down Expand Up @@ -145,6 +147,55 @@ describe('Modal', function () {
unmountModal();
});

describe('should close on overlay click', function() {
afterEach('Unmount modal', function() {
unmountModal();
});

describe('verify props', function() {
it('verify default prop of shouldCloseOnOverlayClick', function () {
var modal = renderModal({isOpen: true});
equal(modal.props.shouldCloseOnOverlayClick, true);
});

it('verify prop of shouldCloseOnOverlayClick', function () {
var modal = renderModal({isOpen: true, shouldCloseOnOverlayClick: false});
equal(modal.props.shouldCloseOnOverlayClick, false);
});
});

describe('verify clicks', function() {
it('verify overlay click when shouldCloseOnOverlayClick sets to false', function () {
var requestCloseCallback = sinon.spy();
var modal = renderModal({
isOpen: true,
shouldCloseOnOverlayClick: false
});
equal(modal.props.isOpen, true);
var overlay = TestUtils.scryRenderedDOMComponentsWithClass(modal.portal, 'ReactModal__Overlay');
equal(overlay.length, 1);
Simulate.click(overlay[0]); // click the overlay
ok(!requestCloseCallback.called)
});

it('verify overlay click when shouldCloseOnOverlayClick sets to true', function() {
var requestCloseCallback = sinon.spy();
var modal = renderModal({
isOpen: true,
shouldCloseOnOverlayClick: true,
onRequestClose: function() {
requestCloseCallback();
}
});
equal(modal.props.isOpen, true);
var overlay = TestUtils.scryRenderedDOMComponentsWithClass(modal.portal, 'ReactModal__Overlay');
equal(overlay.length, 1);
Simulate.click(overlay[0]); // click the overlay
ok(requestCloseCallback.called)
});
});
});

//it('adds --before-close for animations', function() {
//var node = document.createElement('div');

Expand Down
1 change: 1 addition & 0 deletions specs/helper.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ var Modal = React.createFactory(require('../lib/components/Modal'));

ok = assert.ok;
equal = assert.equal;
notEqual = assert.notEqual;
strictEqual = assert.strictEqual;
throws = assert.throws;

Expand Down