Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yuanyan/boron
A collection of dialog animations with React.js
https://github.com/yuanyan/boron
Last synced: 5 days ago
JSON representation
A collection of dialog animations with React.js
- Host: GitHub
- URL: https://github.com/yuanyan/boron
- Owner: yuanyan
- License: mit
- Created: 2015-04-06T11:03:36.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-10-09T19:51:02.000Z (about 5 years ago)
- Last Synced: 2024-04-04T07:46:09.410Z (8 months ago)
- Language: JavaScript
- Homepage: https://yuanyan.github.io/boron
- Size: 1.87 MB
- Stars: 1,482
- Watchers: 30
- Forks: 155
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-react-components-all - boron - A collection of dialog animations with React.js. (Uncategorized / Uncategorized)
- awesome-list - boron - A collection of dialog animations with React.js. (Demos / JBoss Data Virtualization)
- awesome-react-components - boron - A collection of dialog animations with React.js. (UI Components / Overlay)
- awesome-react-components - boron - A collection of dialog animations with React.js. (UI Components / Overlay)
README
Boron [](http://badge.fury.io/js/boron)
=====
[](http://start.thinkful.com/react/?utm_source=github&utm_medium=badge&utm_campaign=boron)
A collection of dialog animations with React.js.
* React 0.14+ Use `boron 0.2`
* React 0.12+ Use `boron 0.1`
## Demo & Examples
Live demo: [yuanyan.github.io/boron](http://yuanyan.github.io/boron/)
To build the examples locally, run:
```
npm install
gulp dev
```
Then open [`localhost:9999`](http://localhost:9999) in a browser.
## Installation
The easiest way to use `boron` is to install it from NPM and include it in your own React build process (using [Browserify](http://browserify.org), etc).
You can also use the standalone build by including `dist/boron.js` in your page. If you use this, make sure you have already included React, and it is available as a global variable.
```
npm install boron --save
```
## Usage
``` javascript
var Modal = require('boron/DropModal');
var Example = React.createClass({
showModal: function(){
this.refs.modal.show();
},
hideModal: function(){
this.refs.modal.hide();
},
callback: function(event){
console.log(event);
},
render: function() {
return (
Open
I am a dialog
Close
);
}
});
```
## Props
* className - Add custom class name.
* keyboard - Receive a callback function or a boolean to choose to close the modal when escape key is pressed.
* backdrop - Includes a backdrop element.
* closeOnClick - Close the backdrop element when clicked.
* onShow - Show callback.
* onHide - Hide callback. Argument is the source of the hide action, one of:
* hide - hide() method is the cause of the hide.
* toggle - toggle() method is the cause of the hide
* keyboard - keyboard (escape key) is the cause of the hide
* backdrop - backdrop click is the cause of the hide
* [any] - custom argument passed by invoking code into the hide() method when called directly.
* modalStyle - CSS styles to apply to the modal
* backdropStyle - CSS styles to apply to the backdrop
* contentStyle - CSS styles to apply to the modal's content
Note: If the hide() method is called directly, a custom source string can be
passed as the argument, as noted above. For example, this might be useful if
if multiple actions could cause the hide and it was desirable to know which of those
actions was the trigger for the given onHide callback).
# Custom Styles
Objects consisting of CSS properties/values can be passed as props to the Modal component.
The values for the CSS properties will either add new properties or override the default property value set for that Modal type.
Modal with 80% width:
``` javascript
var Modal = require('boron/ScaleModal');
// Style object
var modalStyle = {
width: '80%'
};
var Example = React.createClass({
showModal: function(){
this.refs.modal.show();
},
hideModal: function(){
this.refs.modal.hide();
},
render: function() {
return (
Open
I am a dialog
Close
);
}
});
```
Red backdrop with a blue modal, rotated at 45 degrees:
``` javascript
var Modal = require('boron/FlyModal');
// Individual styles for the modal, modal content, and backdrop
var modalStyle = {
transform: 'rotate(45deg) translateX(-50%)',
};
var backdropStyle = {
backgroundColor: 'red'
};
var contentStyle = {
backgroundColor: 'blue',
height: '100%'
};
var Example = React.createClass({
showModal: function(){
this.refs.modal.show();
},
hideModal: function(){
this.refs.modal.hide();
},
render: function() {
return (
Open
I am a dialog
Close
);
}
});
```
## Modals
* DropModal
* FadeModal
* FlyModal
* OutlineModal
* ScaleModal
* WaveModal
## Browser Support
 |  |  |  | 
--- | --- | --- | --- | --- |
IE 10+ ✔ | Chrome 4.0+ ✔ | Firefox 16.0+ ✔ | Opera 15.0+ ✔ | Safari 4.0+ ✔ |
## License
Boron is [MIT licensed](./LICENSE).