Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bold-commerce/reboron
A collection of dialog animations with React.js
https://github.com/bold-commerce/reboron
Last synced: about 2 months ago
JSON representation
A collection of dialog animations with React.js
- Host: GitHub
- URL: https://github.com/bold-commerce/reboron
- Owner: bold-commerce
- License: mit
- Fork: true (yuanyan/boron)
- Created: 2017-06-28T02:03:01.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-30T01:45:48.000Z (over 6 years ago)
- Last Synced: 2024-04-25T06:42:27.335Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.99 MB
- Stars: 28
- Watchers: 5
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-react-components - reboron - A collection of dialog animations with React.js (UI Components / Overlay)
- awesome-react - reboron - A collection of dialog animations with React.js.  (UI Components / Dialog/Modal/Alert)
README
Reboron
=====
A collection of dialog animations with React.js.
* Demo - [https://jerairrest.github.io/reboron/](https://jerairrest.github.io/reboron/)
## About
This is a fork of http://yuanyan.github.io/boron/ that has fixes for the deprecation warnings in React 15.*. I will be working on updating this package to use es6 as well as fixing some of the issues in the main package. PRs welcome!
## Installation
The easiest way to use `reboron` is to install it from NPM and include it in your own React build process
```
npm install reboron --save
```
## Usage
``` javascript
import React, { Component } from 'react';
import Modal from 'reboron/DropModal';
class Example extends Component {
constructor(props) {
super(props);
}
showModal() {
this.refs.modal.show();
}
hideModal() {
this.refs.modal.hide();
}
callback(evt) {
console.log(evt);
}
render() {
return (
this.showModal() }>Open
this.callback() }>
I am a dialog
this.hideModal() }>Close
);
}
}
export default Example;
```
## 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.
* duration - duration in milliseconds before the modal is hidden
* 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
* timeout - timeout 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
* rectStyle - CSS styles to apply to the modal's rectangle _(OutlineModal only)_
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
import React, { Component } from 'react';
import Modal from 'reboron/ScaleModal';
// Style object
const modalStyle = {
width: '80%',
};
class Example extends Component {
showModal() {
this.refs.modal.show();
}
hideModal() {
this.refs.modal.hide();
}
render() {
return (
this.showModal() }>Open
I am a dialog
this.hideModal() }>Close
);
}
}
export default Example;
```
Red backdrop with a blue modal, rotated at 45 degrees:
``` javascript
import React, { Component } from 'react';
import Modal from 'reboron/FlyModal';
// Individual styles for the modal, modal content, and backdrop
const modalStyle = {
transform: 'rotate(45deg) translateX(-50%)',
};
const backdropStyle = {
backgroundColor: 'red',
};
const contentStyle = {
backgroundColor: 'blue',
height: '100%',
};
class Example extends Component {
showModal() {
this.refs.modal.show();
}
hideModal() {
this.refs.modal.hide();
}
render() {
return (
this.showModal() }>Open
I am a dialog
this.hideModal() }>Close
);
}
}
export default Example;
```
## Modals
* DropModal
* FadeModal
* FlyModal
* OutlineModal
* ScaleModal
* WaveModal
## License
Reboron is [MIT licensed](./LICENSE).