dce-reactkit 3.0.42 → 3.0.45

package/dist/index.d.ts

@@ -7,7 +7,7 @@ import React from 'react';
  * @author Gabe Abrams
  */
 
-declare type Props$b = {
+declare type Props$c = {
     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$b>;
+declare const AppWrapper: React.FC<Props$c>;
 
 /**
  * Loading spinner/indicator
@@ -65,12 +65,12 @@ declare const LoadingSpinner: () => JSX.Element;
  * @author Gabe Abrams
  */
 
-declare type Props$a = {
+declare type Props$b = {
     error: any;
     title?: string;
     onClose?: () => void;
 };
-declare const ErrorBox: React.FC<Props$a>;
+declare const ErrorBox: React.FC<Props$b>;
 
 /**
  * Bootstrap variants
@@ -136,7 +136,7 @@ declare enum ModalType {
  * @author Gabe Abrams
  */
 
-declare type Props$9 = {
+declare type Props$a = {
     type?: ModalType;
     size?: ModalSize;
     title?: React.ReactNode;
@@ -165,27 +165,27 @@ declare type Props$9 = {
     confirmVariant?: Variant;
     onTopOfOtherModals?: boolean;
 };
-declare const Modal: React.FC<Props$9>;
+declare const Modal: React.FC<Props$a>;
 
 /**
  * A box with a tab on the top that holds buttons and other content
  * @author Gabe Abrams
  */
 
-declare type Props$8 = {
+declare type Props$9 = {
     title: React.ReactNode;
     children: React.ReactNode;
     noBottomMargin?: boolean;
     noBottomPadding?: boolean;
 };
-declare const TabBox: React.FC<Props$8>;
+declare const TabBox: React.FC<Props$9>;
 
 /**
  * A radio selection button
  * @author Gabe Abrams
  */
 
-declare type Props$7 = {
+declare type Props$8 = {
     text: string;
     onSelected: () => void;
     ariaLabel: string;
@@ -197,14 +197,14 @@ declare type Props$7 = {
     unselectedVariant?: Variant;
     small?: boolean;
 };
-declare const RadioButton: React.FC<Props$7>;
+declare const RadioButton: React.FC<Props$8>;
 
 /**
  * A checkbox button
  * @author Gabe Abrams
  */
 
-declare type Props$6 = {
+declare type Props$7 = {
     text: string;
     onChanged: (checked: boolean) => void;
     ariaLabel: string;
@@ -216,26 +216,26 @@ declare type Props$6 = {
     uncheckedVariant?: Variant;
     small?: boolean;
 };
-declare const CheckboxButton: React.FC<Props$6>;
+declare const CheckboxButton: React.FC<Props$7>;
 
 /**
  * Input group with a title and space for buttons
  * @author Gabe Abrams
  */
 
-declare type Props$5 = {
+declare type Props$6 = {
     label: string;
     minLabelWidth?: string;
     children: React.ReactNode;
 };
-declare const ButtonInputGroup: React.FC<Props$5>;
+declare const ButtonInputGroup: React.FC<Props$6>;
 
 /**
  * A very simple, lightweight date chooser
  * @author Gabe Abrams
  */
 
-declare type Props$4 = {
+declare type Props$5 = {
     ariaLabel: string;
     name: string;
     month: number;
@@ -250,53 +250,70 @@ declare type Props$4 = {
     onChange: (month: number, day: number, year: number) => void;
     numMonthsToShow?: number;
 };
-declare const SimpleDateChooser: React.FC<Props$4>;
+declare const SimpleDateChooser: React.FC<Props$5>;
 
 /**
  * Drawer container
  * @author Gabe Abrams
  */
 
-declare type Props$3 = {
+declare type Props$4 = {
     children: React.ReactNode;
 };
-declare const Drawer: React.FC<Props$3>;
+declare const Drawer: React.FC<Props$4>;
 
 /**
  * Success checkmark that pops into view
  * @author Gabe Abrams
  */
 
-declare type Props$2 = {
+declare type Props$3 = {
     sizeRem?: number;
     circleVariant?: string;
     checkVariant?: string;
 };
-declare const PopSuccessMark: React.FC<Props$2>;
+declare const PopSuccessMark: React.FC<Props$3>;
 
 /**
  * Failure x mark that pops into view
  * @author Gabe Abrams
  */
 
-declare type Props$1 = {
+declare type Props$2 = {
     sizeRem?: number;
     circleVariant?: string;
     xVariant?: string;
 };
-declare const PopFailureMark: React.FC<Props$1>;
+declare const PopFailureMark: React.FC<Props$2>;
 
 /**
  * Failure pending that pops into view
  * @author Gabe Abrams
  */
 
-declare type Props = {
+declare type Props$1 = {
     sizeRem?: number;
     circleVariant?: string;
     hourglassVariant?: string;
 };
-declare const PopPendingMark: React.FC<Props>;
+declare const PopPendingMark: React.FC<Props$1>;
+
+/**
+ * Copiable text box
+ * @author Gabe Abrams
+ */
+
+declare type Props = {
+    name: string;
+    text: string;
+    label: string;
+    labelIcon?: any;
+    minLabelWidthRem?: number;
+    multiline?: boolean;
+    numVisibleLines?: number;
+    onClick?: () => void;
+};
+declare const CopiableBox: React.FC<Props>;
 
 /**
  * An error with a code
@@ -594,4 +611,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, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, TabBox, Variant, abbreviate, alert, avg, ceilToNumDecimals, confirm, floorToNumDecimals, forceNumIntoBounds, genRouteHandler, getHumanReadableDate, getOrdinal, getTimeInfoInET, handleError, handleSuccess, initServer, padDecimalZeros, padZerosLeft, roundToNumDecimals, showFatalError, startMinWait, stubServerEndpoint, sum, visitServerEndpoint, waitMs };
+export { AppWrapper, ButtonInputGroup, CheckboxButton, CopiableBox, DAY_IN_MS, Drawer, ErrorBox, ErrorWithCode, HOUR_IN_MS, LoadingSpinner, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, ParamType, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, TabBox, Variant, abbreviate, alert, avg, ceilToNumDecimals, confirm, floorToNumDecimals, forceNumIntoBounds, genRouteHandler, getHumanReadableDate, 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.42",
+  "version": "3.0.45",
   "description": "Shared components for Harvard DCE apps",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/components/CopiableBox.tsx

@@ -0,0 +1,296 @@
+/**
+ * Copiable text box
+ * @author Gabe Abrams
+ */
+
+// Import React
+import React, { useReducer } from 'react';
+
+// Import other reactkit functions
+import { alert, waitMs } from '..';
+
+// Import FontAwesome
+import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
+import { faClipboard } from '@fortawesome/free-solid-svg-icons';
+
+/*------------------------------------------------------------------------*/
+/*                                  Types                                 */
+/*------------------------------------------------------------------------*/
+
+// Props definition
+type Props = {
+  // Unique name of the item to copy (no spaces, compatible with css classes)
+  name: string,
+  // The text to copy
+  text: string,
+  // Human-readable label of the copy field
+  label: string,
+  // FontAwesome icon to place before the label
+  labelIcon?: any,
+  // If defined, the label will have a minimum width
+  minLabelWidthRem?: number,
+  // If true, the box will be a textarea to support larger, multiline text
+  multiline?: boolean,
+  // Number of lines to show in multiline view (only relevant if multiline)
+  numVisibleLines?: number,
+  // If defined, text box becomes clickable and this is the handler
+  onClick?: () => void,
+};
+
+/*------------------------------------------------------------------------*/
+/*                                  State                                 */
+/*------------------------------------------------------------------------*/
+
+/* -------- State Definition -------- */
+
+type State = {
+  // True if text was recently copied
+  recentlyCopied: boolean,
+};
+
+/* ------------- Actions ------------ */
+
+// Types of actions
+enum ActionType {
+  // Indicate that the text was recently copied
+  IndicateRecentlyCopied = 'indicate-recently-copied',
+  // Clear the status
+  ClearRecentlyCopiedStatus = 'clear-recently-copied-status',
+}
+
+// Action definitions
+type Action = {
+  // Action type
+  type: (
+    | ActionType.IndicateRecentlyCopied
+    | ActionType.ClearRecentlyCopiedStatus
+  ),
+};
+
+/**
+ * Reducer that executes actions
+ * @author Gabe Abrams
+ * @param state current state
+ * @param action action to execute
+ */
+const reducer = (state: State, action: Action): State => {
+  switch (action.type) {
+    case ActionType.IndicateRecentlyCopied: {
+      return {
+        recentlyCopied: true,
+      };
+    }
+    case ActionType.ClearRecentlyCopiedStatus: {
+      return {
+        recentlyCopied: false,
+      };
+    }
+    default: {
+      return state;
+    }
+  }
+};
+
+/*------------------------------------------------------------------------*/
+/*                                Component                               */
+/*------------------------------------------------------------------------*/
+
+const CopiableBox: React.FC<Props> = (props) => {
+  /*------------------------------------------------------------------------*/
+  /*                                  Setup                                 */
+  /*------------------------------------------------------------------------*/
+
+  /* -------------- Props ------------- */
+
+  // Destructure all props
+  const {
+    name,
+    text,
+    label,
+    labelIcon,
+    minLabelWidthRem,
+    multiline,
+    numVisibleLines = 10,
+    onClick,
+  } = props;
+
+  /* -------------- State ------------- */
+
+  // Initial state
+  const initialState: State = {
+    recentlyCopied: false,
+  };
+
+  // Initialize state
+  const [state, dispatch] = useReducer(reducer, initialState);
+
+  // Destructure common state
+  const {
+    recentlyCopied,
+  } = state;
+
+  /*------------------------------------------------------------------------*/
+  /*                           Component Functions                          */
+  /*------------------------------------------------------------------------*/
+
+  // Determine the id for the copiable text field
+  const copiableFieldClassName = `CopiableBox-text-box-${name}`;
+
+  /**
+   * Perform a copy
+   * @author Gabe Abrams
+   */
+  const performCopy = async () => {
+    // Write to clipboard
+    let copyFailed = false;
+    try {
+      await navigator.clipboard.writeText(text);
+    } catch (err) {
+      copyFailed = true;
+    }
+
+    // Try copy again if it failed
+    if (copyFailed) {
+      try {
+        const input = (
+          document.getElementsByClassName(copiableFieldClassName)[0]
+        ) as HTMLInputElement;
+        input.focus();
+        input.select();
+        document.execCommand('copy');
+        input.blur();
+      } catch (err) {
+        return alert(
+          'Unable to copy',
+          'Oops! We couldn\'t copy that to the clipboard. Please copy the text manually.',
+        );
+      }
+    }
+
+    // Show copied notice
+    dispatch({
+      type: ActionType.IndicateRecentlyCopied,
+    });
+
+    // Wait a moment
+    await waitMs(4000);
+
+    // Hide copied notice
+    dispatch({
+      type: ActionType.ClearRecentlyCopiedStatus,
+    });
+  };
+
+  /*------------------------------------------------------------------------*/
+  /*                                 Render                                 */
+  /*------------------------------------------------------------------------*/
+
+  /*----------------------------------------*/
+  /*                 Main UI                */
+  /*----------------------------------------*/
+
+  return (
+    <div className="input-group mb-2">
+      {/* Label */}
+      <span
+        className="input-group-text"
+        style={{
+          minWidth: (
+            minLabelWidthRem
+              ? `${minLabelWidthRem}rem`
+              : undefined
+          ),
+        }}
+      >
+        {labelIcon && (
+          <FontAwesomeIcon
+            icon={labelIcon}
+            className="me-1"
+          />
+        )}
+        {label}
+      </span>
+
+      {/* Text */}
+      {
+        multiline
+          ? (
+            <textarea
+              className={`${copiableFieldClassName} CopiableBox-text-multiline form-control bg-white text-dark`}
+              value={text}
+              aria-label={`${label} text`}
+              rows={numVisibleLines}
+              onClick={onClick}
+              style={{
+                cursor: (
+                  onClick
+                    ? 'pointer'
+                    : 'default'
+                ),
+                textDecoration: (
+                  onClick
+                    ? 'underline'
+                    : undefined
+                ),
+              }}
+              readOnly
+            />
+          )
+          : (
+            <input
+              type="text"
+              className={`${copiableFieldClassName} CopiableBox-text-single-line form-control bg-white text-dark`}
+              value={text}
+              aria-label={`${label} text`}
+              onClick={onClick}
+              style={{
+                cursor: (
+                  onClick
+                    ? 'pointer'
+                    : 'default'
+                ),
+                textDecoration: (
+                  onClick
+                    ? 'underline'
+                    : undefined
+                ),
+              }}
+              readOnly
+            />
+          )
+      }
+      
+      <button
+        className="btn btn-secondary"
+        type="button"
+        aria-label={`copy ${label} to the clipboard`}
+        disabled={recentlyCopied}
+        style={{
+          minWidth: '5.2rem',
+        }}
+        onClick={performCopy}
+      >
+        {
+          recentlyCopied
+            ? 'Copied!'
+            : (
+              <span>
+                <FontAwesomeIcon
+                  icon={faClipboard}
+                  className="me-1"
+                />
+                Copy
+              </span>
+            )
+        }
+      </button>
+    </div>
+  );
+};
+
+/*------------------------------------------------------------------------*/
+/*                                 Wrap Up                                */
+/*------------------------------------------------------------------------*/
+
+// Export component
+export default CopiableBox;

package/src/index.ts

@@ -12,6 +12,7 @@ import Drawer from './components/Drawer';
 import PopSuccessMark from './components/PopSuccessMark';
 import PopFailureMark from './components/PopFailureMark';
 import PopPendingMark from './components/PopPendingMark';
+import CopiableBox from './components/CopiableBox';
 
 // Import errors
 import ErrorWithCode from './errors/ErrorWithCode';
@@ -67,6 +68,7 @@ export {
   PopSuccessMark,
   PopFailureMark,
   PopPendingMark,
+  CopiableBox,
   // Global functions
   alert,
   confirm,