dce-reactkit 3.6.8 → 3.6.9

package/dist/esm/types/components/MultiSwitch.d.ts

@@ -0,0 +1,24 @@
+/**
+ * A switch with multiple options for selection
+ * @author Alessandra De Lucas
+ * @author Gabe Abrams
+ */
+import React from 'react';
+import { IconProp } from '@fortawesome/fontawesome-svg-core';
+type Props = {
+    options: Option[];
+    selectedOptionId: string;
+    /**
+     * A handler to call when the switch is changed
+     * @param selectedOptionId Updated option when switch is changed
+     */
+    onChange: (selectedOptionId: string) => void;
+    heightRem?: number;
+};
+type Option = {
+    label: string;
+    icon: IconProp;
+    id: string;
+};
+declare const MultiSwitch: React.FC<Props>;
+export default MultiSwitch;

package/dist/esm/types/index.d.ts

@@ -20,6 +20,7 @@ import DBEntryManagerPanel from './components/DBEntryManagerPanel';
 import Tooltip from './components/Tooltip';
 import ToggleSwitch from './components/ToggleSwitch';
 import AutoscrollToBottomContainer from './components/AutoscrollToBottomContainer';
+import MultiSwitch from './components/MultiSwitch';
 import ErrorWithCode from './errors/ErrorWithCode';
 import MINUTE_IN_MS from './constants/MINUTE_IN_MS';
 import HOUR_IN_MS from './constants/HOUR_IN_MS';
@@ -84,4 +85,4 @@ import PickableItem from './components/ItemPicker/types/PickableItem';
 import DBEntry from './components/DBEntryManagerPanel/types/DBEntry';
 import DBEntryField from './components/DBEntryManagerPanel/types/DBEntryField';
 import DBEntryFieldType from './components/DBEntryManagerPanel/types/DBEntryFieldType';
-export { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, RadioButton, CheckboxButton, ButtonInputGroup, SimpleDateChooser, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, LogReviewer, IntelliTable, CSVDownloadButton, DBEntryManagerPanel, Tooltip, ToggleSwitch, AutoscrollToBottomContainer, alert, confirm, showFatalError, ErrorWithCode, MINUTE_IN_MS, HOUR_IN_MS, DAY_IN_MS, DynamicWord, abbreviate, avg, ceilToNumDecimals, floorToNumDecimals, forceNumIntoBounds, padDecimalZeros, padZerosLeft, roundToNumDecimals, sum, waitMs, getOrdinal, getTimeInfoInET, stubServerEndpoint, startMinWait, getHumanReadableDate, getPartOfDay, stringsToHumanReadableList, onlyKeepLetters, parallelLimit, getMonthName, genCSV, canReviewLogs, isMobileOrTablet, extractProp, compareArraysByProp, genCommaList, validateEmail, validatePhoneNumber, validateString, getLocalTimeInfo, idify, makeLinksClickable, initClient, visitServerEndpoint, logClientEvent, addFatalErrorHandler, leaveToURL, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, addDBEditorEndpoints, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, IntelliTableColumn, PickableItem, DBEntry, DBEntryField, DBEntryFieldType, ParamType, };
+export { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, RadioButton, CheckboxButton, ButtonInputGroup, SimpleDateChooser, Drawer, PopSuccessMark, PopFailureMark, PopPendingMark, CopiableBox, ItemPicker, LogReviewer, IntelliTable, CSVDownloadButton, DBEntryManagerPanel, Tooltip, ToggleSwitch, AutoscrollToBottomContainer, MultiSwitch, alert, confirm, showFatalError, ErrorWithCode, MINUTE_IN_MS, HOUR_IN_MS, DAY_IN_MS, DynamicWord, abbreviate, avg, ceilToNumDecimals, floorToNumDecimals, forceNumIntoBounds, padDecimalZeros, padZerosLeft, roundToNumDecimals, sum, waitMs, getOrdinal, getTimeInfoInET, stubServerEndpoint, startMinWait, getHumanReadableDate, getPartOfDay, stringsToHumanReadableList, onlyKeepLetters, parallelLimit, getMonthName, genCSV, canReviewLogs, isMobileOrTablet, extractProp, compareArraysByProp, genCommaList, validateEmail, validatePhoneNumber, validateString, getLocalTimeInfo, idify, makeLinksClickable, initClient, visitServerEndpoint, logClientEvent, addFatalErrorHandler, leaveToURL, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, addDBEditorEndpoints, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, IntelliTableColumn, PickableItem, DBEntry, DBEntryField, DBEntryFieldType, ParamType, };

