dce-reactkit 3.0.0-beta.4 → 3.0.0-beta.42

package/src/components/CheckboxButton.tsx

@@ -0,0 +1,100 @@
+/**
+ * A checkbox button
+ * @author Gabe Abrams
+ */
+
+// Import React
+import React from 'react';
+
+// Import FontAwesome Icons
+import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
+import { faCheckSquare } from '@fortawesome/free-solid-svg-icons';
+import { faSquare } from '@fortawesome/free-regular-svg-icons';
+
+// Import shared types
+import Variant from '../types/Variant';
+
+/*------------------------------------------------------------------------*/
+/*                                  Types                                 */
+/*------------------------------------------------------------------------*/
+
+type Props = {
+  // Text of the button
+  text: string,
+  // Handler for when this item is toggled
+  onChanged: (checked: boolean) => void,
+  // Aria label
+  ariaLabel: string,
+  // Button title
+  title?: string,
+  // True if checked
+  checked?: boolean,
+  // The id of the button
+  id?: string,
+  // If true, no margin on right
+  noMarginOnRight?: boolean,
+  // Variant for when checkbox is checked
+  checkedVariant?: Variant,
+  // Variant for when checkbox is not checked
+  uncheckedVariant?: Variant,
+  // True if using a small button
+  small?: boolean,
+};
+
+/*------------------------------------------------------------------------*/
+/*                                Component                               */
+/*------------------------------------------------------------------------*/
+
+const CheckboxButton: React.FC<Props> = (props) => {
+  /*------------------------------------------------------------------------*/
+  /*                                  Setup                                 */
+  /*------------------------------------------------------------------------*/
+
+  /* -------------- Props ------------- */
+
+  const {
+    text,
+    onChanged,
+    ariaLabel,
+    title,
+    checked,
+    id,
+    noMarginOnRight,
+    checkedVariant = Variant.Secondary,
+    uncheckedVariant = Variant.Light,
+    small,
+  } = props;
+
+  /*------------------------------------------------------------------------*/
+  /*                                 Render                                 */
+  /*------------------------------------------------------------------------*/
+
+  /*----------------------------------------*/
+  /*                Main UI                 */
+  /*----------------------------------------*/
+
+  return (
+    <button
+      type="button"
+      id={id}
+      title={title}
+      className={`btn btn-${checked ? checkedVariant : uncheckedVariant}${checked ? ' selected' : ''}${small ? ' btn-sm' : ''} m-0${noMarginOnRight ? '' : ' me-1'}`}
+      aria-label={`${ariaLabel}${checked ? ': currently checked' : ''}`}
+      onClick={() => {
+        onChanged(!checked);
+      }}
+    >
+      <FontAwesomeIcon
+        icon={checked ? faCheckSquare : faSquare}
+        className="me-1"
+      />
+      {text}
+    </button>
+  );
+};
+
+/*------------------------------------------------------------------------*/
+/*                                 Wrap up                                */
+/*------------------------------------------------------------------------*/
+
+export default CheckboxButton;

package/src/components/ErrorBox.tsx

