dce-reactkit 3.8.5 → 3.8.6

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

@@ -21,6 +21,7 @@ import Tooltip from './components/Tooltip';
 import ToggleSwitch from './components/ToggleSwitch';
 import AutoscrollToBottomContainer from './components/AutoscrollToBottomContainer';
 import MultiSwitch from './components/MultiSwitch';
+import Dropdown from './components/Dropdown';
 import ErrorWithCode from './errors/ErrorWithCode';
 import MINUTE_IN_MS from './constants/MINUTE_IN_MS';
 import HOUR_IN_MS from './constants/HOUR_IN_MS';
@@ -92,8 +93,9 @@ import LogBuiltInMetadata from './types/LogBuiltInMetadata';
 import LogMetadataType from './types/LogMetadataType';
 import LogFunction from './types/LogFunction';
 import IntelliTableColumn from './types/IntelliTableColumn';
+import DropdownItemType from './types/DropdownItemType';
 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, 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, prefixWithAOrAn, everyAsync, filterAsync, forEachAsync, mapAsync, someAsync, capitalize, shuffleArray, initClient, visitServerEndpoint, logClientEvent, addFatalErrorHandler, leaveToURL, combineClassNames, useForceRender, setClientEventMetadataPopulator, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, addDBEditorEndpoints, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, LogFunction, 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, Dropdown, 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, prefixWithAOrAn, everyAsync, filterAsync, forEachAsync, mapAsync, someAsync, capitalize, shuffleArray, initClient, visitServerEndpoint, logClientEvent, addFatalErrorHandler, leaveToURL, combineClassNames, useForceRender, setClientEventMetadataPopulator, initServer, genRouteHandler, handleError, handleSuccess, initLogCollection, addDBEditorEndpoints, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, DayOfWeek, Log, LogType, LogSource, LogAction, LogBuiltInMetadata, LogMetadataType, LogFunction, IntelliTableColumn, DropdownItemType, 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$1.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$1.FC<Props$k>;
+declare const AppWrapper: React$1.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$1.FC<Props$j>;
+declare const ErrorBox: React$1.FC<Props$k>;
 
 /**
  * Types of buttons in the modal
@@ -191,20 +191,20 @@ declare const Modal: React$1.FC<ModalProps>;
  * @author Gabe Abrams
  */
 