package/dist/index.d.ts

@@ -24,7 +24,7 @@ declare enum Variant {
  * @author Gabe Abrams
  */
 
-type Props$k = {
+type Props$l = {
     children: React.ReactNode;
 };
 /**
@@ -75,7 +75,7 @@ declare const showFatalError: (error: any, errorTitle?: string) => Promise<void>
  * @author Gabe Abrams
  */
 declare const addFatalErrorHandler: (handler: () => void) => void;
-declare const AppWrapper: React.FC<Props$k>;
+declare const AppWrapper: React.FC<Props$l>;
 
 /**
  * Loading spinner/indicator
@@ -88,14 +88,14 @@ declare const LoadingSpinner: () => JSX.Element;
  * @author Gabe Abrams
  */
 
-type Props$j = {
+type Props$k = {
     error: any;
     title?: string;
     onClose?: () => void;
     variant?: Variant;
     icon?: IconProp;
 };
-declare const ErrorBox: React.FC<Props$j>;
+declare const ErrorBox: React.FC<Props$k>;
 
 /**
  * Types of buttons in the modal
@@ -146,7 +146,7 @@ declare enum ModalType {
  * @author Gabe Abrams
  */
 
-type Props$i = {
+type Props$j = {
     type?: ModalType;
     size?: ModalSize;
     title?: React.ReactNode;
@@ -175,27 +175,27 @@ type Props$i = {
     confirmVariant?: Variant;
     onTopOfOtherModals?: boolean;
 };
-declare const Modal: React.FC<Props$i>;
+declare const Modal: React.FC<Props$j>;
 
 /**
  * A box with a tab on the top that holds buttons and other content
  * @author Gabe Abrams
  */
 
-type Props$h = {
+type Props$i = {
     title: React.ReactNode;
     children: React.ReactNode;
     noBottomMargin?: boolean;
     noBottomPadding?: boolean;
 };
-declare const TabBox: React.FC<Props$h>;
+declare const TabBox: React.FC<Props$i>;
 
 /**
  * A radio selection button
  * @author Gabe Abrams
  */
 
-type Props$g = {
+type Props$h = {
     text: string;
     onSelected: () => void;
     ariaLabel: string;
@@ -207,14 +207,14 @@ type Props$g = {
     unselectedVariant?: Variant;
     small?: boolean;
 };
-declare const RadioButton: React.FC<Props$g>;
+declare const RadioButton: React.FC<Props$h>;
 
 /**
  * A checkbox button
  * @author Gabe Abrams
  */
 
-type Props$f = {
+type Props$g = {
     text: string;
     onChanged: (checked: boolean) => void;
     ariaLabel: string;
@@ -228,28 +228,28 @@ type Props$f = {
     small?: boolean;
     dashed?: boolean;
 };
-declare const CheckboxButton: React.FC<Props$f>;
+declare const CheckboxButton: React.FC<Props$g>;
 
 /**
  * Input group with a title and space for buttons
  * @author Gabe Abrams
  */
 
-type Props$e = {
+type Props$f = {
     label: string;
     minLabelWidth?: string;
     children: React.ReactNode;
     className?: string;
     wrapButtonsAndAddGaps?: boolean;
 };
-declare const ButtonInputGroup: React.FC<Props$e>;
+declare const ButtonInputGroup: React.FC<Props$f>;
 
 /**
  * A very simple, lightweight date chooser
  * @author Gabe Abrams
  */
 
-type Props$d = {
+type Props$e = {
     ariaLabel: string;
     name: string;
     month: number;
@@ -265,61 +265,61 @@ type Props$d = {
     numMonthsToShow?: number;
     chooseFromPast?: boolean;
 };
-declare const SimpleDateChooser: React.FC<Props$d>;
+declare const SimpleDateChooser: React.FC<Props$e>;
 
 /**
  * Drawer container
  * @author Gabe Abrams
  */
 
-type Props$c = {
+type Props$d = {
     customBackgroundColor?: string;
     children: React.ReactNode;
 };
-declare const Drawer: React.FC<Props$c>;
+declare const Drawer: React.FC<Props$d>;
 
 /**
  * Success checkmark that pops into view
  * @author Gabe Abrams
  */
 
-type Props$b = {
+type Props$c = {
     sizeRem?: number;
     circleVariant?: string;
     checkVariant?: string;
 };
-declare const PopSuccessMark: React.FC<Props$b>;
+declare const PopSuccessMark: React.FC<Props$c>;
 
 /**
  * Failure x mark that pops into view
  * @author Gabe Abrams
  */
 
-type Props$a = {
+type Props$b = {
     sizeRem?: number;
     circleVariant?: string;
     xVariant?: string;
 };
-declare const PopFailureMark: React.FC<Props$a>;
+declare const PopFailureMark: React.FC<Props$b>;
 
 /**
  * Failure pending that pops into view
  * @author Gabe Abrams
  */
 
-type Props$9 = {
+type Props$a = {
     sizeRem?: number;
     circleVariant?: string;
     hourglassVariant?: string;
 };
-declare const PopPendingMark: React.FC<Props$9>;
+declare const PopPendingMark: React.FC<Props$a>;
 
 /**
  * Copiable text box
  * @author Gabe Abrams
  */
 
-type Props$8 = {
+type Props$9 = {
     text: string;
     maxTextWidthRem?: number;
     label?: string;
@@ -331,7 +331,7 @@ type Props$8 = {
     textAreaId?: string;
     copyButtonId?: string;
 };
-declare const CopiableBox: React.FC<Props$8>;
+declare const CopiableBox: React.FC<Props$9>;
 
 /**
  * An item that can be chosen (for use within ItemPicker)
@@ -354,7 +354,7 @@ type PickableItem = ({
  * @author Yuen Ler Chow
  */
 
-type Props$7 = {
+type Props$8 = {
     title: string;
     items: PickableItem[];
     /**
@@ -365,7 +365,7 @@ type Props$7 = {
     onChanged: (updatedItems: PickableItem[]) => void;
     noBottomMargin?: boolean;
 };
-declare const ItemPicker: React.FC<Props$7>;
+declare const ItemPicker: React.FC<Props$8>;
 
 /**
  * Type of the context map in a LogMetadata file
@@ -410,11 +410,11 @@ type LogMetadataType = {
  * @author Gabe Abrams
  */
 
-type Props$6 = {
+type Props$7 = {
     LogMetadata: LogMetadataType;
     onClose: () => void;
 };
-declare const LogReviewer: React.FC<Props$6>;
+declare const LogReviewer: React.FC<Props$7>;
 
 /**
  * Server-side API param types
@@ -449,7 +449,7 @@ type IntelliTableColumn = {
  * @author Gabe Abrams
  */
 
-type Props$5 = {
+type Props$6 = {
     title: string;
     id: string;
     data: {
@@ -459,14 +459,14 @@ type Props$5 = {
     columns: IntelliTableColumn[];
     csvName?: string;
 };
-declare const IntelliTable: React.FC<Props$5>;
+declare const IntelliTable: React.FC<Props$6>;
 
 /**
  * Button for downloading a csv file
  * @author Gabe Abrams
  */
 
-type Props$4 = {
+type Props$5 = {
     filename: string;
     csv: string;
     id?: string;
@@ -478,7 +478,7 @@ type Props$4 = {
     onClick?: () => void;
     children?: React.ReactNode;
 };
-declare const CSVDownloadButton: React.FC<Props$4>;
+declare const CSVDownloadButton: React.FC<Props$5>;
 
 /**
  * Generic type for an object
@@ -554,7 +554,7 @@ type DBEntryField = ({
  * @author Gabe Abrams
  */
 
-type Props$3 = {
+type Props$4 = {
     entryFields: DBEntryField[];
     idPropName: string;
     titlePropName: string;
@@ -580,14 +580,14 @@ type Props$3 = {
         [k: string]: any;
     };
 };
-declare const DBEntryManagerPanel: React.FC<Props$3>;
+declare const DBEntryManagerPanel: React.FC<Props$4>;
 
 /**
  * Simple tooltip component
  * @author Gabe Abrams
  */
 
-type Props$2 = {
+type Props$3 = {
     icon?: IconProp;
     text: string;
     children: React.ReactNode;
@@ -595,7 +595,7 @@ type Props$2 = {
     thin?: boolean;
     containerIsDisplayBlock?: boolean;
 };
-declare const Tooltip: React.FC<Props$2>;
+declare const Tooltip: React.FC<Props$3>;
 
 /**
  * A toggle switch that toggles on or off
@@ -603,7 +603,7 @@ declare const Tooltip: React.FC<Props$2>;
  * @author Gabe Abrams
  */
 
-type Props$1 = {
+type Props$2 = {
     isOn: boolean;
     /**
      * A handler to call when the switch is toggled
@@ -614,7 +614,7 @@ type Props$1 = {
     description: string;
     backgroundVariantWhenOn?: Variant;
 };
-declare const ToggleSwitch: React.FC<Props$1>;
+declare const ToggleSwitch: React.FC<Props$2>;
 
 /**
  * Container that automatically scrolls when new items are added,
@@ -625,7 +625,7 @@ declare const ToggleSwitch: React.FC<Props$1>;
  * @author Gabe Abrams
  */
 
-type Props = {
+type Props$1 = {
     itemsName?: string;
     items: AutoScrollItem[];
     jumpToBottomButtonVariant?: Variant;
@@ -636,7 +636,30 @@ type AutoScrollItem = {
     id: string | number;
     item: React.ReactNode;
 };
-declare const AutoscrollToBottomContainer: React.FC<Props>;
+declare const AutoscrollToBottomContainer: React.FC<Props$1>;
+
+/**
+ * A switch with multiple options for selection
+ * @author Alessandra De Lucas
+ * @author Gabe Abrams
+ */
+
+type Props = {
+    options: Option[];
+    selectedOptionId: string;
+    /**
+     * A handler to call when the switch is changed
+     * @param selectedOptionId Updated option when switch is changed
+     */
+    onChange: (selectedOptionId: string) => void;
+    heightRem?: number;
+};
+type Option = {
+    label: string;
+    icon: IconProp;
+    id: string;
+};
+declare const MultiSwitch: React.FC<Props>;
 
 /**
  * An error with a code
@@ -1443,4 +1466,4 @@ declare const LogBuiltInMetadata: {
     };
 };
 
-export { AppWrapper, AutoscrollToBottomContainer, ButtonInputGroup, CSVDownloadButton, CheckboxButton, CopiableBox, DAY_IN_MS, DBEntry, DBEntryField, DBEntryFieldType, DBEntryManagerPanel, DayOfWeek, Drawer, DynamicWord, ErrorBox, ErrorWithCode, HOUR_IN_MS, IntelliTable, IntelliTableColumn, ItemPicker, LoadingSpinner, Log, LogAction, LogBuiltInMetadata, LogMetadataType, LogReviewer, LogSource, LogType, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, ParamType, PickableItem, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, TabBox, ToggleSwitch, Tooltip, Variant, abbreviate, addDBEditorEndpoints, addFatalErrorHandler, alert, avg, canReviewLogs, ceilToNumDecimals, compareArraysByProp, confirm, extractProp, floorToNumDecimals, forceNumIntoBounds, genCSV, genCommaList, genRouteHandler, getHumanReadableDate, getLocalTimeInfo, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, handleError, handleSuccess, idify, initClient, initLogCollection, initServer, isMobileOrTablet, leaveToURL, logClientEvent, makeLinksClickable, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, roundToNumDecimals, showFatalError, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, validateEmail, validatePhoneNumber, validateString, visitServerEndpoint, waitMs };
+export { AppWrapper, AutoscrollToBottomContainer, ButtonInputGroup, CSVDownloadButton, CheckboxButton, CopiableBox, DAY_IN_MS, DBEntry, DBEntryField, DBEntryFieldType, DBEntryManagerPanel, DayOfWeek, Drawer, DynamicWord, ErrorBox, ErrorWithCode, HOUR_IN_MS, IntelliTable, IntelliTableColumn, ItemPicker, LoadingSpinner, Log, LogAction, LogBuiltInMetadata, LogMetadataType, LogReviewer, LogSource, LogType, MINUTE_IN_MS, Modal, ModalButtonType, ModalSize, ModalType, MultiSwitch, ParamType, PickableItem, PopFailureMark, PopPendingMark, PopSuccessMark, RadioButton, ReactKitErrorCode, SimpleDateChooser, TabBox, ToggleSwitch, Tooltip, Variant, abbreviate, addDBEditorEndpoints, addFatalErrorHandler, alert, avg, canReviewLogs, ceilToNumDecimals, compareArraysByProp, confirm, extractProp, floorToNumDecimals, forceNumIntoBounds, genCSV, genCommaList, genRouteHandler, getHumanReadableDate, getLocalTimeInfo, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, handleError, handleSuccess, idify, initClient, initLogCollection, initServer, isMobileOrTablet, leaveToURL, logClientEvent, makeLinksClickable, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, roundToNumDecimals, showFatalError, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, validateEmail, validatePhoneNumber, validateString, visitServerEndpoint, waitMs };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dce-reactkit",
-  "version": "3.6.8",
+  "version": "3.6.9",
   "description": "Shared components for Harvard DCE apps",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",