dce-reactkit 3.0.35 → 3.0.38

package/dist/index.d.ts

@@ -7,7 +7,7 @@ import React from 'react';
  * @author Gabe Abrams
  */
 
-declare type Props$8 = {
+declare type Props$9 = {
     children: React.ReactNode;
     sendRequest: SendRequestFunction;
     dark?: boolean;
@@ -52,7 +52,7 @@ declare const confirm: (title: string, text: string) => Promise<boolean>;
  * @param [errorTitle] title of the error box
  */
 declare const showFatalError: (error: any, errorTitle?: string) => undefined;
-declare const AppWrapper: React.FC<Props$8>;
+declare const AppWrapper: React.FC<Props$9>;
 
 /**
  * Loading spinner/indicator
@@ -65,12 +65,12 @@ declare const LoadingSpinner: () => JSX.Element;
  * @author Gabe Abrams
  */
 
-declare type Props$7 = {
+declare type Props$8 = {
     error: any;
     title?: string;
     onClose?: () => void;
 };
-declare const ErrorBox: React.FC<Props$7>;
+declare const ErrorBox: React.FC<Props$8>;
 
 /**
  * Bootstrap variants
@@ -136,7 +136,7 @@ declare enum ModalType {
  * @author Gabe Abrams
  */
 
-declare type Props$6 = {
+declare type Props$7 = {
     type?: ModalType;
     size?: ModalSize;
     title?: React.ReactNode;
@@ -165,26 +165,26 @@ declare type Props$6 = {
     confirmVariant?: Variant;
     onTopOfOtherModals?: boolean;
 };
-declare const Modal: React.FC<Props$6>;
+declare const Modal: React.FC<Props$7>;
 
 /**
  * A box with a tab on the top that holds buttons and other content
  * @author Gabe Abrams
  */
 
-declare type Props$5 = {
+declare type Props$6 = {
     title: React.ReactNode;
     children: React.ReactNode;
     noBottomPadding?: boolean;
 };
-declare const TabBox: React.FC<Props$5>;
+declare const TabBox: React.FC<Props$6>;
 
 /**
  * A radio selection button
  * @author Gabe Abrams
  */
 
-declare type Props$4 = {
+declare type Props$5 = {
     text: string;
     onSelected: () => void;
     ariaLabel: string;
@@ -196,14 +196,14 @@ declare type Props$4 = {
     unselectedVariant?: Variant;
     small?: boolean;
 };
-declare const RadioButton: React.FC<Props$4>;
+declare const RadioButton: React.FC<Props$5>;
 
 /**
  * A checkbox button
  * @author Gabe Abrams
  */
 
-declare type Props$3 = {
+declare type Props$4 = {
     text: string;
     onChanged: (checked: boolean) => void;
     ariaLabel: string;
@@ -215,26 +215,26 @@ declare type Props$3 = {
     uncheckedVariant?: Variant;
     small?: boolean;
 };
-declare const CheckboxButton: React.FC<Props$3>;
+declare const CheckboxButton: React.FC<Props$4>;
 
 /**
  * Input group with a title and space for buttons
  * @author Gabe Abrams
  */
 
-declare type Props$2 = {
+declare type Props$3 = {
     label: string;
     minLabelWidth?: string;
     children: React.ReactNode;
 };
-declare const ButtonInputGroup: React.FC<Props$2>;
+declare const ButtonInputGroup: React.FC<Props$3>;
 
 /**
  * A very simple, lightweight date chooser
  * @author Gabe Abrams
  */
 
-declare type Props$1 = {
+declare type Props$2 = {
     ariaLabel: string;
     name: string;
     month: number;
@@ -249,17 +249,29 @@ declare type Props$1 = {
     onChange: (month: number, day: number, year: number) => void;
     numMonthsToShow?: number;
 };
-declare const SimpleDateChooser: React.FC<Props$1>;
+declare const SimpleDateChooser: React.FC<Props$2>;
 
 /**
  * Drawer container
  * @author Gabe Abrams
  */
 
-declare type Props = {
+declare type Props$1 = {
     children: React.ReactNode;
 };
-declare const Drawer: React.FC<Props>;
+declare const Drawer: React.FC<Props$1>;
+
+/**
+ * Success checkmark that pops into view
+ * @author Gabe Abrams
+ */
+
+declare type Props = {
+    sizeRem?: number;
+    circleVariant?: string;
+    checkVariant?: string;
+};
+declare const PopSuccessMark: React.FC<Props>;
 
 /**
  * An error with a code
@@ -523,6 +535,15 @@ declare const stubServerEndpoint: (opts: {
     errorCode?: string | undefined;
 }) => void;
 
+/**
+ * Start a dynamic wait, call the function once the operation has completed and
+ *   the dynamic wait will continue waiting for the rest of the minimum time
+ * @author Gabe Abrams
+ * @param minWaitMs the minimum number of ms to wait
+ * @returns async function to call to finish the wait
+ */
+declare const startMinWait: (minWaitMs: number) => () => Promise<void>;
+
 /**
  * List of error codes built into the react kit
  * @author Gabe Abrams
@@ -540,4 +561,4 @@ declare enum ReactKitErrorCode {
     NotAdmin = "DRK10"
 }
 
-export { AppWrapper, ButtonInputGroup, CheckboxButton, DAY_IN_MS, Drawer, ErrorBox, ErrorWithCode, HOUR_IN_MS, LoadingSpinner, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, ParamType, RadioButton, ReactKitErrorCode, SimpleDateChooser, TabBox, Variant, abbreviate, alert, avg, ceilToNumDecimals, confirm, floorToNumDecimals, forceNumIntoBounds, genRouteHandler, getOrdinal, getTimeInfoInET, handleError, handleSuccess, initServer, padDecimalZeros, padZerosLeft, roundToNumDecimals, showFatalError, stubServerEndpoint, sum, visitServerEndpoint, waitMs };
+export { AppWrapper, ButtonInputGroup, CheckboxButton, DAY_IN_MS, Drawer, ErrorBox, ErrorWithCode, HOUR_IN_MS, LoadingSpinner, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, ParamType, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, TabBox, Variant, abbreviate, alert, avg, ceilToNumDecimals, confirm, floorToNumDecimals, forceNumIntoBounds, genRouteHandler, getOrdinal, getTimeInfoInET, handleError, handleSuccess, initServer, padDecimalZeros, padZerosLeft, roundToNumDecimals, showFatalError, startMinWait, stubServerEndpoint, sum, visitServerEndpoint, waitMs };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dce-reactkit",
-  "version": "3.0.35",
+  "version": "3.0.38",
   "description": "Shared components for Harvard DCE apps",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -23,7 +23,7 @@
     "@fortawesome/free-solid-svg-icons": "^6.1.1",
     "@fortawesome/react-fontawesome": "^0.1.18",
     "bootstrap": "^5.1.3",
-    "react": "^17.0.1"
+    "react": "^17.x.x"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^22.0.0",

package/src/components/PopSuccessMark.tsx

@@ -0,0 +1,172 @@
+/**
+ * Success checkmark that pops into view
+ * @author Gabe Abrams
+ */
+
+// Import React
+import React from 'react';
+
+/*------------------------------------------------------------------------*/
+/*                                  Types                                 */
+/*------------------------------------------------------------------------*/
+
+// Props definition
+type Props = {
+  // Size of checkmark in rem
+  sizeRem?: number,
+  // Bootstrap variant of circle
+  circleVariant?: string,
+  // Bootstrap variant of checkmark
+  checkVariant?: string,
+};
+
+/*------------------------------------------------------------------------*/
+/*                                  Style                                 */
+/*------------------------------------------------------------------------*/
+
+const style = `
+  .PopSuccessMark-outer-container {
+    position: relative;
+    display: inline-block;
+    border-radius: 50%;
+
+    animation-name: PopSuccessMark-outer-container;
+    animation-duration: 0.8s;
+    animation-fill-mode: both;
+    animation-iteration-count: 1;
+    animation-timing-function: ease-out;
+  }
+  @keyframes PopSuccessMark-outer-container {
+    0% {
+      opacity: 0;
+      transform: scale(1.5);
+      filter: saturate(0);
+    }
+    80.7% {
+      opacity: 1;
+      transform: scale(1);
+      filter: saturate(0);
+    }
+    100% {
+      opacity: 1;
+      transform: scale(1);
+      filter: saturate(1);
+    }
+  }
+
+  .PopSuccessMark-check-stroke-1 {
+    position: absolute;
+    left: 20%;
+    top: 36%;
+
+    display: inline-block;
+    height: 16%;
+    width: 35%;
+
+    transform-origin: left;
+
+    animation-name: PopSuccessMark-check-stroke-1;
+    animation-duration: 0.3s;
+    animation-delay: 0.3s;
+    animation-fill-mode: both;
+    animation-iteration-count: 1;
+    animation-timing-function: ease-in;
+  }
+  @keyframes PopSuccessMark-check-stroke-1 {
+    0% {
+      transform: rotate(45deg) scaleX(0);
+    }
+    100% {
+      transform: rotate(45deg) scaleX(1);
+    }
+  }
+
+
+  .PopSuccessMark-check-stroke-2 {
+    position: absolute;
+    left: 35%;
+    top: 63%;
+
+    display: inline-block;
+    height: 16%;
+    width: 60%;
+
+    transform-origin: left;
+
+    animation-name: PopSuccessMark-check-stroke-2;
+    animation-duration: 0.3s;
+    animation-delay: 0.6s;
+    animation-fill-mode: both;
+    animation-iteration-count: 1;
+    animation-timing-function: ease-out;
+  }
+  @keyframes PopSuccessMark-check-stroke-2 {
+    0% {
+      transform: rotate(-40deg) scaleX(0);
+    }
+    100% {
+      transform: rotate(-40deg) scaleX(1);
+    }
+  }
+`;
+
+/*------------------------------------------------------------------------*/
+/*                                Component                               */
+/*------------------------------------------------------------------------*/
+
+const PopSuccessMark: React.FC<Props> = (props) => {
+  /*------------------------------------------------------------------------*/
+  /*                                  Setup                                 */
+  /*------------------------------------------------------------------------*/
+
+  /* -------------- Props ------------- */
+
+  // Destructure all props
+  const {
+    sizeRem = 3,
+    circleVariant = 'success',
+    checkVariant = 'white',
+  } = props;
+
+  /*------------------------------------------------------------------------*/
+  /*                                 Render                                 */
+  /*------------------------------------------------------------------------*/
+
+  /*----------------------------------------*/
+  /*                 Main UI                */
+  /*----------------------------------------*/
+
+  return (
+    <div
+      className={`PopSuccessMark-outer-container bg-${circleVariant}`}
+      style={{
+        width: `${sizeRem}rem`,
+        height: `${sizeRem}rem`,
+      }}
+      aria-label="checkmark indicating success"
+    >
+      {/* Style */}
+      <style>{style}</style>
+      {/* Check mark */}
+      <div
+        className={`PopSuccessMark-check-stroke-1 bg-${checkVariant}`}
+        style={{
+          borderRadius: `${sizeRem / 5}rem`,
+        }}
+      />
+      <div
+        className={`PopSuccessMark-check-stroke-2 bg-${checkVariant}`}
+        style={{
+          borderRadius: `${sizeRem / 5}rem`,
+        }}
+      />
+    </div>
+  );
+};
+
+/*------------------------------------------------------------------------*/
+/*                                 Wrap Up                                */
+/*------------------------------------------------------------------------*/
+
+// Export component
+export default PopSuccessMark;

package/src/helpers/startMinWait.ts

@@ -0,0 +1,33 @@
+// Import other helpers
+import waitMs from './waitMs';
+
+/**
+ * Start a dynamic wait, call the function once the operation has completed and
+ *   the dynamic wait will continue waiting for the rest of the minimum time
+ * @author Gabe Abrams
+ * @param minWaitMs the minimum number of ms to wait
+ * @returns async function to call to finish the wait
+ */
+const startMinWait = (minWaitMs: number): () => Promise<void> => {
+  const startTimestamp = Date.now();
+
+  /**
+   * Finish the remaining time to wait
+   * @author Gabe Abrams
+   */
+  return async () => {
+    const endTimestamp = Date.now();
+
+    // Calculate remaining time to wait
+    const elapsedTimeMs = (endTimestamp - startTimestamp);
+    const remainingTimeToWaitMs = minWaitMs - elapsedTimeMs;
+    if (remainingTimeToWaitMs <= 0) {
+      return;
+    }
+
+    // Perform wait
+    await waitMs(remainingTimeToWaitMs);
+  };
+};
+
+export default startMinWait;

package/src/index.ts

@@ -9,6 +9,7 @@ import CheckboxButton from './components/CheckboxButton';
 import ButtonInputGroup from './components/ButtonInputGroup';
 import SimpleDateChooser from './components/SimpleDateChooser';
 import Drawer from './components/Drawer';
+import PopSuccessMark from './components/PopSuccessMark';
 
 // Import errors
 import ErrorWithCode from './errors/ErrorWithCode';
@@ -37,6 +38,7 @@ import initServer from './server/initServer';
 import getOrdinal from './helpers/getOrdinal';
 import getTimeInfoInET from './helpers/getTimeInfoInET';
 import stubServerEndpoint from './helpers/stubServerEndpoint';
+import startMinWait from './helpers/startMinWait';
 
 // Import types
 import ModalButtonType from './types/ModalButtonType';
@@ -59,6 +61,7 @@ export {
   ButtonInputGroup,
   SimpleDateChooser,
   Drawer,
+  PopSuccessMark,
   // Global functions
   alert,
   confirm,
@@ -83,6 +86,7 @@ export {
   getOrdinal,
   getTimeInfoInET,
   stubServerEndpoint,
+  startMinWait,
   // Client helpers
   visitServerEndpoint,
   // Server helpers