@alextheman/components 6.25.3 → 7.0.0

package/dist/index.d.cts

@@ -1,1010 +0,0 @@
-import { CollapseProps } from "@mui/material/Collapse";
-import { PaletteMode, SxProps, Theme } from "@mui/material/styles";
-import { CSSProperties, ComponentProps, ComponentPropsWithRef, ComponentPropsWithoutRef, ComponentType, Dispatch, ElementType, JSX, Key, MouseEventHandler, ReactNode, Ref, SetStateAction } from "react";
-import { LinkProps } from "@mui/material/Link";
-import { CreateEnumType, OptionalOnCondition } from "@alextheman/utility";
-import Button$1, { ButtonOwnProps, ButtonProps } from "@mui/material/Button";
-import { LiveProvider } from "react-live";
-import { CommonProps, OverridableComponent } from "@mui/material/OverridableComponent";
-import { SwitchProps } from "@mui/material/Switch";
-import { MenuProps } from "@mui/material/Menu";
-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_. */
-declare function Artwork(): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/components/CollapsableItem.d.ts
-interface CollapsableItemProps {
-  /** Whether the item should initially be open or not. */
-  isInitiallyOpen?: boolean;
-  /** A callback function to execute when the item is open. */
-  onOpen?: () => void;
-  /** A callback function to execute when the item is closed. */
-  onClose?: () => void;
-  /** The components to render when the item is open. */
-  children: ReactNode;
-  /** Styling for the button. */
-  buttonStyles?: SxProps;
-  /** The children to pass to the button. */
-  buttonContents: ReactNode;
-  /** The specific button component to use. */
-  buttonComponent?: ElementType;
-  /** The icon to show next to the button when open. */
-  openIcon?: ReactNode;
-  /** The icon to show next to the button when closed. */
-  closedIcon?: ReactNode;
-  /** Props to pass to collapse. */
-  collapseProps?: Omit<CollapseProps, "in">;
-  /**
-   * Whether or not to use the default button styling.
-   *
-   * Defaults to `true` if `buttonComponent` is `ButtonBase`,
-   * otherwise defaults to `false`.
-   */
-  useDefaultStyling?: boolean;
-}
-/**
- * Shows a display area that can be opened to show the children components, or hidden away.
- */
-declare function CollapsableItem({
-  isInitiallyOpen,
-  onOpen,
-  onClose,
-  children,
-  buttonStyles,
-  buttonContents,
-  buttonComponent: ButtonComponent,
-  collapseProps,
-  openIcon,
-  closedIcon,
-  useDefaultStyling
-}: CollapsableItemProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/components/ExternalLink.d.ts
-interface ExternalLinkProps extends Omit<LinkProps, "to" | "target" | "rel"> {
-  /** The URL of the place you want to navigate to. */
-  href: `https://${string}` | `http://${string}` | (string & {});
-  to?: never;
-  /** The readable content to display on the link. */
-  children: ReactNode;
-  /** An optional ref to allow it to be used with polymorphic components. */
-  ref?: Ref<HTMLAnchorElement>;
-}
-/**
- * A stylised link that is best used when you want to navigate to a different domain.
- *
- * Opens the destination in a new tab and applies recommended security defaults automatically.
- */
-declare function ExternalLink({
-  href,
-  children,
-  ref,
-  ...linkProps
-}: ExternalLinkProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/components/FileInput.d.ts
-declare const FileType: {
-  readonly PDF: "application/pdf";
-  readonly PNG: "image/png";
-  readonly JPEG: "image/jpeg";
-  readonly JPG: "image/jpg";
-  readonly XLSX: "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
-  readonly DOCX: "application/vnd.openxmlformats-officedocument.wordprocessingml.document";
-  readonly MP3: "audio/mp3";
-  readonly MP4: "video/mp4";
-  readonly WAV: "audio/wav";
-};
-type FileType = CreateEnumType<typeof FileType>;
-interface FileInputProps extends ButtonOwnProps {
-  /** A function to run when a file has been uploaded. */
-  onFileInput: (allowedFiles: Array<File>) => void;
-  /** The label to display on the input button (defaults to "Upload files") */
-  label?: string;
-  /** Whether to accept multiple files or not. */
-  multiple?: boolean;
-  /** An array of file types to accept. */
-  accept?: Array<string>;
-  /** Enable the dropzone, allowing users to drag and drop files. */
-  useDropzone?: boolean;
-}
-/** Handles file inputs. */
-declare function FileInput({
-  onFileInput,
-  label,
-  multiple,
-  accept,
-  useDropzone,
-  ...buttonProps
-}: FileInputProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/components/FileInputList.d.ts
-interface FileInputListProps extends Omit<FileInputProps, "onFileInput"> {
-  /** The array of files (must be a React state). */
-  files: Array<File>;
-  /** The state setter for the array of files. */
-  setFiles: Dispatch<SetStateAction<Array<File>>>;
-}
-/** Renders the `FileInput` component with a list of uploaded files underneath it. */
-declare function FileInputList({
-  files,
-  setFiles,
-  multiple,
-  ...fileInputProps
-}: FileInputListProps): import("react/jsx-runtime").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(): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/components/Page.d.ts
-interface PageProps {
-  /** The Page title to show */
-  title: ReactNode;
-  /** The subtitle to show under the Page title */
-  subtitle?: ReactNode;
-  /** The actions to show in the page header */
-  action?: ReactNode;
-  /** The actual page contents */
-  children: ReactNode;
-  /** Disable the inner padding of the Page contents. */
-  disablePadding?: boolean;
-  /** Optional tabs to display in the header. */
-  tabs?: ReactNode;
-}
-/** Renders a pre-styled Page that can be used to structure pages throughout your React apps. */
-declare function Page({
-  title,
-  subtitle,
-  action,
-  children,
-  tabs,
-  disablePadding
-}: PageProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/groups/QueryBoundary/QueryBoundaryData.d.ts
-interface QueryBoundaryDataProps<DataType> {
-  /**
-   * 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<DataType>) => ReactNode);
-  /** A parser for the data. */
-  dataParser?: (data: unknown) => NonNullable<DataType>;
-  /** The component to show when the data is being fetched. */
-  loadingComponent?: ReactNode;
-}
-/**
- * The component responsible for showing the data provided by QueryBoundaryProvider.
- *
- * @template DataType - The type of data being loaded.
- */
-declare function QueryBoundaryData<DataType>({
-  children,
-  dataParser: propDataParser,
-  loadingComponent
-}: QueryBoundaryDataProps<DataType>): import("react/jsx-runtime").JSX.Element | null;
-//#endregion
-//#region src/groups/QueryBoundary/QueryBoundaryDataMap.d.ts
-interface QueryBoundaryDataMapBaseProps<ItemType> {
-  /**
-   * 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: ItemType) => ReactNode);
-  /** The component to show when the data is being fetched. */
-  loadingComponent?: ReactNode;
-  /** The component to show if the array is empty. */
-  emptyComponent?: ReactNode;
-  /** Throw an error if the provided data is not an array. (defaults to `true`) */
-  strictlyRequireArray?: boolean;
-  /**
-   * A function that takes a data item and returns the key to be used for the item.
-   *
-   * If not provided, it will fall back to using the index.
-   */
-  itemKey?: (item: ItemType, index: number) => Key;
-}
-interface QueryBoundaryDataMapPropsWithItemParser<ItemType> extends QueryBoundaryDataMapBaseProps<ItemType> {
-  /** A parser for each data item. */
-  itemParser: (data: unknown) => ItemType;
-  dataParser?: never;
-}
-interface QueryBoundaryDataMapPropsWithDataParser<ItemType> extends QueryBoundaryDataMapBaseProps<ItemType> {
-  /** A parser for each data item. */
-  dataParser: (data: unknown) => Array<ItemType>;
-  itemParser?: never;
-}
-interface QueryBoundaryDataMapPropsWithNoParser<ItemType> extends QueryBoundaryDataMapBaseProps<ItemType> {
-  dataParser?: never;
-  itemParser?: never;
-}
-type QueryBoundaryDataMapProps<ItemType> = QueryBoundaryDataMapPropsWithItemParser<ItemType> | QueryBoundaryDataMapPropsWithDataParser<ItemType> | QueryBoundaryDataMapPropsWithNoParser<ItemType>;
-/**
- * The component responsible for handling an array of data provided by `QueryBoundaryProvider`.
- *
- * It will map through the data array, rendering the result of the children function in a fragment with a key of its index in the list, unless overridden by the `itemKey` prop.
- *
- * @template ItemType - The type of data being loaded.
- *
- * @throws {DataError} If the data provided by `QueryBoundaryProvider` is not an array, and the `strictlyRequireArray` prop is `true` (it is by default).
- */
-declare function QueryBoundaryDataMap<ItemType>({
-  children,
-  loadingComponent: propLoadingComponent,
-  itemKey,
-  itemParser,
-  dataParser: propDataParser,
-  emptyComponent,
-  strictlyRequireArray
-}: QueryBoundaryDataMapProps<ItemType>): import("react/jsx-runtime").JSX.Element | null;
-//#endregion
-//#region src/groups/QueryBoundary/QueryBoundaryError.d.ts
-interface QueryBoundaryErrorProps {
-  /** 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;
-}
-/**
- * The component responsible for showing any errors provided by QueryBoundaryProvider.
- */
-declare function QueryBoundaryError({
-  children,
-  logError: propsLogError
-}: QueryBoundaryErrorProps): string | number | bigint | boolean | import("react/jsx-runtime").JSX.Element | Iterable<ReactNode> | Promise<string | number | bigint | boolean | import("react").ReactPortal | import("react").ReactElement<unknown, string | import("react").JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null | undefined;
-//#endregion
-//#region src/groups/QueryBoundary/QueryBoundaryNullable.d.ts
-interface QueryBoundaryNullablePropsWithUndefinedOrNull {
-  /** 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 QueryBoundaryNullablePropsWithNullable {
-  undefinedComponent?: never;
-  nullComponent?: never;
-  /** The component to show if no error was thrown but data is undefined or null */
-  nullableComponent?: ReactNode;
-}
-type QueryBoundaryNullableProps = QueryBoundaryNullablePropsWithUndefinedOrNull | QueryBoundaryNullablePropsWithNullable;
-/** The component responsible for handling cases when the data provided by `QueryBoundaryProvider` may be missing. */
-declare function QueryBoundaryNullable({
-  undefinedComponent,
-  nullComponent,
-  nullableComponent
-}: QueryBoundaryNullableProps): import("react/jsx-runtime").JSX.Element | null;
-//#endregion
-//#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;
-/**
- * The component responsible for handling both errors and nullable data from `QueryBoundaryProvider`
- */
-declare function QueryBoundaryFallback({
-  errorComponent,
-  logError,
-  ...queryBoundaryNullableProps
-}: QueryBoundaryFallbackProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#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 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.
- *
- * @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/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/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;
-}
-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>): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/groups/QueryBoundary/creators/createBaseQueryBoundary.d.ts
-interface QueryBase$1<DataType> {
-  /** The current loading status (true if loading, false if not) */
-  isLoading?: boolean;
-  /** The error given if the response gave an error. */
-  error?: unknown;
-  /** The data being loaded. */
-  data: DataType;
-}
-interface CreateBaseQueryBoundaryParameters<DataType> {
-  query: QueryBase$1<DataType>;
-}
-interface DefaultQueryBoundaryComponentsBase {
-  Context: (props: {
-    children: ReactNode;
-  }) => JSX.Element;
-  Error: typeof QueryBoundaryError;
-  Fallback: typeof QueryBoundaryFallback;
-  Nullable: typeof QueryBoundaryNullable;
-}
-/** A creator function to create the base system of QueryBoundary components with the data fully typed throughout. */
-declare function createBaseQueryBoundary<DataType>({
-  query
-}: CreateBaseQueryBoundaryParameters<DataType>): DefaultQueryBoundaryComponentsBase;
-//#endregion
-//#region src/groups/QueryBoundary/creators/createItemQueryBoundary.d.ts
-interface QueryItem<DataType> extends Omit<QueryBase$1<DataType>, "data"> {
-  /** The data being loaded. */
-  data: DataType | null | undefined;
-}
-interface CreateItemQueryBoundaryParameters<DataType> {
-  query: QueryItem<DataType>;
-}
-interface DefaultQueryBoundaryItemComponents<DataType> extends DefaultQueryBoundaryComponentsBase {
-  Data: typeof QueryBoundaryData<DataType>;
-}
-/** A creator function to create the system of QueryBoundary components with the data treated as a single data item, fully typed throughout. */
-declare function createItemQueryBoundary<DataType>({
-  query
-}: CreateItemQueryBoundaryParameters<DataType>): DefaultQueryBoundaryItemComponents<DataType>;
-//#endregion
-//#region src/groups/QueryBoundary/creators/createListQueryBoundary.d.ts
-interface QueryList<DataType> extends Omit<QueryBase$1<DataType>, "data"> {
-  /** The data being loaded. */
-  data: Array<DataType> | null | undefined;
-}
-interface CreateListQueryBoundaryParameters<DataType> {
-  query: QueryList<DataType>;
-}
-interface DefaultQueryBoundaryListComponents<DataType> extends DefaultQueryBoundaryComponentsBase {
-  DataMap: typeof QueryBoundaryDataMap<DataType>;
-}
-/** A creator function to create the system of QueryBoundary components with the data treated as an array of data items, fully typed throughout. */
-declare function createListQueryBoundary<DataType>({
-  query
-}: CreateListQueryBoundaryParameters<DataType>): DefaultQueryBoundaryListComponents<DataType>;
-//#endregion
-//#region src/components/QueryBoundaryMap.d.ts
-type QueryBoundaryMapProps<ItemType> = Omit<QueryBoundaryProviderProps<Array<ItemType>>, "children" | "logError"> & Omit<QueryBoundaryFallbackProps, "errorComponent"> & QueryBoundaryDataMapProps<ItemType>;
-/**
- * An in-line component that handles an array of data provided by `QueryBoundaryProvider`.
- *
- * This may be used over QueryBoundaryProvider/QueryBoundaryDataMap 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 QueryBoundaryMap<ItemType>({
-  loadingComponent,
-  undefinedComponent,
-  nullComponent,
-  nullableComponent,
-  logError,
-  errorComponent,
-  children,
-  isLoading,
-  error,
-  data,
-  dataParser,
-  itemParser,
-  itemKey
-}: QueryBoundaryMapProps<ItemType>): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/components/QueryBoundaryWrapper.d.ts
-type QueryBoundaryWrapperProps<DataType> = Omit<QueryBoundaryProviderProps<DataType>, "children" | "logError"> & Omit<QueryBoundaryFallbackProps, "errorComponent"> & 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 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 QueryBoundaryWrapper<DataType>({
-  children,
-  errorComponent,
-  undefinedComponent,
-  nullComponent,
-  nullableComponent,
-  logError,
-  loadingComponent,
-  isLoading,
-  error,
-  data,
-  dataParser
-}: QueryBoundaryWrapperProps<DataType>): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/components/ReactPlayground.d.ts
-interface ReactPlaygroundProps extends ComponentProps<typeof LiveProvider> {
-  /** Extra styling to apply to the preview. Must be compatible with the Material UI `sx` prop. */
-  previewStyles?: SxProps<Theme>;
-}
-/** Renders a playground to help demonstrate your React code in an interactive setting. */
-declare function ReactPlayground({
-  code,
-  previewStyles,
-  ...liveProviderProps
-}: ReactPlaygroundProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/components/SkeletonRow.d.ts
-interface SkeletonRowProps {
-  /** The number of columns the SkeletonRow should display. */
-  columns: number;
-}
-/** Renders the skeleton of a table row. Often helpful to represent the loading state of the data in your table. */
-declare function SkeletonRow({
-  columns
-}: SkeletonRowProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/components/SwitchWithIcons.d.ts
-interface SwitchWithIconsProps extends Omit<SwitchProps, "icon" | "checkedIcon"> {
-  /** The icon to show when the switch is in a checked state. */
-  checkedIcon: ComponentType<{
-    style?: CSSProperties;
-  }>;
-  /** Additional styling to apply to the icon that shows when checked. */
-  checkedIconStyles?: CommonProps["style"];
-  /** The icon to show when the switch is in an unchecked state. */
-  uncheckedIcon: ComponentType<{
-    style?: CSSProperties;
-  }>;
-  /** Additional styling to apply to the icon that shows when unchecked. */
-  uncheckedIconStyles?: CommonProps["style"];
-}
-/** Renders a switch with your provided icons. */
-declare function SwitchWithIcons({
-  checkedIcon: CheckedIcon,
-  checkedIconStyles,
-  uncheckedIcon: UncheckedIcon,
-  uncheckedIconStyles,
-  ...switchProps
-}: SwitchWithIconsProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/deprecated/DropdownMenu.d.ts
-interface DropdownMenuProps {
-  children: ReactNode | ((closeMenu: () => void) => ReactNode);
-  buttonChildren?: ReactNode;
-  button?: ElementType;
-  buttonProps?: Omit<ButtonOwnProps, "onClick" | "endIcon">;
-  isOpenIcon?: ReactNode;
-  isClosedIcon?: ReactNode;
-  onOpen?: () => void;
-  onClose?: () => void;
-}
-/**
- * @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,
-  buttonChildren,
-  buttonProps: incomingButtonProps,
-  isOpenIcon,
-  isClosedIcon,
-  onOpen,
-  onClose
-}: DropdownMenuProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/deprecated/DarkModeToggle.d.ts
-/** @deprecated This component has been renamed to `ModeToggle`. */
-declare const DarkModeToggle: typeof ModeToggle;
-//#endregion
-//#region src/v7/components/DropdownMenu/DropdownMenu.d.ts
-interface DropdownMenuProps$1 extends Omit<MenuProps, "anchorEl" | "open"> {
-  /** The children to render inside of the dropdown. */
-  children: ReactNode;
-}
-/**
- * Renders a menu component that can be used alongside the `DropdownMenuProvider`.
- *
- * This component's open state would be controlled by the `DropdownMenuTrigger`.
- */
-declare function DropdownMenu$1({
-  children,
-  onClose,
-  ...menuProps
-}: DropdownMenuProps$1): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/v7/components/DropdownMenu/DropdownMenuItem.d.ts
-type DropdownMenuItemProps$1<RootComponent extends ElementType = typeof Button$1> = {
-  /**
-   * An optional component to provide to override the current component.
-   *
-   * Note that the provided component must:
-   * - accept a `to` prop.
-   * - correctly handle the forwarded `ref`.
-   * - render a valid anchor element (or equivalent) for proper accessibility.
-   */
-  component?: RootComponent; /** The children to be rendered within the menu item. */
-  children?: ReactNode; /** The ref to forward to allow it to be used with polymorphic components */
-  ref?: ComponentPropsWithRef<RootComponent>["ref"]; /** A function to execute after clicking the item. */
-  onClick?: ComponentProps<RootComponent>["onClick"];
-} & Omit<ComponentPropsWithoutRef<RootComponent>, "children" | "ref"> & MenuItemOwnProps;
-/** Represents a menu item to be used inside the `DropdownMenu`. It must be used as children of the `DropdownMenu` component. */
-declare function DropdownMenuItem$1<RootComponent extends ElementType = typeof Button$1>({
-  component,
-  children,
-  ref,
-  onClick,
-  ...menuItemProps
-}: DropdownMenuItemProps$1<RootComponent>): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/v7/components/DropdownMenu/DropdownMenuProvider.d.ts
-interface DropdownMenuContextValue {
-  /** A function responsible for closing the dropdown menu. */
-  closeMenu: () => void;
-  /** Represents whether or not the dropdown is open. */
-  isDropdownOpen: boolean;
-}
-/**
-  Access the DropdownMenu context directly.
- */
-declare function useDropdownMenu$1<Strict extends boolean = true>({
-  strict
-}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, DropdownMenuContextValue>;
-//#endregion
-//#region src/deprecated/DropdownMenu2/DropdownMenu2.d.ts
-declare const useDropdownMenu: typeof useDropdownMenu$1;
-/**
- * @deprecated Please use `DropdownMenuProps` from `@alextheman/components/v7` instead.
- *
- * This will be replaced in the root entrypoint in a future release.
- */
-type DropdownMenu2Props = DropdownMenuProps$1;
-/**
- * @deprecated Please use `DropdownMenu` from `@alextheman/components/v7` instead.
- *
- * This will be replaced in the root entrypoint in a future release.
- */
-declare const DropdownMenu2: typeof DropdownMenu$1;
-//#endregion
-//#region src/deprecated/DropdownMenu2/DropdownMenuItem.d.ts
-type DropdownMenuItemProps<RootComponent extends ElementType> = DropdownMenuItemProps$1<RootComponent>;
-declare const DropdownMenuItem: typeof DropdownMenuItem$1;
-//#endregion
-//#region src/deprecated/DropdownMenuExternalLink.d.ts
-interface DropdownMenuExternalLinkProps extends MenuItemOwnProps {
-  ref?: Ref<HTMLAnchorElement>;
-  href: ComponentProps<typeof ExternalLink>["href"];
-  onClick?: MouseEventHandler<HTMLAnchorElement>;
-  children: ReactNode;
-}
-/** @deprecated Please use `<DropdownMenuItem component={ExternalLink} />` instead. */
-declare function DropdownMenuExternalLink({
-  ref,
-  href,
-  children,
-  onClick,
-  ...menuItemProps
-}: DropdownMenuExternalLinkProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/deprecated/InternalLink.d.ts
-interface InternalLinkProps extends Omit<LinkProps, "href" | "component"> {
-  /** The path to navigate to */
-  to: `/${string}` | `~/${string}` | (string & {});
-  /**
-   * An optional component to provide to override the current component.
-   *
-   * Note that the provided component must:
-   * - accept a `to` prop
-   * - correctly handle the forwarded `ref`
-   * - render a valid anchor element (or equivalent) for proper accessibility
-   */
-  component?: ElementType;
-  href?: never;
-  /** The readable content to display on the link. */
-  children: ReactNode;
-  /** An optional ref to allow it to be used with polymorphic components. */
-  ref?: Ref<HTMLAnchorElement>;
-}
-/**
- * A stylised link for navigating within your application.
- *
- * Uses the app router for client-side navigation and opens the destination in the same tab.
- *
- * Defaults to a React Router implementation but can be overridden via the `component` prop.
- *
- * @deprecated This component is not compatible with the rest of the Wouter setup for use in v7. Please use `InternalLink` from `@alextheman/components/v7` instead. This component will be replaced when v7 officially comes out.
- */
-declare function InternalLink({
-  to,
-  component,
-  children,
-  ref,
-  ...linkProps
-}: InternalLinkProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/deprecated/DropdownMenuInternalLink.d.ts
-interface DropdownMenuInternalLinkProps extends MenuItemOwnProps {
-  ref?: Ref<HTMLAnchorElement>;
-  to: ComponentProps<typeof InternalLink>["to"];
-  onClick?: MouseEventHandler<HTMLAnchorElement>;
-  children: ReactNode;
-}
-/** @deprecated Please use `<DropdownMenuItem component={InternalLink} />` instead. */
-declare function DropdownMenuInternalLink({
-  to,
-  ref,
-  children,
-  onClick,
-  ...menuItemProps
-}: DropdownMenuInternalLinkProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/deprecated/IconWithPopover.d.ts
-interface IconWithPopoverProps {
-  icon?: (OverridableComponent<SvgIconTypeMap<unknown, "svg">> & {
-    muiName: string;
-  }) | ElementType;
-  onOpen?: () => void;
-  onClose?: () => void;
-  iconProps?: SvgIconTypeMap<unknown, "svg">["props"];
-  children: ReactNode;
-}
-/**
- * @deprecated This component is not well-designed for accessibility purposes. Please use the `Tooltip` component from `@mui/material` instead.
- *
- * @example
- * ```tsx
- * <Tooltip title="Text to display on hover">
- *   <MdVisibility />
- * </Tooltip>
- * ```
- */
-declare function IconWithPopover({
-  icon: Icon,
-  onOpen,
-  onClose,
-  iconProps,
-  children
-}: IconWithPopoverProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/deprecated/ListItemInternalLink.d.ts
-interface ListItemInternalLinkProps extends Omit<ListItemButtonProps, "href"> {
-  children: ReactNode;
-  to: string;
-}
-/** @deprecated Probably not that worth centralising here - can be easily recreated per use case. */
-declare function ListItemInternalLink({
-  children,
-  ...listItemButtonProps
-}: ListItemInternalLinkProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/deprecated/Loader.d.ts
-/** @deprecated This component has been renamed to QueryBoundary */
-declare const Loader: typeof QueryBoundaryWrapper;
-//#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 QueryBoundaryErrorProps. */
-type LoaderErrorBaseProps = QueryBoundaryErrorProps;
-/** @deprecated This type has been renamed to QueryBoundaryNullablePropsWithUndefinedOrNull. */
-type LoaderErrorPropsWithUndefinedOrNull = LoaderErrorBaseProps & QueryBoundaryNullablePropsWithUndefinedOrNull;
-/** @deprecated This type has been renamed to QueryBoundaryNullablePropsWithNullable. */
-type LoaderErrorPropsWithNullable = LoaderErrorBaseProps & QueryBoundaryNullablePropsWithNullable;
-/** @deprecated This type has been renamed to QueryBoundaryFallbackProps. */
-type LoaderErrorProps = QueryBoundaryFallbackProps;
-/** @deprecated This component has been renamed to LoaderError. */
-declare const LoaderError: typeof QueryBoundaryFallback;
-//#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/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.
- *
- * @deprecated Please use `NavigationBottom` from the `@alextheman/components/v7` entrypoint instead.
- */
-declare function NavigationBottom({
-  children,
-  navItems
-}: NavigationBottomProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/deprecated/NavigationDrawer.d.ts
-interface NavMenuItemOptions {
-  /** The label to display on the nav item option. */
-  label: string;
-  /** Where in your app the nav item option should navigate to. */
-  to: string;
-  /** An icon to display alongside the nav item option. */
-  icon?: ReactNode;
-}
-interface NavMenuItem {
-  /** The category to display all the nav item options under. */
-  category: string;
-  /** An array of nav options to display under the chosen category. */
-  options: Array<NavMenuItemOptions>;
-}
-interface NavigationDrawerProps {
-  /** The title to display at the top of the wrapper. */
-  title: string;
-  /** An array of nav items to show. */
-  navItems: Array<NavMenuItem>;
-  /** Any extra elements to add to the header. */
-  headerElements?: ReactNode;
-  /** Children to display within the wrapper. */
-  children: ReactNode;
-}
-/**
- * Renders a collapsable drawer to help with navigation. Best used as the main means of navigation on desktop apps.
- *
- * @deprecated This component is not compatible with the rest of the Wouter setup for use in v7. Please use `NavigationDrawer` from `@alextheman/components/v7` instead. This component will be replaced when v7 officially comes out.
- */
-declare function NavigationDrawer({
-  title,
-  navItems,
-  children,
-  headerElements
-}: NavigationDrawerProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/deprecated/PopoverText.d.ts
-interface PopoverTextProps extends TypographyProps {
-  text: string;
-}
-/**
- * @deprecated This component has been deprecated alongside `IconWithPopover`.
- */
-declare function PopoverText({
-  text,
-  sx,
-  ...typographyProps
-}: PopoverTextProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/deprecated/QueryBoundary.d.ts
-/** @deprecated This type has been renamed to `QueryBoundaryWrapperProps`. */
-type QueryBoundaryProps<DataType> = QueryBoundaryWrapperProps<DataType>;
-/** @deprecated This component has been renamed to `QueryBoundaryWrapper` */
-declare const QueryBoundary: typeof QueryBoundaryWrapper;
-//#endregion
-//#region src/deprecated/SubmitButton.d.ts
-interface SubmitButtonProps extends Omit<ButtonProps, "type"> {
-  /** An option to disable the button on submit if the form is not dirty. */
-  disableClean?: boolean;
-  /** The label for the button. */
-  label: string;
-}
-/**
- * A Submit Button for use with `react-hook-form`.
- *
- * @deprecated This component is not compatible with `@tanstack/react-form`. Please use `SubmitButton` from the `@alextheman/components/v7` entrypoint instead. This component will be replaced when v7 officially comes out.
- */
-declare function SubmitButton({
-  disableClean,
-  label,
-  ...buttonProps
-}: SubmitButtonProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/hooks/useDebounce.d.ts
-/**
- * Assign a variable a given value after a given amount of milliseconds.
- *
- * @template ValueType The type of the value to set.
- *
- * @param value - The value to assign.
- * @param delay - The amount of milliseconds to wait before assigning the value.
- *
- * @returns The input value after a given number of seconds.
- */
-declare function useDebounce<ValueType>(value: ValueType, delay?: number): ValueType;
-//#endregion
-//#region src/hooks/useHash.d.ts
-/**
- * Stores changes to the window hash as React state.
- *
- * @template StateType - The type of the hash state.
- *
- * @param initialHash - The initial value of the hash.
- *
- * @returns A tuple containing the hash state, and a updater function to set the hash state.
- */
-declare function useHash<StateType extends string>(initialHash: StateType | undefined): [StateType, Dispatch<SetStateAction<StateType>>];
-//#endregion
-//#region src/providers/AudioProvider/index.d.ts
-interface TrackData {
-  title: string;
-  src: string;
-  artist: string;
-}
-interface AudioContextValue {
-  tracks: Array<TrackData>;
-  currentTrack: TrackData;
-  setCurrentTrack: Dispatch<SetStateAction<TrackData>>;
-}
-interface AudioProviderProps {
-  tracks: Array<TrackData>;
-  children: ReactNode;
-}
-/** Allows access to the audio information provided by AudioProvider. Will fail if AudioProvider could not be accessed and strict mode is true. */
-declare function useAudioContext<Strict extends boolean = true>({
-  strict
-}?: ContextHookOptions<Strict>): OptionalOnCondition<Strict, AudioContextValue>;
-/** Provides audio information to the children components. */
-declare function AudioProvider({
-  tracks,
-  children
-}: AudioProviderProps): import("react/jsx-runtime").JSX.Element;
-//#endregion
-//#region src/providers/AudioProvider/AudioControls.d.ts
-/** Controls the tracks provided by the AudioProvider. */
-declare function AudioControls(): import("react/jsx-runtime").JSX.Element;
-//#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): import("react/jsx-runtime").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 ScreenDimensions {
-  /** The current window width. */
-  windowWidth: number;
-  /** The current window height. */
-  windowHeight: number;
-}
-interface ScreenSizeContextValue extends ScreenDimensions {
-  /** Whether the screen is a large screen or not. */
-  isLargeScreen: boolean;
-}
-/** 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): import("react/jsx-runtime").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): import("react/jsx-runtime").JSX.Element;
-//#endregion
-export { Artwork, type AudioContextValue, AudioControls, AudioProvider, type AudioProviderProps, CollapsableItem, type CollapsableItemProps, type ContextHookOptions, type CreateBaseQueryBoundaryParameters, type CreateItemQueryBoundaryParameters, type CreateListQueryBoundaryParameters, type CreateQueryBoundaryParameters, DarkModeToggle, type DefaultQueryBoundaryComponents, type DefaultQueryBoundaryComponentsBase, type DefaultQueryBoundaryItemComponents, type DefaultQueryBoundaryListComponents, 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 QueryItem, type QueryList, type QueryMultiple, type QuerySingle, ReactPlayground, type ReactPlaygroundProps, type ScreenDimensions, type ScreenSizeContextValue, type ScreenSizeProps, ScreenSizeProvider, SkeletonRow, type SkeletonRowProps, SnackbarProvider, type SnackbarProviderProps, SubmitButton, type SubmitButtonProps, SwitchWithIcons, type SwitchWithIconsProps, type TrackData, createBaseQueryBoundary, createItemQueryBoundary, createListQueryBoundary, createQueryBoundary, useAudioContext, useDebounce, useDropdownMenu, useHash, useMode, useQueryBoundary, useScreenSize, useSnackbar };
-//# sourceMappingURL=index.d.cts.map