@alextheman/components 6.13.1 → 6.14.0

package/dist/index.d.cts

@@ -139,14 +139,81 @@ declare function FileInputList({
   ...fileInputProps
 }: FileInputListProps): _$react_jsx_runtime0.JSX.Element;
 //#endregion
+//#region src/components/ModeToggle.d.ts
+/** A toggle to switch between dark mode and light mode. Must be used in a `ModeProvider`. */
+declare function ModeToggle(): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/components/NavigationBottom.d.ts
+interface NavItemBottom {
+  /** The value associated with the nav item. */
+  value: string;
+  /** The label to display on the nav item. */
+  label: string;
+  /** An icon to display alongside the nav item. */
+  icon?: JSX.Element;
+  /** Where in your app the nav item should navigate to. */
+  to: string;
+}
+interface NavigationBottomProps {
+  /** Children to display above the nav bar. */
+  children: ReactNode;
+  /** An array of nav items to show. */
+  navItems: Array<NavItemBottom>;
+}
+/** Renders a navigation bar at the bottom of the screen. Especially helpful for common navigation options in a mobile app. */
+declare function NavigationBottom({
+  children,
+  navItems
+}: NavigationBottomProps): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+//#region src/components/Page.d.ts
+interface PageProps {
+  /** The Page title to show */
+  title: string;
+  /** The subtitle to show under the Page title */
+  subtitle?: string;
+  /** The actions to show in the page header */
+  action?: ReactNode;
+  /** The actual page contents */
+  children: ReactNode;
+}
+/** Renders a pre-styled Page that can be used to structure pages throughout your React apps. */
+declare function Page({
+  title,
+  subtitle,
+  action,
+  children
+}: 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/LoaderProvider/LoaderProvider.d.ts
-interface LoaderProviderBaseProps<DataType> {
+//#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. */
@@ -156,12 +223,12 @@ interface LoaderProviderBaseProps<DataType> {
   /** The component to show when the data is being fetched. */
   loadingComponent?: ReactNode;
 }
-interface LoaderProviderPropsWithNoError<DataType> extends LoaderProviderBaseProps<DataType> {
+interface QueryBoundaryProviderPropsWithNoError<DataType> extends QueryBoundaryProviderBaseProps<DataType> {
   error?: never;
   errorComponent?: never;
   logError?: never;
 }
-interface LoaderProviderPropsWithError<DataType> extends LoaderProviderBaseProps<DataType> {
+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. */
@@ -169,24 +236,24 @@ interface LoaderProviderPropsWithError<DataType> extends LoaderProviderBaseProps
   /** Whether you want to log the error to the console or not. */
   logError?: boolean;
 }
-type LoaderContextValue<T> = LoaderProviderPropsWithNoError<T> | LoaderProviderPropsWithError<T>;
-type LoaderProviderProps<T> = LoaderContextValue<T> & {
+type QueryBoundaryContextValue<DataType> = QueryBoundaryProviderPropsWithNoError<DataType> | QueryBoundaryProviderPropsWithError<DataType>;
+type QueryBoundaryProviderProps<DataType> = QueryBoundaryContextValue<DataType> & {
   children: ReactNode;
 };
 /**
  * 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.
+ * 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 LoaderProvider<DataType>({
+declare function QueryBoundaryProvider<DataType>({
   children,
   loadingComponent,
   ...contextProps
-}: LoaderProviderProps<DataType>): _$react_jsx_runtime0.JSX.Element;
+}: QueryBoundaryProviderProps<DataType>): _$react_jsx_runtime0.JSX.Element;
 //#endregion
-//#region src/providers/LoaderProvider/LoaderData.d.ts
-interface LoaderDataProps<T> {
+//#region src/providers/QueryBoundaryProvider/QueryBoundaryData.d.ts
+interface QueryBoundaryDataProps<T> {
   /**
    * 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.
@@ -198,68 +265,47 @@ interface LoaderDataProps<T> {
   loadingComponent?: ReactNode;
 }
 /**
- * The component responsible for showing the data provided by LoaderProvider.
+ * The component responsible for showing the data provided by QueryBoundaryProvider.
  *
  * @template DataType - The type of data being loaded.
  */
-declare function LoaderData<DataType>({
+declare function QueryBoundaryData<DataType>({
   children,
   dataParser: loaderDataParser,
   loadingComponent
-}: LoaderDataProps<DataType>): _$react_jsx_runtime0.JSX.Element;
+}: QueryBoundaryDataProps<DataType>): _$react_jsx_runtime0.JSX.Element;
 //#endregion
-//#region src/providers/LoaderProvider/LoaderError.d.ts
-interface LoaderErrorBaseProps {
+//#region src/providers/QueryBoundaryProvider/QueryBoundaryError.d.ts
+interface QueryBoundaryErrorBaseProps {
   /** The component to show if an error has been thrown. */
   children?: ReactNode | ((error: unknown) => ReactNode);
   /** An option to log the error to the console. */
   logError?: boolean;
 }
-interface LoaderErrorPropsWithUndefinedOrNull extends LoaderErrorBaseProps {
+interface QueryBoundaryErrorPropsWithUndefinedOrNull extends QueryBoundaryErrorBaseProps {
   /** The component to show if no error was thrown but data is undefined */
   undefinedComponent?: ReactNode;
   /** The component to show if no error was thrown but data is null */
   nullComponent?: ReactNode;
   nullableComponent?: never;
 }
-interface LoaderErrorPropsWithNullable extends LoaderErrorBaseProps {
+interface QueryBoundaryErrorPropsWithNullable extends QueryBoundaryErrorBaseProps {
   undefinedComponent?: never;
   nullComponent?: never;
   /** The component to show if no error was thrown but data is undefined or null */
   nullableComponent?: ReactNode;
 }
-type LoaderErrorProps = LoaderErrorPropsWithUndefinedOrNull | LoaderErrorPropsWithNullable;
+type QueryBoundaryErrorProps = QueryBoundaryErrorPropsWithUndefinedOrNull | QueryBoundaryErrorPropsWithNullable;
 /**
- * The component responsible for showing any errors provided by LoaderProvider.
+ * The component responsible for showing any errors provided by QueryBoundaryProvider.
  */
-declare function LoaderError({
+declare function QueryBoundaryError({
   children,
   undefinedComponent,
   nullComponent,
   nullableComponent,
   logError: propsLogError
-}: LoaderErrorProps): 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/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;
+}: 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/ScreenSizeProvider.d.ts
 interface ScreenSizeProps {
@@ -310,15 +356,15 @@ declare function SnackbarProvider({
   autoHideDuration
 }: SnackbarProviderProps): _$react_jsx_runtime0.JSX.Element;
 //#endregion
-//#region src/components/Loader.d.ts
-type LoaderProps<DataType> = Omit<LoaderProviderProps<DataType>, "children" | "logError"> & Omit<LoaderErrorProps, "errorComponent" | "children"> & Omit<LoaderDataProps<DataType>, "showOnError" | "onUndefined" | "onNull" | "onNullable">;
+//#region src/components/QueryBoundary.d.ts
+type QueryBoundaryProps<DataType> = Omit<QueryBoundaryProviderProps<DataType>, "children" | "logError"> & Omit<QueryBoundaryErrorProps, "errorComponent" | "children"> & Omit<QueryBoundaryDataProps<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.
+ * This may be used over QueryBoundaryProvider 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.
  */
-declare function Loader<DataType>({
+declare function QueryBoundary<DataType>({
   children,
   errorComponent,
   undefinedComponent,
@@ -327,53 +373,7 @@ declare function Loader<DataType>({
   logError,
   loadingComponent,
   ...loaderProviderProps
-}: LoaderProps<DataType>): _$react_jsx_runtime0.JSX.Element;
-//#endregion
-//#region src/components/ModeToggle.d.ts
-/** A toggle to switch between dark mode and light mode. Must be used in a `ModeProvider`. */
-declare function ModeToggle(): _$react_jsx_runtime0.JSX.Element;
-//#endregion
-//#region src/components/NavigationBottom.d.ts
-interface NavItemBottom {
-  /** The value associated with the nav item. */
-  value: string;
-  /** The label to display on the nav item. */
-  label: string;
-  /** An icon to display alongside the nav item. */
-  icon?: JSX.Element;
-  /** Where in your app the nav item should navigate to. */
-  to: string;
-}
-interface NavigationBottomProps {
-  /** Children to display above the nav bar. */
-  children: ReactNode;
-  /** An array of nav items to show. */
-  navItems: Array<NavItemBottom>;
-}
-/** Renders a navigation bar at the bottom of the screen. Especially helpful for common navigation options in a mobile app. */
-declare function NavigationBottom({
-  children,
-  navItems
-}: NavigationBottomProps): _$react_jsx_runtime0.JSX.Element;
-//#endregion
-//#region src/components/Page.d.ts
-interface PageProps {
-  /** The Page title to show */
-  title: string;
-  /** The subtitle to show under the Page title */
-  subtitle?: string;
-  /** The actions to show in the page header */
-  action?: ReactNode;
-  /** The actual page contents */
-  children: ReactNode;
-}
-/** Renders a pre-styled Page that can be used to structure pages throughout your React apps. */
-declare function Page({
-  title,
-  subtitle,
-  action,
-  children
-}: PageProps): _$react_jsx_runtime0.JSX.Element;
+}: QueryBoundaryProps<DataType>): _$react_jsx_runtime0.JSX.Element;
 //#endregion
 //#region src/components/ReactPlayground.d.ts
 interface ReactPlaygroundProps extends ComponentProps<typeof LiveProvider> {
@@ -630,6 +630,38 @@ declare function ListItemInternalLink({
   ...listItemButtonProps
 }: ListItemInternalLinkProps): _$react_jsx_runtime0.JSX.Element;
 //#endregion
+//#region src/deprecated/LoaderData.d.ts
+/** @deprecated This type has been renamed to QueryBoundaryDataProps. */
+type LoaderDataProps<DataType> = QueryBoundaryDataProps<DataType>;
+/** @deprecated This component has been renamed to QueryBoundaryData. */
+declare const LoaderData: typeof QueryBoundaryData;
+//#endregion
+//#region src/deprecated/LoaderError.d.ts
+/** @deprecated This type has been renamed to QueryBoundaryErrorBaseProps. */
+type LoaderErrorBaseProps = QueryBoundaryErrorBaseProps;
+/** @deprecated This type has been renamed to QueryBoundaryErrorPropsWithUndefinedOrNull. */
+type LoaderErrorPropsWithUndefinedOrNull = QueryBoundaryErrorPropsWithUndefinedOrNull;
+/** @deprecated This type has been renamed to QueryBoundaryErrorPropsWithNullable. */
+type LoaderErrorPropsWithNullable = QueryBoundaryErrorPropsWithNullable;
+/** @deprecated This type has been renamed to QueryBoundaryErrorProps. */
+type LoaderErrorProps = QueryBoundaryErrorProps;
+/** @deprecated This component has been renamed to LoaderError. */
+declare const LoaderError: typeof QueryBoundaryError;
+//#endregion
+//#region src/deprecated/LoaderProvider.d.ts
+/** @deprecated This type has been renamed to QueryBoundaryProviderBaseProps. */
+type LoaderProviderBaseProps<DataType> = QueryBoundaryProviderBaseProps<DataType>;
+/** @deprecated This type has been renamed to QueryBoundaryProviderPropsWithNoError. */
+type LoaderProviderPropsWithNoError<DataType> = QueryBoundaryProviderPropsWithNoError<DataType>;
+/** @deprecated This type has been renamed to QueryBoundaryProviderPropsWithError. */
+type LoaderProviderPropsWithError<DataType> = QueryBoundaryProviderPropsWithError<DataType>;
+/** @deprecated This type has been renamed to QueryBoundaryContextValue. */
+type LoaderContextValue<DataType> = QueryBoundaryContextValue<DataType>;
+/** @deprecated This type has been renamed to QueryBoundaryProviderProps. */
+type LoaderProviderProps<DataType> = QueryBoundaryProviderProps<DataType>;
+/** @deprecated This component has been renamed to QueryBoundaryProvider */
+declare const LoaderProvider: typeof QueryBoundaryProvider;
+//#endregion
 //#region src/deprecated/NavigationDrawer.d.ts
 interface NavMenuItemOptions {
   /** The label to display on the nav item option. */
@@ -710,5 +742,5 @@ declare function SubmitButton({
  */
 declare function useHash<StateType extends string>(initialHash: StateType | undefined): [StateType, Dispatch<SetStateAction<StateType>>];
 //#endregion
-export { Artwork, CollapsableItem, type CollapsableItemProps, ContextHookOptions, DarkModeToggle, 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, LoaderData, type LoaderDataProps, LoaderError, type LoaderErrorBaseProps, type LoaderErrorProps, type LoaderErrorPropsWithNullable, type LoaderErrorPropsWithUndefinedOrNull, type LoaderProps, 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, ReactPlayground, type ReactPlaygroundProps, type ScreenSizeContextValue, type ScreenSizeProps, ScreenSizeProvider, SkeletonRow, type SkeletonRowProps, SnackbarProvider, type SnackbarProviderProps, SubmitButton, type SubmitButtonProps, SwitchWithIcons, type SwitchWithIconsProps, useDropdownMenu, useHash, useMode, useScreenSize, useSnackbar };
+export { Artwork, CollapsableItem, type CollapsableItemProps, ContextHookOptions, DarkModeToggle, 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, 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, QueryBoundary, QueryBoundaryData, type QueryBoundaryDataProps, QueryBoundaryError, type QueryBoundaryErrorBaseProps, type QueryBoundaryErrorProps, type QueryBoundaryErrorPropsWithNullable, type QueryBoundaryErrorPropsWithUndefinedOrNull, type QueryBoundaryProps, QueryBoundaryProvider, type QueryBoundaryProviderBaseProps, type QueryBoundaryProviderProps, type QueryBoundaryProviderPropsWithError, type QueryBoundaryProviderPropsWithNoError, ReactPlayground, type ReactPlaygroundProps, type ScreenSizeContextValue, type ScreenSizeProps, ScreenSizeProvider, SkeletonRow, type SkeletonRowProps, SnackbarProvider, type SnackbarProviderProps, SubmitButton, type SubmitButtonProps, SwitchWithIcons, type SwitchWithIconsProps, useDropdownMenu, useHash, useMode, useScreenSize, useSnackbar };
 //# sourceMappingURL=index.d.cts.map