@alextheman/components 6.23.1 → 6.24.0

package/dist/index.d.cts

@@ -6,7 +6,6 @@ import { CSSProperties, ComponentProps, ComponentPropsWithRef, ComponentPropsWit
 import { LinkProps } from "@mui/material/Link";
 import { CreateEnumType, OptionalOnCondition } from "@alextheman/utility";
 import Button$1, { ButtonOwnProps, ButtonProps } from "@mui/material/Button";
-import { AlertColor } from "@mui/material/Alert";
 import { LiveProvider } from "react-live";
 import { CommonProps, OverridableComponent } from "@mui/material/OverridableComponent";
 import { SwitchProps } from "@mui/material/Switch";
@@ -15,6 +14,7 @@ import { MenuItemOwnProps } from "@mui/material/MenuItem";
 import { SvgIconTypeMap } from "@mui/material/SvgIcon";
 import { ListItemButtonProps } from "@mui/material/ListItemButton";
 import { TypographyProps } from "@mui/material/Typography";
+import { AlertColor } from "@mui/material/Alert";
 
 //#region src/components/Artwork.d.ts
 /** The artwork associated with the package's theme song, _An Interface For You And I_. */
@@ -168,78 +168,7 @@ declare function Page({
   disablePadding
 }: PageProps): _$react_jsx_runtime0.JSX.Element;
 //#endregion
-//#region src/types/ContextHookOptions.d.ts
-interface ContextHookOptions<Strict extends boolean = true> {
-  /** Error if the context is missing if this is set to true. */
-  strict?: Strict;
-}
-//#endregion
-//#region src/providers/ModeProvider.d.ts
-interface ModeContextValue {
-  toggleMode: () => void;
-  mode: PaletteMode;
-}
-/** Access the mode context directly. */
-declare function useMode<Strict extends boolean = true>({
-  strict
-}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, ModeContextValue>;
-interface ModeProviderProps {
-  /** The children that will have access to the current mode. */
-  children: ReactNode;
-  /** The initial mode. */
-  mode?: PaletteMode;
-}
-/** Provides information about the current theme mode to its children components. */
-declare function ModeProvider({
-  children,
-  mode: modeProp
-}: ModeProviderProps): _$react_jsx_runtime0.JSX.Element;
-//#endregion
-//#region src/providers/QueryBoundaryProvider/QueryBoundaryProvider.d.ts
-interface QueryBoundaryProviderBaseProps<DataType> {
-  /** The current loading status (true if loading, false if not) */
-  isLoading?: boolean;
-  /** The data being loaded. */
-  data?: DataType | null | undefined;
-  /** A parser for the data. */
-  dataParser?: (data: unknown) => NonNullable<DataType>;
-  /** The component to show when the data is being fetched. */
-  loadingComponent?: ReactNode;
-}
-interface QueryBoundaryProviderPropsWithNoError<DataType> extends QueryBoundaryProviderBaseProps<DataType> {
-  error?: never;
-  errorComponent?: never;
-  logError?: never;
-}
-interface QueryBoundaryProviderPropsWithError<DataType> extends QueryBoundaryProviderBaseProps<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. */
-  errorComponent?: ReactNode | ((error: unknown) => ReactNode);
-  /** Whether you want to log the error to the console or not. */
-  logError?: boolean;
-}
-type QueryBoundaryContextValue<DataType> = QueryBoundaryProviderPropsWithNoError<DataType> | QueryBoundaryProviderPropsWithError<DataType>;
-type QueryBoundaryProviderProps<DataType> = QueryBoundaryContextValue<DataType> & {
-  children: ReactNode;
-};
-/** Access the QueryBoundary context directly. */
-declare function useQueryBoundary<DataType, Strict extends boolean = true>({
-  strict
-}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, QueryBoundaryContextValue<DataType>>;
-/**
- * A provider for a context that deals with state management when fetching data from an API.
- * This may be used over QueryBoundary if you require more control over the placement of the error message and data display.
- *
- * @template DataType - The type of data being loaded.
- */
-declare function QueryBoundaryProvider<DataType>({
-  children,
-  loadingComponent,
-  ...contextProps
-}: QueryBoundaryProviderProps<DataType>): _$react_jsx_runtime0.JSX.Element;
-//#endregion
-//#region src/providers/QueryBoundaryProvider/QueryBoundaryData.d.ts
+//#region src/groups/QueryBoundary/QueryBoundaryData.d.ts
 interface QueryBoundaryDataProps<DataType> {
   /**
    * The elements to show after data has been loaded.
@@ -262,7 +191,7 @@ declare function QueryBoundaryData<DataType>({
   loadingComponent
 }: QueryBoundaryDataProps<DataType>): _$react_jsx_runtime0.JSX.Element | null;
 //#endregion
-//#region src/providers/QueryBoundaryProvider/QueryBoundaryDataMap.d.ts
+//#region src/groups/QueryBoundary/QueryBoundaryDataMap.d.ts
 interface QueryBoundaryDataMapBaseProps<ItemType> {
   /**
    * The elements to show after data has been loaded.
@@ -317,7 +246,7 @@ declare function QueryBoundaryDataMap<ItemType>({
   strictlyRequireArray
 }: QueryBoundaryDataMapProps<ItemType>): _$react_jsx_runtime0.JSX.Element | null;
 //#endregion
-//#region src/providers/QueryBoundaryProvider/QueryBoundaryError.d.ts
+//#region src/groups/QueryBoundary/QueryBoundaryError.d.ts
 interface QueryBoundaryErrorProps {
   /** The component to show if an error has been thrown. */
   children?: ReactNode | ((error: unknown) => ReactNode);
@@ -332,7 +261,7 @@ declare function QueryBoundaryError({
   logError: propsLogError
 }: QueryBoundaryErrorProps): string | number | bigint | boolean | _$react_jsx_runtime0.JSX.Element | Iterable<ReactNode> | Promise<string | number | bigint | boolean | _$react.ReactPortal | _$react.ReactElement<unknown, string | _$react.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null | undefined;
 //#endregion
-//#region src/providers/QueryBoundaryProvider/QueryBoundaryNullable.d.ts
+//#region src/groups/QueryBoundary/QueryBoundaryNullable.d.ts
 interface QueryBoundaryNullablePropsWithUndefinedOrNull {
   /** The component to show if no error was thrown but data is undefined */
   undefinedComponent?: ReactNode;
@@ -354,7 +283,7 @@ declare function QueryBoundaryNullable({
   nullableComponent
 }: QueryBoundaryNullableProps): _$react_jsx_runtime0.JSX.Element | null;
 //#endregion
-//#region src/providers/QueryBoundaryProvider/QueryBoundaryFallback.d.ts
+//#region src/groups/QueryBoundary/QueryBoundaryFallback.d.ts
 type QueryBoundaryFallbackProps = Omit<QueryBoundaryErrorProps, "children"> & {
   /** The component to show if an error has been thrown. */errorComponent?: ReactNode | ((error: unknown) => ReactNode);
 } & QueryBoundaryNullableProps;
@@ -367,54 +296,95 @@ declare function QueryBoundaryFallback({
   ...queryBoundaryNullableProps
 }: QueryBoundaryFallbackProps): _$react_jsx_runtime0.JSX.Element;
 //#endregion
-//#region src/providers/ScreenSizeProvider.d.ts
-interface ScreenSizeProps {
-  /** The children that will be receiving the ScreenSizeContext. */
-  children: ReactNode;
-  /** The minimum screen width in pixels required to be considered a large screen. */
-  largeScreenWidth?: number;
-  /** The minimum screen height in pixels required to be considered a large screen. */
-  largeScreenHeight?: number;
+//#region src/groups/QueryBoundary/index.d.ts
+interface QueryBase {
+  /** The current loading status (true if loading, false if not) */
+  isLoading?: boolean;
+  /** The error given if the response gave an error. */
+  error?: unknown;
 }
-interface ScreenSizeContextValue {
-  /** Whether the screen is a large screen or not. */
-  isLargeScreen: boolean;
-  /** The current window width. */
-  windowWidth: number;
-  /** The current window height. */
-  windowHeight: number;
+interface QuerySingle<DataType> extends QueryBase {
+  /** The data being loaded. */
+  data: DataType | null | undefined;
+  dataCollection?: never;
 }
-/** Access the screen size context directly. */
-declare function useScreenSize<Strict extends boolean = true>({
-  strict
-}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, ScreenSizeContextValue>;
-/** Provides context about the current screen size. */
-declare function ScreenSizeProvider({
-  children,
-  largeScreenWidth,
-  largeScreenHeight
-}: ScreenSizeProps): _$react_jsx_runtime0.JSX.Element;
+interface QueryMultiple<ItemType> extends QueryBase {
+  /** An array of data items being loaded. */
+  dataCollection: Array<ItemType> | null | undefined;
+  data?: never;
+}
+type Query<DataType> = QuerySingle<DataType> | QueryMultiple<DataType>;
+interface CreateQueryBoundaryParameters<DataType> {
+  query: Query<DataType>;
+}
+interface DefaultQueryBoundaryComponents<DataType> {
+  Context: (props: {
+    children: ReactNode;
+  }) => JSX.Element;
+  Error: typeof QueryBoundaryError;
+  Data: typeof QueryBoundaryData<DataType>;
+  DataMap: typeof QueryBoundaryDataMap<DataType>;
+  Fallback: typeof QueryBoundaryFallback;
+  Nullable: typeof QueryBoundaryNullable;
+}
+/**
+ * A creator function to create a system of QueryBoundary components with the data fully typed throughout.
+ *
+ * @deprecated Please use either `createBaseQueryBoundary`, `createItemQueryBoundary`, or `createListQueryBoundary` from `@alextheman/components/v7` instead.
+ */
+declare function createQueryBoundary<DataType>({
+  query
+}: CreateQueryBoundaryParameters<DataType>): DefaultQueryBoundaryComponents<DataType>;
 //#endregion
-//#region src/providers/SnackbarProvider.d.ts
-interface SnackbarProviderProps {
-  /** The children that will have access to the snackbar context. */
-  children: ReactNode;
-  /** The amount of seconds to wait before hiding the snackbar. */
-  autoHideDuration?: number;
+//#region src/types/ContextHookOptions.d.ts
+interface ContextHookOptions<Strict extends boolean = true> {
+  /** Error if the context is missing if this is set to true. */
+  strict?: Strict;
 }
-interface SnackbarContextValue {
-  /** A function that adds the snackbar to the page. */
-  addSnackbar: (message: string, severity?: AlertColor, duration?: number) => void;
+//#endregion
+//#region src/groups/QueryBoundary/QueryBoundaryProvider.d.ts
+interface QueryBoundaryProviderBaseProps<DataType> {
+  /** The current loading status (true if loading, false if not) */
+  isLoading?: boolean;
+  /** The data being loaded. */
+  data?: DataType | null | undefined;
+  /** A parser for the data. */
+  dataParser?: (data: unknown) => NonNullable<DataType>;
+  /** The component to show when the data is being fetched. */
+  loadingComponent?: ReactNode;
 }
-/** Access the snackbar context directly. */
-declare function useSnackbar<Strict extends boolean = true>({
+interface QueryBoundaryProviderPropsWithNoError<DataType> extends QueryBoundaryProviderBaseProps<DataType> {
+  error?: never;
+  errorComponent?: never;
+  logError?: never;
+}
+interface QueryBoundaryProviderPropsWithError<DataType> extends QueryBoundaryProviderBaseProps<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. */
+  errorComponent?: ReactNode | ((error: unknown) => ReactNode);
+  /** Whether you want to log the error to the console or not. */
+  logError?: boolean;
+}
+type QueryBoundaryContextValue<DataType> = QueryBoundaryProviderPropsWithNoError<DataType> | QueryBoundaryProviderPropsWithError<DataType>;
+type QueryBoundaryProviderProps<DataType> = QueryBoundaryContextValue<DataType> & {
+  children: ReactNode;
+};
+/** Access the QueryBoundary context directly. */
+declare function useQueryBoundary<DataType, Strict extends boolean = true>({
   strict
-}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, SnackbarContextValue>;
-/** Controls the display of the snackbars on the page. */
-declare function SnackbarProvider({
+}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, QueryBoundaryContextValue<DataType>>;
+/**
+ * A provider for a context that deals with state management when fetching data from an API.
+ * This may be used over QueryBoundary if you require more control over the placement of the error message and data display.
+ *
+ * @template DataType - The type of data being loaded.
+ */
+declare function QueryBoundaryProvider<DataType>({
   children,
-  autoHideDuration
-}: SnackbarProviderProps): _$react_jsx_runtime0.JSX.Element;
+  loadingComponent,
+  ...contextProps
+}: QueryBoundaryProviderProps<DataType>): _$react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/components/QueryBoundaryMap.d.ts
 type QueryBoundaryMapProps<ItemType> = Omit<QueryBoundaryProviderProps<Array<ItemType>>, "children" | "logError"> & Omit<QueryBoundaryFallbackProps, "errorComponent"> & QueryBoundaryDataMapProps<ItemType>;
@@ -855,42 +825,6 @@ declare function SubmitButton({
   ...buttonProps
 }: SubmitButtonProps): _$react_jsx_runtime0.JSX.Element;
 //#endregion
-//#region src/hooks/createQueryBoundary.d.ts
-interface QueryBase {
-  /** The current loading status (true if loading, false if not) */
-  isLoading?: boolean;
-  /** The error given if the response gave an error. */
-  error?: unknown;
-}
-interface QuerySingle<DataType> extends QueryBase {
-  /** The data being loaded. */
-  data: DataType | null | undefined;
-  dataCollection?: never;
-}
-interface QueryMultiple<ItemType> extends QueryBase {
-  /** An array of data items being loaded. */
-  dataCollection: Array<ItemType> | null | undefined;
-  data?: never;
-}
-type Query<DataType> = QuerySingle<DataType> | QueryMultiple<DataType>;
-interface CreateQueryBoundaryParameters<DataType> {
-  query: Query<DataType>;
-}
-interface DefaultQueryBoundaryComponents<DataType> {
-  Context: (props: {
-    children: ReactNode;
-  }) => JSX.Element;
-  Error: typeof QueryBoundaryError;
-  Data: typeof QueryBoundaryData<DataType>;
-  DataMap: typeof QueryBoundaryDataMap<DataType>;
-  Fallback: typeof QueryBoundaryFallback;
-  Nullable: typeof QueryBoundaryNullable;
-}
-/** A creator function to create a system of QueryBoundary components with the data fully typed throughout. */
-declare function createQueryBoundary<DataType>({
-  query
-}: CreateQueryBoundaryParameters<DataType>): DefaultQueryBoundaryComponents<DataType>;
-//#endregion
 //#region src/hooks/useDebounce.d.ts
 /**
  * Assign a variable a given value after a given amount of milliseconds.
@@ -916,5 +850,75 @@ declare function useDebounce<ValueType>(value: ValueType, delay?: number): Value
  */
 declare function useHash<StateType extends string>(initialHash: StateType | undefined): [StateType, Dispatch<SetStateAction<StateType>>];
 //#endregion
-export { Artwork, CollapsableItem, type CollapsableItemProps, ContextHookOptions, type CreateQueryBoundaryParameters, DarkModeToggle, type DefaultQueryBoundaryComponents, DropdownMenu, DropdownMenu2, type DropdownMenu2Props, DropdownMenuExternalLink, DropdownMenuInternalLink, DropdownMenuItem, type DropdownMenuItemProps, type DropdownMenuProps, ExternalLink, type ExternalLinkProps, FileInput, FileInputList, type FileInputListProps, type FileInputProps, FileType, IconWithPopover, type IconWithPopoverProps, InternalLink, type InternalLinkProps, ListItemInternalLink, Loader, type LoaderContextValue, LoaderData, type LoaderDataProps, LoaderError, type LoaderErrorBaseProps, type LoaderErrorProps, type LoaderErrorPropsWithNullable, type LoaderErrorPropsWithUndefinedOrNull, LoaderProvider, type LoaderProviderBaseProps, type LoaderProviderProps, type LoaderProviderPropsWithError, type LoaderProviderPropsWithNoError, ModeProvider, type ModeProviderProps, ModeToggle, type NavItemBottom, type NavMenuItem, NavigationBottom, type NavigationBottomProps, NavigationDrawer, type NavigationDrawerProps, Page, PopoverText, type PopoverTextProps, type Query, type QueryBase, QueryBoundary, QueryBoundaryData, QueryBoundaryDataMap, type QueryBoundaryDataMapBaseProps, type QueryBoundaryDataMapProps, type QueryBoundaryDataMapPropsWithDataParser, type QueryBoundaryDataMapPropsWithItemParser, type QueryBoundaryDataMapPropsWithNoParser, type QueryBoundaryDataProps, QueryBoundaryError, type QueryBoundaryErrorProps, QueryBoundaryFallback, type QueryBoundaryFallbackProps, QueryBoundaryMap, type QueryBoundaryMapProps, QueryBoundaryNullable, type QueryBoundaryNullableProps, type QueryBoundaryNullablePropsWithNullable, type QueryBoundaryNullablePropsWithUndefinedOrNull, type QueryBoundaryProps, QueryBoundaryProvider, type QueryBoundaryProviderBaseProps, type QueryBoundaryProviderProps, type QueryBoundaryProviderPropsWithError, type QueryBoundaryProviderPropsWithNoError, QueryBoundaryWrapper, type QueryBoundaryWrapperProps, type QueryMultiple, type QuerySingle, ReactPlayground, type ReactPlaygroundProps, type ScreenSizeContextValue, type ScreenSizeProps, ScreenSizeProvider, SkeletonRow, type SkeletonRowProps, SnackbarProvider, type SnackbarProviderProps, SubmitButton, type SubmitButtonProps, SwitchWithIcons, type SwitchWithIconsProps, createQueryBoundary, useDebounce, useDropdownMenu, useHash, useMode, useQueryBoundary, useScreenSize, useSnackbar };
+//#region src/providers/ModeProvider.d.ts
+interface ModeContextValue {
+  toggleMode: () => void;
+  mode: PaletteMode;
+}
+/** Access the mode context directly. */
+declare function useMode<Strict extends boolean = true>({
+  strict
+}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, ModeContextValue>;
+interface ModeProviderProps {
+  /** The children that will have access to the current mode. */
+  children: ReactNode;
+  /** The initial mode. */
+  mode?: PaletteMode;
+}
+/** Provides information about the current theme mode to its children components. */
+declare function ModeProvider({
+  children,
+  mode: modeProp
+}: ModeProviderProps): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/providers/ScreenSizeProvider.d.ts
+interface ScreenSizeProps {
+  /** The children that will be receiving the ScreenSizeContext. */
+  children: ReactNode;
+  /** The minimum screen width in pixels required to be considered a large screen. */
+  largeScreenWidth?: number;
+  /** The minimum screen height in pixels required to be considered a large screen. */
+  largeScreenHeight?: number;
+}
+interface ScreenSizeContextValue {
+  /** Whether the screen is a large screen or not. */
+  isLargeScreen: boolean;
+  /** The current window width. */
+  windowWidth: number;
+  /** The current window height. */
+  windowHeight: number;
+}
+/** Access the screen size context directly. */
+declare function useScreenSize<Strict extends boolean = true>({
+  strict
+}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, ScreenSizeContextValue>;
+/** Provides context about the current screen size. */
+declare function ScreenSizeProvider({
+  children,
+  largeScreenWidth,
+  largeScreenHeight
+}: ScreenSizeProps): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/providers/SnackbarProvider.d.ts
+interface SnackbarProviderProps {
+  /** The children that will have access to the snackbar context. */
+  children: ReactNode;
+  /** The amount of seconds to wait before hiding the snackbar. */
+  autoHideDuration?: number;
+}
+interface SnackbarContextValue {
+  /** A function that adds the snackbar to the page. */
+  addSnackbar: (message: string, severity?: AlertColor, duration?: number) => void;
+}
+/** Access the snackbar context directly. */
+declare function useSnackbar<Strict extends boolean = true>({
+  strict
+}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, SnackbarContextValue>;
+/** Controls the display of the snackbars on the page. */
+declare function SnackbarProvider({
+  children,
+  autoHideDuration
+}: SnackbarProviderProps): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+export { Artwork, CollapsableItem, type CollapsableItemProps, ContextHookOptions, type CreateQueryBoundaryParameters, DarkModeToggle, type DefaultQueryBoundaryComponents, DropdownMenu, DropdownMenu2, type DropdownMenu2Props, DropdownMenuExternalLink, DropdownMenuInternalLink, DropdownMenuItem, type DropdownMenuItemProps, type DropdownMenuProps, ExternalLink, type ExternalLinkProps, FileInput, FileInputList, type FileInputListProps, type FileInputProps, FileType, IconWithPopover, type IconWithPopoverProps, InternalLink, type InternalLinkProps, ListItemInternalLink, Loader, type LoaderContextValue, LoaderData, type LoaderDataProps, LoaderError, type LoaderErrorBaseProps, type LoaderErrorProps, type LoaderErrorPropsWithNullable, type LoaderErrorPropsWithUndefinedOrNull, LoaderProvider, type LoaderProviderBaseProps, type LoaderProviderProps, type LoaderProviderPropsWithError, type LoaderProviderPropsWithNoError, ModeProvider, type ModeProviderProps, ModeToggle, type NavItemBottom, type NavMenuItem, NavigationBottom, type NavigationBottomProps, NavigationDrawer, type NavigationDrawerProps, Page, PopoverText, type PopoverTextProps, type QueryBase, QueryBoundary, QueryBoundaryData, QueryBoundaryDataMap, type QueryBoundaryDataMapBaseProps, type QueryBoundaryDataMapProps, type QueryBoundaryDataMapPropsWithDataParser, type QueryBoundaryDataMapPropsWithItemParser, type QueryBoundaryDataMapPropsWithNoParser, type QueryBoundaryDataProps, QueryBoundaryError, type QueryBoundaryErrorProps, QueryBoundaryFallback, type QueryBoundaryFallbackProps, QueryBoundaryMap, type QueryBoundaryMapProps, QueryBoundaryNullable, type QueryBoundaryNullableProps, type QueryBoundaryNullablePropsWithNullable, type QueryBoundaryNullablePropsWithUndefinedOrNull, type QueryBoundaryProps, QueryBoundaryProvider, type QueryBoundaryProviderBaseProps, type QueryBoundaryProviderProps, type QueryBoundaryProviderPropsWithError, type QueryBoundaryProviderPropsWithNoError, QueryBoundaryWrapper, type QueryBoundaryWrapperProps, type QueryMultiple, type QuerySingle, ReactPlayground, type ReactPlaygroundProps, type ScreenSizeContextValue, type ScreenSizeProps, ScreenSizeProvider, SkeletonRow, type SkeletonRowProps, SnackbarProvider, type SnackbarProviderProps, SubmitButton, type SubmitButtonProps, SwitchWithIcons, type SwitchWithIconsProps, createQueryBoundary, useDebounce, useDropdownMenu, useHash, useMode, useQueryBoundary, useScreenSize, useSnackbar };
 //# sourceMappingURL=index.d.cts.map