@alextheman/components 6.2.0 → 6.2.1

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import * as react_jsx_runtime2 from "react/jsx-runtime";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
 import { CollapseProps } from "@mui/material/Collapse";
 import { PaletteMode, SxProps, Theme } from "@mui/material/styles";
 import * as react0 from "react";
@@ -41,10 +41,10 @@ declare function CollapsableItem({
   openIcon,
   closedIcon,
   useDefaultStyling
-}: CollapsableItemProps): react_jsx_runtime2.JSX.Element;
+}: CollapsableItemProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/components/DarkModeToggle.d.ts
-declare function DarkModeToggle(): react_jsx_runtime2.JSX.Element;
+declare function DarkModeToggle(): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/components/DropdownMenu.d.ts
 interface DropdownMenuProps {
@@ -57,7 +57,18 @@ interface DropdownMenuProps {
   onOpen?: () => void;
   onClose?: () => void;
 }
-/** @deprecated This component does not support the new context-based pattern and individual DropdownMenuItem components. Please use DropdownMenu2 instead. */
+/**
+ * @param root0
+ * @param root0.children
+ * @param root0.button
+ * @param root0.buttonChildren
+ * @param root0.buttonProps
+ * @param root0.isOpenIcon
+ * @param root0.isClosedIcon
+ * @param root0.onOpen
+ * @param root0.onClose
+ * @deprecated This component does not support the new context-based pattern and individual DropdownMenuItem components. Please use DropdownMenu2 instead.
+ */
 declare function DropdownMenu({
   children,
   button: Button,
@@ -67,7 +78,7 @@ declare function DropdownMenu({
   isClosedIcon,
   onOpen,
   onClose
-}: DropdownMenuProps): react_jsx_runtime2.JSX.Element;
+}: DropdownMenuProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/components/ExternalLink.d.ts
 interface ExternalLinkProps extends Omit<LinkProps, "to" | "target" | "rel"> {
@@ -81,7 +92,7 @@ declare function ExternalLink({
   children,
   ref,
   ...linkProps
-}: ExternalLinkProps): react_jsx_runtime2.JSX.Element;
+}: ExternalLinkProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/components/FileInput.d.ts
 declare const FileType: {
@@ -110,7 +121,7 @@ declare function FileInput({
   accept,
   useDropzone,
   ...buttonProps
-}: FileInputProps): react_jsx_runtime2.JSX.Element;
+}: FileInputProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/components/FileInputList.d.ts
 interface FileInputListProps extends Omit<FileInputProps, "onFileInput"> {
@@ -121,7 +132,7 @@ declare function FileInputList({
   files,
   setFiles,
   ...fileInputProps
-}: FileInputListProps): react_jsx_runtime2.JSX.Element;
+}: FileInputListProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/components/IconWithPopover.d.ts
 interface IconWithPopoverProps {
@@ -139,7 +150,7 @@ declare function IconWithPopover({
   onClose,
   iconProps,
   children
-}: IconWithPopoverProps): react_jsx_runtime2.JSX.Element;
+}: IconWithPopoverProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/components/InternalLink.d.ts
 interface InternalLinkProps extends Omit<LinkProps, "href"> {
@@ -153,7 +164,7 @@ declare function InternalLink({
   children,
   ref,
   ...linkProps
-}: InternalLinkProps): react_jsx_runtime2.JSX.Element;
+}: InternalLinkProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/components/ListItemInternalLink.d.ts
 interface ListItemInternalLinkProps extends Omit<ListItemButtonProps, "href"> {
@@ -163,7 +174,7 @@ interface ListItemInternalLinkProps extends Omit<ListItemButtonProps, "href"> {
 declare function ListItemInternalLink({
   children,
   ...listItemButtonProps
-}: ListItemInternalLinkProps): react_jsx_runtime2.JSX.Element;
+}: ListItemInternalLinkProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/types/ContextHookOptions.d.ts
 interface ContextHookOptions<S extends boolean = true> {
@@ -193,7 +204,7 @@ declare function DropdownMenu2({
   buttonProps,
   openIcon,
   closedIcon
-}: DropdownMenu2Props): react_jsx_runtime2.JSX.Element;
+}: DropdownMenu2Props): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/providers/DropdownMenu2/DropdownMenuExternalLink.d.ts
 interface DropdownMenuExternalLinkProps extends MenuItemOwnProps {
@@ -208,7 +219,7 @@ declare function DropdownMenuExternalLink({
   children,
   onClick,
   ...menuItemProps
-}: DropdownMenuExternalLinkProps): react_jsx_runtime2.JSX.Element;
+}: DropdownMenuExternalLinkProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/providers/DropdownMenu2/DropdownMenuInternalLink.d.ts
 interface DropdownMenuInternalLinkProps extends MenuItemOwnProps {
@@ -223,7 +234,7 @@ declare function DropdownMenuInternalLink({
   children,
   onClick,
   ...menuItemProps
-}: DropdownMenuInternalLinkProps): react_jsx_runtime2.JSX.Element;
+}: DropdownMenuInternalLinkProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/providers/DropdownMenu2/DropdownMenuItem.d.ts
 type DropdownMenuItemProps<RootComponent extends ElementType = typeof Button$1> = {
@@ -238,25 +249,25 @@ declare function DropdownMenuItem<RootComponent extends ElementType>({
   ref,
   onClick,
   ...menuItemProps
-}: DropdownMenuItemProps<RootComponent>): react_jsx_runtime2.JSX.Element;
+}: DropdownMenuItemProps<RootComponent>): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/providers/LoaderProvider/LoaderProvider.d.ts
-interface LoaderProviderBaseProps<T> {
+interface LoaderProviderBaseProps<DataType> {
   /** The current loading status (true if loading, false if not) */
   isLoading: boolean;
   /** The data being loaded. */
-  data?: T;
+  data?: DataType;
   /** A parser for the data. */
-  dataParser?: (data: unknown) => NonNullable<T>;
+  dataParser?: (data: unknown) => NonNullable<DataType>;
   /** The component to show when the data is being fetched. */
   loadingComponent?: ReactNode;
 }
-interface LoaderProviderPropsWithNoError<T> extends LoaderProviderBaseProps<T> {
+interface LoaderProviderPropsWithNoError<DataType> extends LoaderProviderBaseProps<DataType> {
   error?: never;
   errorComponent?: never;
   logError?: never;
 }
-interface LoaderProviderPropsWithError<T> extends LoaderProviderBaseProps<T> {
+interface LoaderProviderPropsWithError<DataType> extends LoaderProviderBaseProps<DataType> {
   /** The error given if the request gave an error. */
   error: unknown;
   /** The component to show if an error has been thrown. Note that this may not be provided unless the error prop has also been provided. */
@@ -268,18 +279,28 @@ type LoaderContextValue<T> = LoaderProviderPropsWithNoError<T> | LoaderProviderP
 type LoaderProviderProps<T> = LoaderContextValue<T> & {
   children: ReactNode;
 };
-/** A provider for a context that deals with state management when fetching data from an API.
+/**
+ * A provider for a context that deals with state management when fetching data from an API.
  * This may be used over Loader if you require more control over the placement of the error message and data display.
+ * @template DataType - The type of data being loaded.
+ * @param root0 - Props to pass to LoaderProvider.
+ * @param root0.children - The components that may receive access to the LoaderContext value.
+ * @param root0.loadingComponent - The component to show when the data is being fetched.
+ * @param root0.isLoading - The current loading status (true if loading, false if not)
+ * @param root0.error - The error given if the request gave an error.
+ * @param root0.errorComponent - The component to show if an error has been thrown. Note that this may not be provided unless the error prop has also been provided.
+ * @param root0.logError - An option to log the error to the console. Note that this may not be provided unless the error prop has also been provided.
  */
-declare function LoaderProvider<T>({
+declare function LoaderProvider<DataType>({
   children,
   loadingComponent,
   ...contextProps
-}: LoaderProviderProps<T>): react_jsx_runtime2.JSX.Element;
+}: LoaderProviderProps<DataType>): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/providers/LoaderProvider/LoaderData.d.ts
 interface LoaderDataProps<T> {
-  /** The elements to show after data has been loaded.
+  /**
+   * The elements to show after data has been loaded.
    * This is best provided as a function with a data argument that guarantees the data will not be undefined by the time you receive it here.
    */
   children: ReactNode | ((data: NonNullable<T>) => ReactNode);
@@ -288,23 +309,26 @@ interface LoaderDataProps<T> {
   /** The component to show when the data is being fetched. */
   loadingComponent?: ReactNode;
 }
-/** The component responsible for showing the data provided by LoaderProvider. */
-declare function LoaderData<T>({
+/**
+ * The component responsible for showing the data provided by LoaderProvider.
+ * @template DataType - The type of data being loaded.
+ * @param root0 - Props to pass to LoaderData.
+ * @param root0.children - The elements to show after data has been loaded.
+ * This is best provided as a function with a data argument that guarantees the data will not be undefined by the time you receive it here.
+ * @param root0.dataParser - A parser for the data.
+ * @param root0.loadingComponent - The component to show when the data is being fetched.
+ */
+declare function LoaderData<DataType>({
   children,
   dataParser: loaderDataParser,
   loadingComponent
-}: LoaderDataProps<T>): react_jsx_runtime2.JSX.Element;
+}: LoaderDataProps<DataType>): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/providers/LoaderProvider/LoaderError.d.ts
 interface LoaderErrorBaseProps {
-  /**
-   * The component to show if an error has been thrown.
-   * @deprecated Please pass in the content to show on error as children instead.
-   */
-  errorComponent?: ReactNode | ((error: unknown) => ReactNode);
   /** The component to show if an error has been thrown. */
   children?: ReactNode | ((error: unknown) => ReactNode);
-  /** Whether you want to log the error to the console or not. */
+  /** An option to log the error to the console. */
   logError?: boolean;
 }
 interface LoaderErrorPropsWithUndefinedOrNull extends LoaderErrorBaseProps {
@@ -321,14 +345,22 @@ interface LoaderErrorPropsWithNullable extends LoaderErrorBaseProps {
   nullableComponent?: ReactNode;
 }
 type LoaderErrorProps = LoaderErrorPropsWithUndefinedOrNull | LoaderErrorPropsWithNullable;
-/** The component responsible for showing any errors provided by LoaderProvider. */
+/**
+ * The component responsible for showing any errors provided by LoaderProvider.
+ * @param root0 - The props to be passed to LoaderError.
+ * @param root0.children - The component to show if an error has been thrown.
+ * @param root0.undefinedComponent - The component to show if no error was thrown but the data is undefined.
+ * @param root0.nullComponent - The component to show if no error was thrown but the data is null.
+ * @param root0.nullableComponent - The component to show if no error was thrown but the data is nullable (undefined or null).
+ * @param root0.logError - An option to log the error to the console.
+ */
 declare function LoaderError({
   children,
   undefinedComponent,
   nullComponent,
   nullableComponent,
   logError: propsLogError
-}: LoaderErrorProps): string | number | bigint | boolean | react_jsx_runtime2.JSX.Element | Iterable<ReactNode> | Promise<string | number | bigint | boolean | react0.ReactPortal | react0.ReactElement<unknown, string | react0.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null | undefined;
+}: LoaderErrorProps): string | number | bigint | boolean | react_jsx_runtime0.JSX.Element | Iterable<ReactNode> | Promise<string | number | bigint | boolean | react0.ReactPortal | react0.ReactElement<unknown, string | react0.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null | undefined;
 //#endregion
 //#region src/providers/ModeProvider.d.ts
 interface ModeContextValue {
@@ -345,7 +377,7 @@ interface ModeProviderProps {
 declare function ModeProvider({
   children,
   mode: modeProp
-}: ModeProviderProps): react_jsx_runtime2.JSX.Element;
+}: ModeProviderProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/providers/ScreenSizeProvider.d.ts
 interface ScreenSizeProps {
@@ -365,7 +397,7 @@ declare function ScreenSizeProvider({
   children,
   largeScreenWidth,
   largeScreenHeight
-}: ScreenSizeProps): react_jsx_runtime2.JSX.Element;
+}: ScreenSizeProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/providers/SnackbarProvider.d.ts
 interface SnackbarProviderProps {
@@ -381,22 +413,33 @@ declare function useSnackbar<Strict extends boolean = true>({
 declare function SnackbarProvider({
   children,
   autoHideDuration
-}: SnackbarProviderProps): react_jsx_runtime2.JSX.Element;
+}: SnackbarProviderProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/components/Loader.d.ts
-type LoaderProps<T> = Omit<LoaderProviderProps<T>, "children"> & Omit<LoaderErrorProps, "errorComponent" | "children"> & Omit<LoaderDataProps<T>, "showOnError" | "onUndefined" | "onNull" | "onNullable">;
-/** An in-line component that deals with state management when fetching data from an API.
+type LoaderProps<DataType> = Omit<LoaderProviderProps<DataType>, "children" | "logError"> & Omit<LoaderErrorProps, "errorComponent" | "children"> & Omit<LoaderDataProps<DataType>, "showOnError" | "onUndefined" | "onNull" | "onNullable">;
+/**
+ * An in-line component that deals with state management when fetching data from an API.
  * This may be used over LoaderProvider if you don't require as much control over the placement of the error message and data display.
+ * @template DataType - The type of data being loaded.
+ * @param root0 - Props to pass to Loader.
+ * @param root0.children - The elements to show after data has been loaded.
+ * @param root0.errorComponent - The component to show if an error has been thrown. Note that this may not be provided unless the error prop has also been provided.
+ * @param root0.undefinedComponent - The component to show if no error was thrown but the data is undefined.
+ * @param root0.nullComponent - The component to show if no error was thrown but the data is null.
+ * @param root0.nullableComponent - The component to show if no error was thrown but the data is nullable (undefined or null).
+ * @param root0.loadingComponent - The component to show when the data is being fetched.
+ * @param root0.logError - An option to log the error to the console.
  */
-declare function Loader<T>({
+declare function Loader<DataType>({
   children,
   errorComponent,
   undefinedComponent,
   nullComponent,
   nullableComponent,
+  logError,
   loadingComponent,
   ...loaderProviderProps
-}: LoaderProps<T>): react_jsx_runtime2.JSX.Element;
+}: LoaderProps<DataType>): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/components/NavigationBottom.d.ts
 interface NavItemBottom {
@@ -412,7 +455,7 @@ interface NavigationBottomProps {
 declare function NavigationBottom({
   children,
   navItems
-}: NavigationBottomProps): react_jsx_runtime2.JSX.Element;
+}: NavigationBottomProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/components/NavigationDrawer.d.ts
 interface NavMenuItem {
@@ -434,7 +477,7 @@ declare function NavigationDrawer({
   navItems,
   children,
   headerElements
-}: NavigationDrawerProps): react_jsx_runtime2.JSX.Element;
+}: NavigationDrawerProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/components/PopoverText.d.ts
 interface PopoverTextProps extends TypographyProps {
@@ -444,7 +487,7 @@ declare function PopoverText({
   text,
   sx,
   ...typographyProps
-}: PopoverTextProps): react_jsx_runtime2.JSX.Element;
+}: PopoverTextProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/components/ReactPlayground.d.ts
 interface ReactPlaygroundProps extends ComponentProps<typeof LiveProvider> {
@@ -454,7 +497,7 @@ declare function ReactPlayground({
   code,
   previewStyles,
   ...liveProviderProps
-}: ReactPlaygroundProps): react_jsx_runtime2.JSX.Element;
+}: ReactPlaygroundProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/components/SkeletonRow.d.ts
 interface SkeletonRowProps {
@@ -462,7 +505,7 @@ interface SkeletonRowProps {
 }
 declare function SkeletonRow({
   columns
-}: SkeletonRowProps): react_jsx_runtime2.JSX.Element;
+}: SkeletonRowProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/components/SubmitButton.d.ts
 interface SubmitButtonProps extends Omit<ButtonProps, "type"> {
@@ -473,7 +516,7 @@ declare function SubmitButton({
   disableClean,
   label,
   ...buttonProps
-}: SubmitButtonProps): react_jsx_runtime2.JSX.Element;
+}: SubmitButtonProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/components/SwitchWithIcons.d.ts
 interface SwitchWithIconsProps extends Omit<SwitchProps, "icon" | "checkedIcon"> {
@@ -492,7 +535,7 @@ declare function SwitchWithIcons({
   uncheckedIcon: UncheckedIcon,
   uncheckedIconStyles,
   ...switchProps
-}: SwitchWithIconsProps): react_jsx_runtime2.JSX.Element;
+}: SwitchWithIconsProps): react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/hooks/useHash.d.ts
 declare function useHash<S extends string>(initialHash: S | undefined): [S, Dispatch<SetStateAction<S>>];