From 8a36598c1dc5bb8e2c9907af7299739cbef74aeb Mon Sep 17 00:00:00 2001
From: Chris Troutner <chris.troutner@gmail.com>
Date: Sat, 11 Feb 2023 10:05:41 -0800
Subject: [PATCH] fix(waiting-modal): Refactoring to call out props

---
 src/components/waiting-modal/index.js | 25 ++++++++++++++++++-------
 1 file changed, 18 insertions(+), 7 deletions(-)

diff --git a/src/components/waiting-modal/index.js b/src/components/waiting-modal/index.js
index 6c172d7..26624d7 100644
--- a/src/components/waiting-modal/index.js
+++ b/src/components/waiting-modal/index.js
@@ -9,16 +9,25 @@ import React, { useState } from 'react'
 import { Container, Row, Col, Modal, Spinner } from 'react-bootstrap'
 
 function ModalTemplate (props) {
+  // State
   const [show, setShow] = useState(true)
 
+  // Dependency injection of props
+  const denyClose = props.denyClose // Determins if user is allowed to close modal.
+  const closeFunc = props.closeFunc // Optional function called after modal is closed.
+  const heading = props.heading // Title of the modal
+  const body = props.body // Body of the modal
+  const hideSpinner = props.hideSpinner // Hide the animated spinner
+
+  // This function is called when the modal is closed
   const handleClose = () => {
-    console.log(`props.denyClose: ${props.denyClose}`)
-    if (props.denyClose) return
+    console.log(`props.denyClose: ${denyClose}`)
+    if (denyClose) return
 
     setShow(false)
 
-    if (props.closeFunc) {
-      props.closeFunc()
+    if (closeFunc) {
+      closeFunc()
     }
   }
   // const handleShow = () => setShow(true)
@@ -26,14 +35,14 @@ function ModalTemplate (props) {
   return (
     <Modal show={show} onHide={handleClose}>
       <Modal.Header closeButton>
-        <Modal.Title>{props.heading}</Modal.Title>
+        <Modal.Title>{heading}</Modal.Title>
       </Modal.Header>
       <Modal.Body>
         <Container>
           <Row>
             <Col style={{ textAlign: 'center' }}>
-              <BodyList body={props.body} />
-              {props.hideSpinner ? null : <Spinner animation='border' />}
+              <BodyList body={body} />
+              {hideSpinner ? null : <Spinner animation='border' />}
             </Col>
           </Row>
         </Container>
@@ -43,6 +52,8 @@ function ModalTemplate (props) {
   )
 }
 
+// This function populates the body of the modal. It expects props.body to be
+// an array of strings.
 function BodyList (props) {
   const items = props.body
   // console.log('BodyList items: ', items)