-type Props$i = {
+type Props$j = {
     title: React$1.ReactNode;
     children: React$1.ReactNode;
     noBottomMargin?: boolean;
     noBottomPadding?: boolean;
 };
-declare const TabBox: React$1.FC<Props$i>;
+declare const TabBox: React$1.FC<Props$j>;
 
 /**
  * A radio selection button
  * @author Gabe Abrams
  */
 
-type Props$h = {
+type Props$i = {
     text: React$1.ReactNode;
     onSelected: () => void;
     ariaLabel: string;
@@ -216,14 +216,14 @@ type Props$h = {
     unselectedVariant?: Variant;
     small?: boolean;
 };
-declare const RadioButton: React$1.FC<Props$h>;
+declare const RadioButton: React$1.FC<Props$i>;
 
 /**
  * A checkbox button
  * @author Gabe Abrams
  */
 
-type Props$g = {
+type Props$h = {
     text: React$1.ReactNode;
     onChanged: (checked: boolean) => void;
     ariaLabel: string;
@@ -237,14 +237,14 @@ type Props$g = {
     small?: boolean;
     dashed?: boolean;
 };
-declare const CheckboxButton: React$1.FC<Props$g>;
+declare const CheckboxButton: React$1.FC<Props$h>;
 
 /**
  * Input group with a title and space for buttons
  * @author Gabe Abrams
  */
 
-type Props$f = {
+type Props$g = {
     label: React$1.ReactNode;
     minLabelWidth?: string;
     children: React$1.ReactNode;
@@ -253,14 +253,14 @@ type Props$f = {
     isAdminFeature?: boolean;
     noMarginOnBottom?: boolean;
 };
-declare const ButtonInputGroup: React$1.FC<Props$f>;
+declare const ButtonInputGroup: React$1.FC<Props$g>;
 
 /**
  * A very simple, lightweight date chooser
  * @author Gabe Abrams
  */
 
-type Props$e = {
+type Props$f = {
     ariaLabel: string;
     name: string;
     month: number;
@@ -276,62 +276,62 @@ type Props$e = {
     numMonthsToShow?: number;
     chooseFromPast?: boolean;
 };
-declare const SimpleDateChooser: React$1.FC<Props$e>;
+declare const SimpleDateChooser: React$1.FC<Props$f>;
 
 /**
  * Drawer container
  * @author Gabe Abrams
  */
 
-type Props$d = {
+type Props$e = {
     grayBackground?: boolean;
     customBackgroundColor?: string;
     children: React$1.ReactNode;
 };
-declare const Drawer: React$1.FC<Props$d>;
+declare const Drawer: React$1.FC<Props$e>;
 
 /**
  * Success checkmark that pops into view
  * @author Gabe Abrams
  */
 
-type Props$c = {
+type Props$d = {
     sizeRem?: number;
     circleVariant?: string;
     checkVariant?: string;
 };
-declare const PopSuccessMark: React$1.FC<Props$c>;
+declare const PopSuccessMark: React$1.FC<Props$d>;
 
 /**
  * Failure x mark that pops into view
  * @author Gabe Abrams
  */
 
-type Props$b = {
+type Props$c = {
     sizeRem?: number;
     circleVariant?: string;
     xVariant?: string;
 };
-declare const PopFailureMark: React$1.FC<Props$b>;
+declare const PopFailureMark: React$1.FC<Props$c>;
 
 /**
  * Failure pending that pops into view
  * @author Gabe Abrams
  */
 
-type Props$a = {
+type Props$b = {
     sizeRem?: number;
     circleVariant?: string;
     hourglassVariant?: string;
 };
-declare const PopPendingMark: React$1.FC<Props$a>;
+declare const PopPendingMark: React$1.FC<Props$b>;
 
 /**
  * Copiable text box
  * @author Gabe Abrams
  */
 
-type Props$9 = {
+type Props$a = {
     text: string;
     maxTextWidthRem?: number;
     label?: string;
@@ -343,7 +343,7 @@ type Props$9 = {
     textAreaId?: string;
     copyButtonId?: string;
 };
-declare const CopiableBox: React$1.FC<Props$9>;
+declare const CopiableBox: React$1.FC<Props$a>;
 
 /**
  * An item that can be chosen (for use within ItemPicker)
@@ -366,7 +366,7 @@ type PickableItem = ({
  * @author Yuen Ler Chow
  */
 
-type Props$8 = {
+type Props$9 = {
     title: string;
     items: PickableItem[];
     /**
@@ -377,7 +377,7 @@ type Props$8 = {
     onChanged: (updatedItems: PickableItem[]) => void;
     noBottomMargin?: boolean;
 };
-declare const ItemPicker: React$1.FC<Props$8>;
+declare const ItemPicker: React$1.FC<Props$9>;
 
 /**
  * Type of the context map in a LogMetadata file
@@ -422,11 +422,11 @@ type LogMetadataType = {
  * @author Gabe Abrams
  */
 
-type Props$7 = {
+type Props$8 = {
     LogMetadata: LogMetadataType;
     onClose: () => void;
 };
-declare const LogReviewer: React$1.FC<Props$7>;
+declare const LogReviewer: React$1.FC<Props$8>;
 
 /**
  * Server-side API param types
@@ -461,7 +461,7 @@ type IntelliTableColumn = {
  * @author Gabe Abrams
  */
 
-type Props$6 = {
+type Props$7 = {
     title: string;
     id: string;
     data: {
@@ -471,14 +471,14 @@ type Props$6 = {
     columns: IntelliTableColumn[];
     csvName?: string;
 };
-declare const IntelliTable: React$1.FC<Props$6>;
+declare const IntelliTable: React$1.FC<Props$7>;
 
 /**
  * Button for downloading a csv file
  * @author Gabe Abrams
  */
 
-type Props$5 = {
+type Props$6 = {
     filename: string;
     csv: string;
     id?: string;
@@ -490,7 +490,7 @@ type Props$5 = {
     onClick?: () => void;
     children?: React$1.ReactNode;
 };
-declare const CSVDownloadButton: React$1.FC<Props$5>;
+declare const CSVDownloadButton: React$1.FC<Props$6>;
 
 /**
  * Generic type for an object
@@ -566,7 +566,7 @@ type DBEntryField = ({
  * @author Gabe Abrams
  */
 
-type Props$4 = {
+type Props$5 = {
     entryFields: DBEntryField[];
     idPropName: string;
     titlePropName: string;
@@ -592,18 +592,18 @@ type Props$4 = {
         [k: string]: any;
     };
 };
-declare const DBEntryManagerPanel: React$1.FC<Props$4>;
+declare const DBEntryManagerPanel: React$1.FC<Props$5>;
 
 /**
  * Simple tooltip component
  * @author Gabe Abrams
  */
 
-type Props$3 = {
+type Props$4 = {
     text: string;
     children: JSX.Element;
 };
-declare const Tooltip: React$1.FC<Props$3>;
+declare const Tooltip: React$1.FC<Props$4>;
 
 /**
  * A toggle switch that toggles on or off
@@ -611,7 +611,7 @@ declare const Tooltip: React$1.FC<Props$3>;
  * @author Gabe Abrams
  */
 
-type Props$2 = {
+type Props$3 = {
     isOn: boolean;
     /**
      * A handler to call when the switch is toggled
@@ -623,7 +623,7 @@ type Props$2 = {
     description: string;
     backgroundVariantWhenOn?: Variant;
 };
-declare const ToggleSwitch: React$1.FC<Props$2>;
+declare const ToggleSwitch: React$1.FC<Props$3>;
 
 /**
  * Container that automatically scrolls when new items are added,
@@ -634,7 +634,7 @@ declare const ToggleSwitch: React$1.FC<Props$2>;
  * @author Gabe Abrams
  */
 
-type Props$1 = {
+type Props$2 = {
     itemsName?: string;
     items: AutoScrollItem[];
     jumpToBottomButtonVariant?: Variant;
@@ -645,7 +645,7 @@ type AutoScrollItem = {
     id: string | number;
     item: React$1.ReactNode;
 };
-declare const AutoscrollToBottomContainer: React$1.FC<Props$1>;
+declare const AutoscrollToBottomContainer: React$1.FC<Props$2>;
 
 /**
  * A switch with multiple options for selection
@@ -654,7 +654,7 @@ declare const AutoscrollToBottomContainer: React$1.FC<Props$1>;
  * @author Austen Money
  */
 
-type Props = {
+type Props$1 = {
     options: Option[];
     selectedOptionId: string;
     /**
@@ -669,7 +669,43 @@ type Option = {
     icon: IconProp;
     id: string;
 };
-declare const MultiSwitch: React$1.FC<Props>;
+declare const MultiSwitch: React$1.FC<Props$1>;
+
+declare enum DropdownItemType {
+    Header = "Header",
+    Divider = "Divider",
+    Item = "Item"
+}
+
+/**
+ * A simple dropdown menu
+ * @author Alessandra De Lucas
+ * @author Yuen Ler Chow
+ * @author Gabe Abrams
+ */
+
+type Props = {
+    items: DropdownItem[];
+    dropdownButton: {
+        ariaLabel: string;
+        id: string;
+        content?: React$1.ReactNode;
+        variant?: Variant;
+    };
+};
+type DropdownItem = ({
+    type: DropdownItemType.Header;
+    content: React$1.ReactNode;
+} | {
+    type: DropdownItemType.Divider;
+} | {
+    type: DropdownItemType.Item;
+    content: React$1.ReactNode;
+    ariaLabel: string;
+    id: string;
+    onClick: () => void;
+});
+declare const Dropdown: React$1.FC<Props>;
 
 /**
  * An error with a code
@@ -1617,4 +1653,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, LogFunction, 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, capitalize, ceilToNumDecimals, combineClassNames, compareArraysByProp, confirm, everyAsync, extractProp, filterAsync, floorToNumDecimals, forEachAsync, forceNumIntoBounds, genCSV, genCommaList, genRouteHandler, getHumanReadableDate, getLocalTimeInfo, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, handleError, handleSuccess, idify, initClient, initLogCollection, initServer, isMobileOrTablet, leaveToURL, logClientEvent, makeLinksClickable, mapAsync, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, prefixWithAOrAn, roundToNumDecimals, setClientEventMetadataPopulator, showFatalError, shuffleArray, someAsync, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, useForceRender, validateEmail, validatePhoneNumber, validateString, visitServerEndpoint, waitMs };
+export { AppWrapper, AutoscrollToBottomContainer, ButtonInputGroup, CSVDownloadButton, CheckboxButton, CopiableBox, DAY_IN_MS, DBEntry, DBEntryField, DBEntryFieldType, DBEntryManagerPanel, DayOfWeek, Drawer, Dropdown, DropdownItemType, DynamicWord, ErrorBox, ErrorWithCode, HOUR_IN_MS, IntelliTable, IntelliTableColumn, ItemPicker, LoadingSpinner, Log, LogAction, LogBuiltInMetadata, LogFunction, 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, capitalize, ceilToNumDecimals, combineClassNames, compareArraysByProp, confirm, everyAsync, extractProp, filterAsync, floorToNumDecimals, forEachAsync, forceNumIntoBounds, genCSV, genCommaList, genRouteHandler, getHumanReadableDate, getLocalTimeInfo, getMonthName, getOrdinal, getPartOfDay, getTimeInfoInET, handleError, handleSuccess, idify, initClient, initLogCollection, initServer, isMobileOrTablet, leaveToURL, logClientEvent, makeLinksClickable, mapAsync, onlyKeepLetters, padDecimalZeros, padZerosLeft, parallelLimit, prefixWithAOrAn, roundToNumDecimals, setClientEventMetadataPopulator, showFatalError, shuffleArray, someAsync, startMinWait, stringsToHumanReadableList, stubServerEndpoint, sum, useForceRender, validateEmail, validatePhoneNumber, validateString, visitServerEndpoint, waitMs };

package/package.json

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

package/src/index.ts

@@ -28,6 +28,7 @@ import Tooltip from './components/Tooltip';
 import ToggleSwitch from './components/ToggleSwitch';
 import AutoscrollToBottomContainer from './components/AutoscrollToBottomContainer';
 import MultiSwitch from './components/MultiSwitch';
+import Dropdown from './components/Dropdown';
 
 // Import errors
 import ErrorWithCode from './errors/ErrorWithCode';
@@ -109,6 +110,7 @@ import LogBuiltInMetadata from './types/LogBuiltInMetadata';
 import LogMetadataType from './types/LogMetadataType';
 import LogFunction from './types/LogFunction';
 import IntelliTableColumn from './types/IntelliTableColumn';
+import DropdownItemType from './types/DropdownItemType';
 
 // Component-specific-types
 import PickableItem from './components/ItemPicker/types/PickableItem';
@@ -142,6 +144,7 @@ export {
   ToggleSwitch,
   AutoscrollToBottomContainer,
   MultiSwitch,
+  Dropdown,
   // Global functions
   alert,
   confirm,
@@ -226,6 +229,7 @@ export {
   LogMetadataType,
   LogFunction,
   IntelliTableColumn,
+  DropdownItemType,
   // Component-specific-types
   PickableItem,
   DBEntry,