๐Ÿ”” Alert..!! Get 2 Month Free Cloud Hosting With $200 Bonus From Digital Ocean ACTIVATE DEAL

Reactjs-popup is a simple yet multifunctional popup component for React app.

Modal_Popup React

Documentation

Reactjs-popup

Build Status version downloads MIT License

All Contributors PRs Welcome Code of Conduct

Watch on GitHub Star on GitHub Tweet

built with react Fragment : react 16 Tiny 3KB

Welcome

Reactjs-popup is a simple react popup component with a lot of benefits :

  • Built with react fragment thatโ€™s mean no additional wrapper Divs in your code or in the trigger element. ๐Ÿ˜ฎ
  • Does not inject HTML outside your app root. ๐Ÿ“ฆ
  • Function as children pattern to take control over your popup anywhere in your code. ๐Ÿ’ช
  • Modal, Tooltip, Menuย : All in one ๐Ÿ‹๏ธ
  • Full style customization ๐Ÿ‘Œ
  • Easy to use. ๐Ÿš€
  • IE Support.๐Ÿš€
  • TypeScript Support ๐Ÿ‘Œ
  • All these clocks in at around 3 kB zipped. โšก๏ธ

Requires React >= 16.0

Demo

Live Demo

alt text

TO DO

  • Create repository && publish package
  • Create reactjs-popup Home page
  • Tooltip Support
  • Modal Support
  • Menu & Nested Menu Support
  • Add Live examples
  • Animation API
  • Toast Support
  • suggest a feature here

Installing / Getting started

This package is available in npm repository as reactjs-popup. It will work correctly with all popular bundlers.

npm install reactjs-popup --save

Using yarn

yarn add reactjs-popup -s

Include the Component

To start using reactjs popup you just need to import the component from the reactjs-popup package.

import React from "react"; import Popup from "reactjs-popup";  export default () => (   <Popup trigger={<button> Trigger</button>} position="right center">     <div>Popup content here !!</div>   </Popup> );

You can find more examples in the reactjs-popup home page

Contributing

Clone Repo

Fork and then clone the repo

git clone [email protected]:your-username/reactjs-popup.git 

Start Developing

Install all npm scripts:

npm install or yarn install 

we use a simple package called parcel-story it's a simple storybook alternative more info https://github.com/yjose/parcel-story

Run parcel-story :

yarn start 

Run Test in watch mode

yarn test-watch 

To make contributing simply you need to create a new story with documentation under stories/src directory ( you can copy/past any story to start with ).

In this story, you need to present the new features or the bug fix and don't forget to comment your code :) .

Make Changes. If you want to contribute check out the help wanted issues for things that need fixing.

Before submitting a pull request run npm run test to run the unit-tests and npm run eslint to check for linting errors in your changes.

Licensing

The code in this project is licensed under MIT license.

Show your support!

That's all, thank you for your attention, please Star on GitHub the repo to show your support...

...we are all made of stars Star on GitHub !

Maintainers


Youssouf EL Azizi

You May Also Like