react-accessible-modal

react-accessible-modal

Accessible modal dialog component for React. Originally a fork of reactjs/react-modal.

Check out the online demo!

Usage

npm install --save react-accessible-modal

Include your modal component

import Modal from 'react-accessible-modal';

<Modal
    isOpen={true}
    label="Hello modal!"
    onRequestClose={this.closeModal}
    onAfterClose={this.destroyModal}
>
    <div>
        Hello!
    </div>
</Modal>

Development

Install

Clone the project on your computer, and install Node. This project also uses nvm.

nvm install
# Then, install all project dependencies.
npm install
# Install the git hooks.
./.githooks/deploy

Working on the project

Everything mentioned in the installation process should already be done.

# Make sure you use the right node version.
nvm use
# Start the server and the development tools.
npm run start
# Runs linting.
npm run lint
# Runs tests.
npm run test
# View other available commands with:
npm run

Releases

• Make a new branch for the release of the new version.
• Update the CHANGELOG.
• Update the version number in package.json, following semver.
• Make a PR and squash merge it.
• Back on master with the PR merged, follow the instructions below.

npm run dist
# Use irish-pub to check the package content. Install w/ npm install -g first.
irish-pub
npm publish

• Finally, go to GitHub and create a release and a tag for the new version.
• Done!

Changelog

[v2.0.0]

Added

• Add prop-types as peerDependency.

Changed

• Convert all code to be compatible with React 15.5 and React 16.

Removed

• Remove animationend vendor prefixing.
• Remove support for React 0.14.7, 0.14.8, 15.1, 15.2.
• Remove UMD build.
• Start compiling only for latest browser versions and IE11.