Boron ===== [![Pair on this](https://tf-assets-staging.s3.amazonaws.com/badges/thinkful_repo_badge.svg)](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(); }, render: function() { return (

I am a dialog

); } }); ``` ## Props * className - Add custom class name. * keyboard - 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. * 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 # 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 (

I am a dialog

); } }); ``` 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 (

I am a dialog

); } }); ``` ## Modals * DropModal * FadeModal * FlyModal * OutlineModal * ScaleModal * WaveModal ## Browser Support ![IE](https://raw.github.com/alrra/browser-logos/master/internet-explorer/internet-explorer_48x48.png) | ![Chrome](https://raw.github.com/alrra/browser-logos/master/chrome/chrome_48x48.png) | ![Firefox](https://raw.github.com/alrra/browser-logos/master/firefox/firefox_48x48.png) | ![Opera](https://raw.github.com/alrra/browser-logos/master/opera/opera_48x48.png) | ![Safari](https://raw.github.com/alrra/browser-logos/master/safari/safari_48x48.png) --- | --- | --- | --- | --- | IE 10+ ✔ | Chrome 4.0+ ✔ | Firefox 16.0+ ✔ | Opera 15.0+ ✔ | Safari 4.0+ ✔ |

boron

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Sick of boring JavaScript newsletters?

Downloads in past