Skip to content

ykiu/material-ui-swipeable-backdrop

Repository files navigation

Material-UI Swipeable Backdrop

Build Status Coverage Status npm

Material-ish Backdrop react component that is swipeable. An extension to the awesome Material-UI framework.

Screen shot

Usage

Refer to the GitHub Pages documentation for usage guides.

Contributing

Fork and clone locally. Cd to the root of the project and run the following command to perform initial setup:

npm install -D

First of all, run tests to ensure the setup was successful:

npm run test

Some useful commands:

// Linting
npm run lint

// Auto-formatting
npm run format

// Creating a development build of the document
npm run build:doc:dev

To view the built document locally, open doc/public/index.html with whatever browser you like (Chrome is recommended).

Do not forget to include tests for new features or bug fixes;-)

Commit your changes to your topic branch and make a PR.

License

MIT