react-native-modalfy/README.md

Modal citizen of React Native

<h1 align="center">
  <a href="https://colorfy-software.gitbook.io/react-native-modalfy/" target="_blank" rel="noopener noreferrer">
    🥞 React Native Modalfy
  </a>
</h1>

<h4 align="center">
  <strong>Modal citizen of React Native.</strong>
</h4>

<p align="center">
  <a href="https://github.com/colorfy-software/react-native-modalfy/actions">
    <img src="https://github.com/colorfy-software/react-native-modalfy/workflows/Test%20Suite/badge.svg?branch=main" alt="Current GitHub Actions build status." />
  </a>
  <a href="https://www.npmjs.org/package/react-native-modalfy">
    <img src="https://img.shields.io/npm/v/react-native-modalfy.svg?color=brightgreen" alt="Current npm package version." />
  </a>
  <a href="https://www.npmjs.org/package/react-native-modalfy">
    <img src="https://img.shields.io/npm/dm/react-native-modalfy.svg?maxAge=2592000" alt="Monthly npm downloads." />
  </a>
  <a href="https://colorfy-software.gitbook.io/react-native-modalfy/contributing">
    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome!" />
  </a>
</p>

## 🎯 Purpose

Modalfy promise has always been to allow you to do 3 things:
1. Write your modals once, call them from anywhere in your app.
2. Display several modals at once, stack as many as you like.
3. Complete control over animations & transitions between each modal in the stack.

We only provide the logic and how to manage your modals: you pass the modal components and have complete control over how they look.

## 📚 Documentation

The doc is accessible at https://colorfy-software.gitbook.io/react-native-modalfy.

- The best way to learn is to follow the [guides](https://colorfy-software.gitbook.io/react-native-modalfy/guides/stack). They will help you to get up and running in no time.
- The [API reference](https://colorfy-software.gitbook.io/react-native-modalfy/api/types) lists all public APIs.

## 🎥  Show me!

Maybe better than our long paragraphs, here's a quick
sneak peek of what you could achieve with Modalfy in a few lines of code:
| [![Watch the video](https://i.imgur.com/q8QFajL.gif)](https://youtu.be/usAU2pcURh8)<br/>[Snippet #1](https://gist.github.com/iremlopsum/77e8549735c6c6ba7a243ea453c10147)  | [![Watch the video](https://i.imgur.com/wF0hTBm.gif)](https://youtu.be/UPDSPjj4dyU)<br/>[Snippet #2](https://gist.github.com/iremlopsum/17b4804a142a39525160df22e67410ea) |
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| [![Watch the video](https://i.imgur.com/C79UD6B.gif)](https://youtu.be/LkHFK5zZMI8)<br/>[Snippet #3](https://gist.github.com/iremlopsum/b40640264335545bf3b9e39622f5c423 ) | [![Watch the video](https://i.imgur.com/Z6HsH59.gif)](https://youtu.be/AJ1P9e7iD38)<br/>[Snippet #4](https://gist.github.com/iremlopsum/f3dcb215d8e318c0d1912359fffd232b) |


## 🤝 Code of Conduct

This library has adopted a Code of Conduct that we expect project participants to adhere to. Please read the [full text](https://github.com/colorfy-software/react-native-modalfy/blob/master/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.

## 📰 License

React Native Modalfy is licensed under the [MIT License](https://github.com/colorfy-software/react-native-modalfy/blob/master/LICENSE).