Package Exports
- react-hyper-modal
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-hyper-modal) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
React hyper modal
Fully customizable and accessible modal react component
Welcome to the react hyper modal repository 😄 I want to introduce you to an awesome react component for displaying modal windows
Table of contents
Installation
You can use 
or 
package managers
$ npm i --save react-hyper-modalor
$ yarn add react-hyper-modalUsage
import React from 'react';
import HyperModal from 'react-hyper-modal';
...
class MyComponent extends React.Component {
constructor(props) {
super(props);
this.state = {
isModalOpen: false,
};
}
...
openModal => this.setState({ isModalOpen: true });
closeModal => this.setState({ isModalOpen: false });
...
render() {
const { isModalOpen } = this.state;
return (
<HyperModal
isOpen={isModalOpen}
requestClose={this.closeModal}
>
Your awesome modal content
</HyperModal>
);
}
}That's it! 🍰✨
Properties
You can find props types and default props below the table.
* - required props
| Props | Description |
|---|---|
| afterClose | callback that is called after closing |
| ariaEnabled | enable ARIA properties |
| ariaProps | custom ARIA properties |
| beforeClose | callback that is called before closing |
| childrenMode | describing if the modal content should be rendered as React Children |
| classes | overriding default modal class names |
| closeDebounceTimeout | time to close modal |
| closeIconPosition | position of close button |
| closeOnCloseIconClick | close the modal by pressing close button |
| closeOnDimmerClick | close the modal by pressing on dimmer |
| closeOnEscClick | close the modal by pressing ESC |
| dimmerEnabled | describing if the dimmer should be shown or not |
| isFullscreen | describing if the modal should be shown in full screen or not |
| isOpen * | describing if the modal should be shown or not |
| modalContentRef | reference to the modal content div |
| modalWrapperRef | reference to the modal wrapper div |
| portalMode | describing if the modal should be rendered in React Portal or not |
| portalNode | HTML node to create React Portal |
| position | setting the modal position |
| renderCloseIcon | callback for rendering custom close button |
| renderContent | callback for rendering custom modal content |
| requestClose * | callback to close the modal |
| unmountOnClose | describing if the modal should be unmounted when close |
Default properties
{
afterClose: undefined,
ariaEnabled: true,
ariaProps: {
'aria-describedby': 'hyper-modal-description',
'aria-labelledby': 'hyper-modal-title',
role: 'dialog',
},
beforeClose: undefined,
classes: undefined,
childrenMode: true,
closeDebounceTimeout: 0,
closeIconPosition: {
vertical: 'top',
horizontal: 'right',
},
closeOnCloseIconClick: true,
closeOnDimmerClick: true,
closeOnEscClick: true,
dimmerEnabled: true,
isFullscreen: false,
portalMode: false,
portalNode: undefined,
position: {
alignItems: 'center',
justifyContent: 'center',
},
renderCloseIcon: undefined,
renderContent: undefined,
}Types
type TModalPosition = 'flex-start' | 'center' | 'flex-end';
type THorizontalPosition = 'left' | 'center' | 'right';
type TVerticalPosition = 'top' | 'middle' | 'bottom';
interface IClassNamesProps {
closeIconClassName?: string;
contentClassName?: string;
dimmerClassName?: string;
portalWrapperClassName?: string;
wrapperClassName?: string;
}
interface IARIAProps {
'aria-describedby'?: string;
'aria-labelledby'?: string;
role?: string;
}
interface IPositionProps {
alignItems?: TModalPosition;
justifyContent?: TModalPosition;
}
interface ICloseIconPosition {
horizontal?: THorizontalPosition;
vertical?: TVerticalPosition;
}
interface IModalProps {
afterClose?: () => void;
ariaEnabled?: boolean;
ariaProps?: IARIAProps;
beforeClose?: () => void;
childrenMode?: boolean;
classes?: IClassNamesProps;
closeDebounceTimeout?: number;
closeIconPosition?: ICloseIconPosition;
closeOnCloseIconClick?: boolean;
closeOnDimmerClick?: boolean;
closeOnEscClick?: boolean;
dimmerEnabled?: boolean;
isFullscreen?: boolean;
isOpen: boolean;
modalContentRef?: React.RefObject<HTMLDivElement>;
modalWrapperRef?: React.RefObject<HTMLDivElement>;
portalMode?: boolean;
portalNode?: HTMLElement;
position?: IPositionProps;
renderCloseIcon?: () => JSX.Element | null | string;
renderContent?: () => JSX.Element | JSX.Element[] | null | string;
requestClose: () => void;
unmountOnClose?: boolean;
}Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.