fix(readme): added react installation guide

Se-Gl · Jul 23, 2022 · 12172ae · 12172ae
1 parent bc1e34b
commit 12172ae
Showing 1 changed file with 75 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -6,19 +6,20 @@
 [![minified + gzip](https://badgen.net/bundlephobia/minzip/next-modal)](https://badgen.net/bundlephobia/minzip/next-modal)
 [![License](https://badgen.net/npm/license/next-modal)](https://badgen.net/npm/license/next-modal)
 
-This is a sustainable React modal component project based on [greenCSS](https://github.com/Se-Gl/greenCSS), which also works SSR with Next.js. greenCSS is an animated, responsive, lightweight and sustainable CSS library. It is recommended that you also use greenCSS in your project. If you don't want to, just style your modal with your own classes.
+This is a sustainable React modal component project based on [greenCSS](https://github.com/Se-Gl/greenCSS), which works with plain React, as well as with SSR - such as Next.js. Animations and the basic design were realised with greenCSS. greenCSS is an animated, responsive, lightweight and sustainable CSS library. It is recommended that you also use greenCSS in your project. If you don't want to, just style your modal with your own classes.
 
 ![modal preview](/img/modal-preview.gif)
 
 ## Features
 
+- Tested with react and next.js
 - Press CTRL + k to open the modal
 - Press ESC key to close the modal
 - On Chrome browser the background is blurred. In Firefox this feature is not available, there the background has an opacity of 75%.
 - Click on the background or the close icon (top right corner) to close the modal.
-- The Modal component use a default greenCSS fade in animation with a duration of 500ms `fade-in animation-duration-500ms animation-forwards`. If you want to animate the Modal.Header or Modal.Body, just add your greenCSS or your custom animation as a class to the `className`. Here can find all [greenCSS animations](https://www.greencss.dev/examples/animation). p.e. `<Modal.Body className='clip-circle-in-left animation-duration-800ms animation-forwards'>`
+- The Modal component use a default greenCSS fade in animation with a duration of 500ms `fade-in animation-duration-500ms animation-forwards`. If you want to animate the `Modal.Header` or `Modal.Body`, just add your greenCSS or your custom animation as a class to the `className`. Here can find all [greenCSS animations](https://www.greencss.dev/examples/animation). p.e. `<Modal.Body className='clip-circle-in-left animation-duration-800ms animation-forwards'>`
 - Do you want to use your own close icon on the top right corner? Add `closeIcon` with your own (svg-) component. `<Modal toggle={toggleModal} setToggle={setToggleModal} closeIcon={<div>X</div>}>` The recommended size for an svg is 20x20px.
-- People who do not want animations will automatically not be shown any animations. As it will be blocked by default `prefers-reduced-motion: reduce`
+- People who do not want animations will automatically not be shown any motions. As it will be blocked by default `prefers-reduced-motion: reduce`
 
 ## Getting Started
 
@@ -28,7 +29,7 @@ First, install the Modal dependency:
 npm i next-modal
 ```
 
-### Next.js
+### Next.js installation
 
 In the pages directory, add `_document.js`. It is important to add `<div id='modal-portal' />` below the `<Main />` component. Otherwise your SSR Modal will not work. Learn more about the custom [document](https://nextjs.org/docs/advanced-features/custom-document).
 
@@ -58,9 +59,7 @@ class MyDocument extends Document {
 export default MyDocument
 ```
 
-### Example Page
-
-The following jsx file is based on greenCSS. If you don't want to use it, you can add your own `classNames`.
+The following jsx file below is based on greenCSS. If you don't want to use it, you can add your own `classNames`.
 
 ```js
 import React, { useState } from 'react'
@@ -130,10 +129,77 @@ export default function Home() {
 }
 ```
 
-### Summary
+### React installation
+
+You can also use next-modal in your create-react-app. Head to your `public/index.html` file and add `<div id="modal-portal" />` below the `<div id="root"></div>`.
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta name="description" content="Web site created using create-react-app" />
+    <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+    <title>React App</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+    <div id="modal-portal" />
+  </body>
+</html>
+```
+
+Within a page or a component, you can now add and use the Modal.
+
+```js
+import React, { useState } from 'react'
+import { Modal } from 'next-modal'
+
+function App() {
+  const [toggleModal, setToggleModal] = useState(false)
+  return (
+    <div className='App'>
+      {/* Modal Toggle Button */}
+      <button onClick={() => setToggleModal((prev) => !prev)} className='bg-red-9 px-20px py-10px rounded-10px hover:bg-red-7'>
+        Toggle Modal
+      </button>
+
+      {/* Modal */}
+      <Modal toggle={toggleModal} setToggle={setToggleModal}>
+        <Modal.Header className='sans font-900 text-30px fade-in-left animation-duration-500ms animation-forwards'>
+          <h3>👋 Hi, I'm your modal</h3>
+        </Modal.Header>
+        <Modal.Body className='sans font-400 text-15px text-gray fade-in animation-duration-800ms animation-forwards'>
+          <p>
+            Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna
+            aliqua. Viverra accumsan in nisl nisi scelerisque eu ultrices vitae auctor. Quis vel eros donec ac. Mauris
+            pellentesque pulvinar pellentesque habitant morbi tristique senectus.
+          </p>
+        </Modal.Body>
+        <Modal.Footer className='sans font-400 text-10px'>
+          <h3>copyright</h3>
+        </Modal.Footer>
+      </Modal>
+    </div>
+  )
+}
+
+export default App
+```
+
+## Summary
 
 1. Import the modal.
-2. Next.js: Adjust pages/\_document.js
+2. Add the div with the id="modal-portal":
+
+- Next.js: Adjust pages/\_document.js
+- React: Adjust public/index.html
+
 3. In your page/component:
 
 - Set the react useState to toggle the modal.