dce-reactkit 2.0.10 → 3.0.0-beta.1

package/dist/cjs/types/components/AppWrapper.d.ts

@@ -0,0 +1,40 @@
+/**
+ * A wrapper for the entire React app that adds global functionality like
+ *   handling for fatal error messages
+ * @author Gabe Abrams
+ */
+import React from 'react';
+declare type Props = {
+    children: React.ReactNode;
+    dark?: boolean;
+    sessionExpiredMessage?: string;
+};
+/**
+ * Show an alert modal with an "Okay" button
+ * @author Gabe Abrams
+ * @param title the title text to display at the top of the alert
+ * @param text the text to display in the alert
+ */
+export declare const alert: (title: string, text: string) => Promise<undefined>;
+/**
+ * Show a confirmation modal with an "Okay" and a "Cancel" button
+ * @author Gabe Abrams
+ * @param title the title text to display at the top of the alert
+ * @param text the text to display in the alert
+ * @returns true if the user confirmed
+ */
+export declare const confirm: (title: string, text: string) => Promise<boolean>;
+/**
+ * Show a fatal error message
+ * @author Gabe Abrams
+ * @param error the error to show
+ * @param [errorTitle] title of the error box
+ */
+export declare const showFatalError: (error: any, errorTitle?: string) => undefined;
+/**
+ * Show the "session expired" message
+ * @author Gabe Abrams
+ */
+export declare const showSessionExpiredMessage: () => undefined;
+declare const AppWrapper: React.FC<Props>;
+export default AppWrapper;

package/{lib → dist/cjs/types}/components/LoadingSpinner.d.ts

@@ -2,5 +2,6 @@
  * Loading spinner/indicator
  * @author Gabe Abrams
  */
+/// <reference types="react" />
 declare const LoadingSpinner: () => JSX.Element;
 export default LoadingSpinner;

package/dist/cjs/types/components/Modal.d.ts

@@ -0,0 +1,40 @@
+/**
+ * A generic popup modal
+ * @author Gabe Abrams
+ */
+import React from 'react';
+import Variant from '../types/Variant';
+import ModalButtonType from '../types/ModalButtonType';
+import ModalSize from '../types/ModalSize';
+import ModalType from '../types/ModalType';
+declare type Props = {
+    type?: ModalType;
+    size?: ModalSize;
+    title?: React.ReactNode;
+    children?: React.ReactNode;
+    onClose?: (type: ModalButtonType) => void;
+    dontAllowBackdropExit?: boolean;
+    okayLabel?: string;
+    okayVariant?: Variant;
+    cancelLabel?: string;
+    cancelVariant?: Variant;
+    yesLabel?: string;
+    yesVariant?: Variant;
+    noLabel?: string;
+    noVariant?: Variant;
+    abandonLabel?: string;
+    abandonVariant?: Variant;
+    goBackLabel?: string;
+    goBackVariant?: Variant;
+    continueLabel?: string;
+    continueVariant?: Variant;
+    imSureLabel?: string;
+    imSureVariant?: Variant;
+    deleteLabel?: string;
+    deleteVariant?: Variant;
+    confirmLabel?: string;
+    confirmVariant?: Variant;
+    onTopOfOtherModals?: boolean;
+};
+declare const Modal: React.FC<Props>;
+export default Modal;

package/dist/cjs/types/components/TabBox.d.ts

@@ -0,0 +1,11 @@
+/**
+ * A box with a tab on the top that holds buttons and other content
+ * @author Gabe Abrams
+ */
+import React from 'react';
+declare type Props = {
+    title: React.ReactNode;
+    children: React.ReactNode;
+};
+declare const TabBox: React.FC<Props>;
+export default TabBox;

package/{lib → dist/cjs/types}/helpers/abbreviate.d.ts

@@ -7,3 +7,4 @@
  *   (including ellipses if applicable)
  */
 declare const abbreviate: (text: string, maxChars: number) => string;
+export default abbreviate;

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

@@ -0,0 +1,22 @@
+import AppWrapper, { alert, confirm, showFatalError } from './components/AppWrapper';
+import LoadingSpinner from './components/LoadingSpinner';
+import ErrorBox from './components/ErrorBox';
+import Modal from './components/Modal';
+import TabBox from './components/TabBox';
+import ErrorWithCode from './errors/ErrorWithCode';
+import abbreviate from './helpers/abbreviate';
+import avg from './helpers/avg';
+import ceilToNumDecimals from './helpers/ceilToNumDecimals';
+import floorToNumDecimals from './helpers/floorToNumDecimals';
+import forceNumIntoBounds from './helpers/forceNumIntoBounds';
+import padDecimalZeros from './helpers/padDecimalZeros';
+import padZerosLeft from './helpers/padZerosLeft';
+import roundToNumDecimals from './helpers/roundToNumDecimals';
+import sum from './helpers/sum';
+import waitMs from './helpers/waitMs';
+import ModalButtonType from './types/ModalButtonType';
+import ModalSize from './types/ModalSize';
+import ModalType from './types/ModalType';
+import ReactKitErrorCode from './types/ReactKitErrorCode';
+import Variant from './types/Variant';
+export { AppWrapper, LoadingSpinner, ErrorBox, Modal, TabBox, alert, confirm, showFatalError, ErrorWithCode, abbreviate, avg, ceilToNumDecimals, floorToNumDecimals, forceNumIntoBounds, padDecimalZeros, padZerosLeft, roundToNumDecimals, sum, waitMs, ModalButtonType, ModalSize, ModalType, ReactKitErrorCode, Variant, };

package/dist/cjs/types/types/ModalButtonType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Types of buttons in the modal
+ * @author Gabe Abrams
+ */
+declare enum ModalButtonType {
+    Okay = "okay",
+    Cancel = "cancel",
+    Yes = "yes",
+    No = "no",
+    Abandon = "abandon",
+    GoBack = "goBack",
+    Continue = "continue",
+    ImSure = "imSure",
+    Delete = "delete",
+    Confirm = "confirm"
+}
+export default ModalButtonType;

package/dist/cjs/types/types/ModalSize.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Modal sizes
+ * @author Gabe Abrams
+ */
+declare enum ModalSize {
+    Small = "sm",
+    Medium = "md",
+    Large = "lg",
+    ExtraLarge = "xl"
+}
+export default ModalSize;

package/dist/cjs/types/types/ModalType.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Types of modals
+ * @author Gabe Abrams
+ */
+declare enum ModalType {
+    Okay = "okay",
+    OkayCancel = "okay-cancel",
+    YesNo = "yes-no",
+    YesNoCancel = "yes-no-cancel",
+    AbandonGoBack = "abandon-goBack",
+    ImSureCancel = "imSure-cancel",
+    DeleteCancel = "delete-cancel",
+    ConfirmCancel = "confirm-cancel",
+    NoButtons = "-"
+}
+export default ModalType;