@@ -63,9 +63,9 @@ const ErrorBox: React.FC<Props> = (props) => {
         <span
           style={{
             backgroundColor: 'white',
-            borderRadius: '5px',
-            paddingLeft: '3px',
-            paddingRight: '3px',
+            borderRadius: '0.3rem',
+            paddingLeft: '0.2rem',
+            paddingRight: '0.2rem',
             color: '#DC4150',
             fontVariant: 'small-caps',
             fontSize: '80%',
@@ -85,7 +85,7 @@ const ErrorBox: React.FC<Props> = (props) => {
     <div
       className="alert alert-danger text-center"
       style={{
-        maxWidth: '650px',
+        maxWidth: '40rem',
         margin: 'auto',
       }}
     >

package/src/components/LoadingSpinner.tsx

@@ -20,10 +20,10 @@ const style = `
 .LoadingSpinner-blip-2,
 .LoadingSpinner-blip-3,
 .LoadingSpinner-blip-4 {
-  font-size: 25px;
+  font-size: 1.8rem;
   opacity: 0.6;
-  margin-top: 20px;
-  margin-bottom: 20px;
+  margin-top: 1rem;
+  margin-bottom: 1rem;
 }
 
 /* First Blip */

package/src/components/Modal.tsx

@@ -15,69 +15,12 @@ import ModalButtonType from '../types/ModalButtonType';
 import ModalSize from '../types/ModalSize';
 import ModalType from '../types/ModalType';
 
-/*------------------------------------------------------------------------*/
-/*                                  Style                                 */
-/*------------------------------------------------------------------------*/
-
-const style = `
-/* More opaque backdrop */
-.Modal-backdrop {
-  background-color: black !important;
-  opacity: 0.8 !important;
-  z-index: 10000000 !important;
-}
-
-/* Customize the modal header and body */
-.modal-header {
-  /* Dark theme */
-  background-color: #222 !important;
-  color: white !important;
-
-  /* Border */
-  border: 1px solid #545454 !important;
-}
-.modal-body {
-  /* Dark theme */
-  background-color: #222 !important;
-  color: white !important;
-
-  /* Border */
-  border-top: 0 !important;
-  border-left: 1px solid #545454 !important;
-  border-bottom: 1px solid #545454 !important;
-  border-right: 1px solid #545454 !important;
-  border-bottom-left-radius: 3px;
-  border-bottom-right-radius: 3px;
-}
-
-/* Create our own animation */
-.modal-content {
-  animation-name: Modal-drop-in;
-  animation-duration: 0.4s;
-  animation-iteration-count: 1;
-  animation-fill-mode: forwards;
-  animation-timing-function: ease-out;
-}
-@keyframes Modal-drop-in {
-  0% {
-    transform: scale(0.8);
-    opacity: 0.5;
-  }
-  100% {
-    transform: scale(1);
-    opacity: 1;
-  }
-}
-`;
-
 /*------------------------------------------------------------------------*/
 /*                                Constants                               */
 /*------------------------------------------------------------------------*/
 
 // Constants
-const MS_TO_ANIMATE = 400; // Time to animate in/out (defined by bootstrap)
-const MS_ANIMATE_IN_DELAY = 10;
-// Time to wait before animating in (must be >0 or animation won't trigger)
+const MS_TO_ANIMATE = 200; // Animation duration
 
 // Modal type to list of buttons
 const modalTypeToModalButtonTypes: {
@@ -161,6 +104,116 @@ const ModalButtonTypeToLabelAndVariant = {
   },
 };
 
+/*------------------------------------------------------------------------*/
+/*                                  Style                                 */
+/*------------------------------------------------------------------------*/
+
+const style = `
+  .Modal-backdrop {
+    position: fixed;
+    top: 0;
+    left: 0;
+    width: 100vw;
+    height: 100vw;
+    background-color: rgba(0, 0, 0, 0.7);
+  }
+
+  .Modal-fading-in {
+    animation-name: Modal-fading-in;
+    animation-duration: ${Math.floor(MS_TO_ANIMATE * 2)}ms;
+    animation-iteration-count: 1;
+    animation-fill-mode: both;
+    animation-timing-function: ease-out;
+  }
+
+  @keyframes Modal-fading-in {
+    0% {
+      opacity: 0;
+    }
+    100% {
+      opacity: 1;
+    }
+  }
+
+  .Modal-fading-out {
+    animation-name: Modal-fading-out;
+    animation-duration: ${MS_TO_ANIMATE}ms;
+    animation-iteration-count: 1;
+    animation-fill-mode: both;
+    animation-timing-function: ease-in;
+  }
+
+  @keyframes Modal-fading-out {
+    0% {
+      opacity: 1;
+    }
+    100% {
+      opacity: 0;
+    }
+  }
+
+  .Modal-animating-in {
+    animation-name: Modal-animating-in;
+    animation-duration: ${MS_TO_ANIMATE}ms;
+    animation-iteration-count: 1;
+    animation-fill-mode: both;
+    animation-timing-function: ease-out;
+  }
+
+  @keyframes Modal-animating-in {
+    0% {
+      transform: scale(1.05) translate(0, -1.5rem);
+      opacity: 0;
+    }
+    100% {
+      transform: scale(1) translate(0, 0);
+      opacity: 1;
+    }
+  }
+
+  .Modal-animating-pop {
+    animation-name: Modal-animating-pop;
+    animation-duration: ${MS_TO_ANIMATE}ms;
+    animation-iteration-count: 1;
+    animation-fill-mode: both;
+    animation-timing-function: ease-in-out;
+  }
+
+  @keyframes Modal-animating-pop {
+    0% {
+      transform: scale(1);
+      opacity: 1;
+    }
+    50% {
+      transform: scale(1.05);
+      opacity: 0.9;
+    }
+    100% {
+      transform: scale(1);
+      opacity: 1;
+    }
+  }
+
+  .Modal-animating-out {
+    animation-name: Modal-animating-out;
+    animation-duration: ${MS_TO_ANIMATE}ms;
+    animation-iteration-count: 1;
+    animation-fill-mode: both;
+    animation-timing-function: ease-in;
+  }
+
+  @keyframes Modal-animating-out {
+    0% {
+      transform: scale(1) translate(0, 0);
+      opacity: 1;
+    }
+    100% {
+      transform: scale(1.05) translate(0, -1.5rem);
+      opacity: 0;
+    }
+  }
+`;
+
 /*------------------------------------------------------------------------*/
 /*                                  Types                                 */
 /*------------------------------------------------------------------------*/
@@ -245,11 +298,17 @@ const Modal: React.FC<Props> = (props) => {
 
   /* -------------- State ------------- */
 
+  // If true, the modal is completely gone
+  // (not just invisible, also removed from the dom)
+  const [gone, setGone] = useState(false);
+
   // If true, the modal is shown
   const [visible, setVisible] = useState(false);
 
-  // True if currently animating in
-  const [animatingIn, setAnimatingIn] = useState(false);
+  // True if animation is in use
+  const [animatingIn, setAnimatingIn] = useState(true);
+  const [animatingPop, setAnimatingPop] = useState(false);
+  const [animatingOut, setAnimatingOut] = useState(false);
 
   /*------------------------------------------------------------------------*/
   /*                           Lifecycle Functions                          */
@@ -262,13 +321,10 @@ const Modal: React.FC<Props> = (props) => {
   useEffect(
     () => {
       (async () => {
-        // Start the component animating in
-        await waitMs(MS_ANIMATE_IN_DELAY);
-        setAnimatingIn(true);
-
         // Wait and then set visible to true
         await waitMs(MS_TO_ANIMATE);
         setVisible(true);
+        setAnimatingIn(false);
       })();
     },
     [],
@@ -302,16 +358,23 @@ const Modal: React.FC<Props> = (props) => {
 
     // Update the state
     setVisible(false);
+    setAnimatingOut(true);
 
     // Call the handler after the modal has animated out
     await waitMs(MS_TO_ANIMATE);
     onClose(ModalButtonType);
+    setGone(true);
   };
 
   /*------------------------------------------------------------------------*/
   /*                                 Render                                 */
   /*------------------------------------------------------------------------*/
 
+  // Return nothing if gone
+  if (gone) {
+    return null;
+  }
+
   /*----------------------------------------*/
   /*                 Footer                 */
   /*----------------------------------------*/
@@ -343,8 +406,9 @@ const Modal: React.FC<Props> = (props) => {
     // Create the button
     return (
       <button
+        key={ModalButtonType}
         type="button"
-        className={`Modal-${ModalButtonType}-button btn btn-${variant} ${last ? '' : 'mr-1'}`}
+        className={`Modal-${ModalButtonType}-button btn btn-${variant} ${last ? '' : 'me-1'}`}
         onClick={() => {
           handleClose(ModalButtonType);
         }}
@@ -365,23 +429,73 @@ const Modal: React.FC<Props> = (props) => {
       : undefined
   );
 
+  // Choose an animation
+  let animationClass = '';
+  let backdropAnimationClass = '';
+  if (animatingIn) {
+    animationClass = 'Modal-animating-in';
+    backdropAnimationClass = 'Modal-fading-in';
+  } else if (animatingOut) {
+    animationClass = 'Modal-animating-out';
+    backdropAnimationClass = 'Modal-fading-out';
+  } else if (animatingPop) {
+    animationClass = 'Modal-animating-pop';
+  }
+
   // Render the modal
   return (
     <div
-      className={`modal fade modal-${size}`}
+      className={`modal show modal-dialog-scrollable modal-dialog-centered modal-${size}`}
       tabIndex={-1}
       style={{
         zIndex: (
           onTopOfOtherModals
-            ? 6000000000
+            ? 5000000001
             : 5000000000
         ),
+        display: 'block',
+        margin: 'auto',
+        left: 0,
+        right: 0,
       }}
     >
-      <div className="modal-dialog">
+      <style>{style}</style>
+      <div
+        className={`Modal-backdrop ${backdropAnimationClass}`}
+        style={{
+          zIndex: 5000000003,
+        }}
+        onClick={async () => {
+          // Skip if exit via backdrop not allowed
+          if (dontAllowBackdropExit || !onClose) {
+            // Show pop animation
+            if (!animatingPop) {
+              setAnimatingPop(true);
+
+              // Wait then stop pop animation
+              await waitMs(MS_TO_ANIMATE);
+              setAnimatingPop(false);
+            }
+            return;
+          }
+          // Handle close
+          handleClose(ModalButtonType.Cancel);
+        }}
+      />
+      <div
+        className={`modal-dialog ${animationClass}`}
+        style={{
+          zIndex: 5000000002,
+        }}
+      >
         <div className="modal-content">
           <div className="modal-header">
-            <h5 className="modal-title">
+            <h5
+              className="modal-title"
+              style={{
+                fontWeight: 'bold',
+              }}
+            >
               {title}
             </h5>
 
@@ -389,9 +503,9 @@ const Modal: React.FC<Props> = (props) => {
               <button
                 type="button"
                 className="btn-close"
-                data-bs-dismiss="modal"
                 aria-label="Close"
                 onClick={() => {
+                  // Handle close
                   handleClose(ModalButtonType.Cancel);
                 }}
               />
@@ -403,7 +517,7 @@ const Modal: React.FC<Props> = (props) => {
             </div>
           )}
           {footer && (
-            <div className="modal-footer">
+            <div className="modal-footer pt-1 pb-1">
               {footer}
             </div>
           )}

package/src/components/RadioButton.tsx

@@ -0,0 +1,102 @@
+/**
+ * A radio selection button
+ * @author Gabe Abrams
+ */
+
+// Import React
+import React from 'react';
+
+// Import FontAwesome Icons
+import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
+import { faDotCircle } from '@fortawesome/free-solid-svg-icons';
+import { faCircle } from '@fortawesome/free-regular-svg-icons';
+
+// Import shared types
+import Variant from '../types/Variant';
+
+/*------------------------------------------------------------------------*/
+/*                                  Types                                 */
+/*------------------------------------------------------------------------*/
+
+type Props = {
+  // Text of the button
+  text: string,
+  // Handler for when this item is selected (not called if already selected)
+  onSelected: () => void,
+  // Aria label
+  ariaLabel: string,
+  // Button title
+  title?: string,
+  // True if selected
+  selected?: boolean,
+  // The id of the button
+  id?: string,
+  // If true, no margin on right
+  noMarginOnRight?: boolean,
+  // Variant for when radio is selected
+  selectedVariant?: Variant,
+  // Variant for when radio is not selected
+  unselectedVariant?: Variant,
+  // True if using a small button
+  small?: boolean,
+};
+
+/*------------------------------------------------------------------------*/
+/*                                Component                               */
+/*------------------------------------------------------------------------*/
+
+const RadioButton: React.FC<Props> = (props) => {
+  /*------------------------------------------------------------------------*/
+  /*                                  Setup                                 */
+  /*------------------------------------------------------------------------*/
+
+  /* -------------- Props ------------- */
+
+  const {
+    text,
+    onSelected,
+    ariaLabel,
+    title,
+    selected,
+    id,
+    noMarginOnRight,
+    selectedVariant = Variant.Secondary,
+    unselectedVariant = Variant.Light,
+    small,
+  } = props;
+
+  /*------------------------------------------------------------------------*/
+  /*                                 Render                                 */
+  /*------------------------------------------------------------------------*/
+
+  /*----------------------------------------*/
+  /*                Main UI                 */
+  /*----------------------------------------*/
+
+  return (
+    <button
+      type="button"
+      id={id}
+      title={title}
+      className={`btn btn-${selected ? selectedVariant : unselectedVariant}${selected ? ' selected' : ''}${small ? ' btn-sm' : ''} m-0${noMarginOnRight ? '' : ' me-1'}`}
+      aria-label={`${ariaLabel}${selected ? ': currently selected' : ''}`}
+      onClick={() => {
+        if (!selected) {
+          onSelected();
+        }
+      }}
+    >
+      <FontAwesomeIcon
+        icon={selected ? faDotCircle : faCircle}
+        className="me-1"
+      />
+      {text}
+    </button>
+  );
+};
+
+/*------------------------------------------------------------------------*/
+/*                                 Wrap up                                */
+/*------------------------------------------------------------------------*/
+
+export default RadioButton;