@alextheman/components 6.2.3 → 6.3.0

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import * as react_jsx_runtime2 from "react/jsx-runtime";
+import * as react_jsx_runtime3 from "react/jsx-runtime";
 import { CollapseProps } from "@mui/material/Collapse";
 import { PaletteMode, SxProps, Theme } from "@mui/material/styles";
 import * as react0 from "react";
@@ -15,20 +15,44 @@ import { TypographyProps } from "@mui/material/Typography";
 import { LiveProvider } from "react-live";
 import { SwitchProps } from "@mui/material/Switch";
 
+//#region src/components/Artwork.d.ts
+declare function Artwork(): react_jsx_runtime3.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.
+ *
+ * @param props - Props to pass to CollapsableItem
+ */
 declare function CollapsableItem({
   isInitiallyOpen,
   onOpen,
@@ -41,10 +65,10 @@ declare function CollapsableItem({
   openIcon,
   closedIcon,
   useDefaultStyling
-}: CollapsableItemProps): react_jsx_runtime2.JSX.Element;
+}: CollapsableItemProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/components/DarkModeToggle.d.ts
-declare function DarkModeToggle(): react_jsx_runtime2.JSX.Element;
+declare function DarkModeToggle(): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/components/DropdownMenu.d.ts
 interface DropdownMenuProps {
@@ -58,15 +82,6 @@ interface DropdownMenuProps {
   onClose?: () => void;
 }
 /**
- * @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({
@@ -78,7 +93,7 @@ declare function DropdownMenu({
   isClosedIcon,
   onOpen,
   onClose
-}: DropdownMenuProps): react_jsx_runtime2.JSX.Element;
+}: DropdownMenuProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/components/ExternalLink.d.ts
 interface ExternalLinkProps extends Omit<LinkProps, "to" | "target" | "rel"> {
@@ -92,7 +107,7 @@ declare function ExternalLink({
   children,
   ref,
   ...linkProps
-}: ExternalLinkProps): react_jsx_runtime2.JSX.Element;
+}: ExternalLinkProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/components/FileInput.d.ts
 declare const FileType: {
@@ -121,7 +136,7 @@ declare function FileInput({
   accept,
   useDropzone,
   ...buttonProps
-}: FileInputProps): react_jsx_runtime2.JSX.Element;
+}: FileInputProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/components/FileInputList.d.ts
 interface FileInputListProps extends Omit<FileInputProps, "onFileInput"> {
@@ -132,7 +147,7 @@ declare function FileInputList({
   files,
   setFiles,
   ...fileInputProps
-}: FileInputListProps): react_jsx_runtime2.JSX.Element;
+}: FileInputListProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/components/IconWithPopover.d.ts
 interface IconWithPopoverProps {
@@ -150,7 +165,7 @@ declare function IconWithPopover({
   onClose,
   iconProps,
   children
-}: IconWithPopoverProps): react_jsx_runtime2.JSX.Element;
+}: IconWithPopoverProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/components/InternalLink.d.ts
 interface InternalLinkProps extends Omit<LinkProps, "href"> {
@@ -164,7 +179,7 @@ declare function InternalLink({
   children,
   ref,
   ...linkProps
-}: InternalLinkProps): react_jsx_runtime2.JSX.Element;
+}: InternalLinkProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/components/ListItemInternalLink.d.ts
 interface ListItemInternalLinkProps extends Omit<ListItemButtonProps, "href"> {
@@ -174,7 +189,7 @@ interface ListItemInternalLinkProps extends Omit<ListItemButtonProps, "href"> {
 declare function ListItemInternalLink({
   children,
   ...listItemButtonProps
-}: ListItemInternalLinkProps): react_jsx_runtime2.JSX.Element;
+}: ListItemInternalLinkProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/types/ContextHookOptions.d.ts
 interface ContextHookOptions<S extends boolean = true> {
@@ -204,7 +219,7 @@ declare function DropdownMenu2({
   buttonProps,
   openIcon,
   closedIcon
-}: DropdownMenu2Props): react_jsx_runtime2.JSX.Element;
+}: DropdownMenu2Props): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/providers/DropdownMenu2/DropdownMenuExternalLink.d.ts
 interface DropdownMenuExternalLinkProps extends MenuItemOwnProps {
@@ -219,7 +234,7 @@ declare function DropdownMenuExternalLink({
   children,
   onClick,
   ...menuItemProps
-}: DropdownMenuExternalLinkProps): react_jsx_runtime2.JSX.Element;
+}: DropdownMenuExternalLinkProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/providers/DropdownMenu2/DropdownMenuInternalLink.d.ts
 interface DropdownMenuInternalLinkProps extends MenuItemOwnProps {
@@ -234,7 +249,7 @@ declare function DropdownMenuInternalLink({
   children,
   onClick,
   ...menuItemProps
-}: DropdownMenuInternalLinkProps): react_jsx_runtime2.JSX.Element;
+}: DropdownMenuInternalLinkProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/providers/DropdownMenu2/DropdownMenuItem.d.ts
 type DropdownMenuItemProps<RootComponent extends ElementType = typeof Button$1> = {
@@ -249,7 +264,7 @@ declare function DropdownMenuItem<RootComponent extends ElementType>({
   ref,
   onClick,
   ...menuItemProps
-}: DropdownMenuItemProps<RootComponent>): react_jsx_runtime2.JSX.Element;
+}: DropdownMenuItemProps<RootComponent>): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/providers/LoaderProvider/LoaderProvider.d.ts
 interface LoaderProviderBaseProps<DataType> {
@@ -282,20 +297,22 @@ type LoaderProviderProps<T> = LoaderContextValue<T> & {
 /**
  * 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.
+ *
+ * @param props - Props to pass to LoaderProvider.
+ * @param props.children - The components that may receive access to the LoaderContext value.
+ * @param props.loadingComponent - The component to show when the data is being fetched.
+ * @param props.isLoading - The current loading status (true if loading, false if not)
+ * @param props.error - The error given if the request gave an error.
+ * @param props.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 props.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<DataType>({
   children,
   loadingComponent,
   ...contextProps
-}: LoaderProviderProps<DataType>): react_jsx_runtime2.JSX.Element;
+}: LoaderProviderProps<DataType>): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/providers/LoaderProvider/LoaderData.d.ts
 interface LoaderDataProps<T> {
@@ -311,18 +328,20 @@ interface LoaderDataProps<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.
+ *
+ * @param props - Props to pass to LoaderData.
+ * @param props.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.
+ * @param props.dataParser - A parser for the data.
+ * @param props.loadingComponent - The component to show when the data is being fetched.
  */
 declare function LoaderData<DataType>({
   children,
   dataParser: loaderDataParser,
   loadingComponent
-}: LoaderDataProps<DataType>): react_jsx_runtime2.JSX.Element;
+}: LoaderDataProps<DataType>): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/providers/LoaderProvider/LoaderError.d.ts
 interface LoaderErrorBaseProps {
@@ -347,12 +366,13 @@ interface LoaderErrorPropsWithNullable extends LoaderErrorBaseProps {
 type LoaderErrorProps = LoaderErrorPropsWithUndefinedOrNull | LoaderErrorPropsWithNullable;
 /**
  * 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.
+ *
+ * @param props - The props to be passed to LoaderError.
+ * @param props.children - The component to show if an error has been thrown.
+ * @param props.undefinedComponent - The component to show if no error was thrown but the data is undefined.
+ * @param props.nullComponent - The component to show if no error was thrown but the data is null.
+ * @param props.nullableComponent - The component to show if no error was thrown but the data is nullable (undefined or null).
+ * @param props.logError - An option to log the error to the console.
  */
 declare function LoaderError({
   children,
@@ -360,7 +380,7 @@ declare function LoaderError({
   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_runtime3.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 {
@@ -377,7 +397,7 @@ interface ModeProviderProps {
 declare function ModeProvider({
   children,
   mode: modeProp
-}: ModeProviderProps): react_jsx_runtime2.JSX.Element;
+}: ModeProviderProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/providers/ScreenSizeProvider.d.ts
 interface ScreenSizeProps {
@@ -397,7 +417,7 @@ declare function ScreenSizeProvider({
   children,
   largeScreenWidth,
   largeScreenHeight
-}: ScreenSizeProps): react_jsx_runtime2.JSX.Element;
+}: ScreenSizeProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/providers/SnackbarProvider.d.ts
 interface SnackbarProviderProps {
@@ -413,22 +433,24 @@ declare function useSnackbar<Strict extends boolean = true>({
 declare function SnackbarProvider({
   children,
   autoHideDuration
-}: SnackbarProviderProps): react_jsx_runtime2.JSX.Element;
+}: SnackbarProviderProps): react_jsx_runtime3.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">;
 /**
  * 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.
+ *
+ * @param props - Props to pass to Loader.
+ * @param props.children - The elements to show after data has been loaded.
+ * @param props.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 props.undefinedComponent - The component to show if no error was thrown but the data is undefined.
+ * @param props.nullComponent - The component to show if no error was thrown but the data is null.
+ * @param props.nullableComponent - The component to show if no error was thrown but the data is nullable (undefined or null).
+ * @param props.loadingComponent - The component to show when the data is being fetched.
+ * @param props.logError - An option to log the error to the console.
  */
 declare function Loader<DataType>({
   children,
@@ -439,7 +461,7 @@ declare function Loader<DataType>({
   logError,
   loadingComponent,
   ...loaderProviderProps
-}: LoaderProps<DataType>): react_jsx_runtime2.JSX.Element;
+}: LoaderProps<DataType>): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/components/NavigationBottom.d.ts
 interface NavItemBottom {
@@ -455,7 +477,7 @@ interface NavigationBottomProps {
 declare function NavigationBottom({
   children,
   navItems
-}: NavigationBottomProps): react_jsx_runtime2.JSX.Element;
+}: NavigationBottomProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/components/NavigationDrawer.d.ts
 interface NavMenuItem {
@@ -477,7 +499,7 @@ declare function NavigationDrawer({
   navItems,
   children,
   headerElements
-}: NavigationDrawerProps): react_jsx_runtime2.JSX.Element;
+}: NavigationDrawerProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/components/PopoverText.d.ts
 interface PopoverTextProps extends TypographyProps {
@@ -487,7 +509,7 @@ declare function PopoverText({
   text,
   sx,
   ...typographyProps
-}: PopoverTextProps): react_jsx_runtime2.JSX.Element;
+}: PopoverTextProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/components/ReactPlayground.d.ts
 interface ReactPlaygroundProps extends ComponentProps<typeof LiveProvider> {
@@ -497,7 +519,7 @@ declare function ReactPlayground({
   code,
   previewStyles,
   ...liveProviderProps
-}: ReactPlaygroundProps): react_jsx_runtime2.JSX.Element;
+}: ReactPlaygroundProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/components/SkeletonRow.d.ts
 interface SkeletonRowProps {
@@ -505,7 +527,7 @@ interface SkeletonRowProps {
 }
 declare function SkeletonRow({
   columns
-}: SkeletonRowProps): react_jsx_runtime2.JSX.Element;
+}: SkeletonRowProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/components/SubmitButton.d.ts
 interface SubmitButtonProps extends Omit<ButtonProps, "type"> {
@@ -516,7 +538,7 @@ declare function SubmitButton({
   disableClean,
   label,
   ...buttonProps
-}: SubmitButtonProps): react_jsx_runtime2.JSX.Element;
+}: SubmitButtonProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/components/SwitchWithIcons.d.ts
 interface SwitchWithIconsProps extends Omit<SwitchProps, "icon" | "checkedIcon"> {
@@ -535,10 +557,10 @@ declare function SwitchWithIcons({
   uncheckedIcon: UncheckedIcon,
   uncheckedIconStyles,
   ...switchProps
-}: SwitchWithIconsProps): react_jsx_runtime2.JSX.Element;
+}: SwitchWithIconsProps): react_jsx_runtime3.JSX.Element;
 //#endregion
 //#region src/hooks/useHash.d.ts
 declare function useHash<S extends string>(initialHash: S | undefined): [S, Dispatch<SetStateAction<S>>];
 //#endregion
-export { CollapsableItem, type CollapsableItemProps, ContextHookOptions, DarkModeToggle, DropdownMenu, DropdownMenu2, type DropdownMenu2Props, DropdownMenuExternalLink, type DropdownMenuExternalLinkProps, DropdownMenuInternalLink, type DropdownMenuInternalLinkProps, DropdownMenuItem, type DropdownMenuItemProps, type DropdownMenuProps, ExternalLink, type ExternalLinkProps, FileInput, FileInputList, type FileInputListProps, type FileInputProps, FileType, IconWithPopover, type IconWithPopoverProps, InternalLink, type InternalLinkProps, ListItemInternalLink, type ListItemInternalLinkProps, 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, type NavItemBottom, type NavMenuItem, NavigationBottom, type NavigationBottomProps, NavigationDrawer, type NavigationDrawerProps, 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, type DropdownMenuExternalLinkProps, DropdownMenuInternalLink, type DropdownMenuInternalLinkProps, DropdownMenuItem, type DropdownMenuItemProps, type DropdownMenuProps, ExternalLink, type ExternalLinkProps, FileInput, FileInputList, type FileInputListProps, type FileInputProps, FileType, IconWithPopover, type IconWithPopoverProps, InternalLink, type InternalLinkProps, ListItemInternalLink, type ListItemInternalLinkProps, 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, type NavItemBottom, type NavMenuItem, NavigationBottom, type NavigationBottomProps, NavigationDrawer, type NavigationDrawerProps, 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 };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -1,7 +1,8 @@
+import { TypographyProps } from "@mui/material/Typography";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
 import { CollapseProps } from "@mui/material/Collapse";
 import * as react0 from "react";
 import { CSSProperties, ComponentProps, ComponentPropsWithRef, ComponentPropsWithoutRef, ComponentType, Dispatch, ElementType, JSX, MouseEvent, MouseEventHandler, ReactNode, Ref, SetStateAction } from "react";
-import * as react_jsx_runtime0 from "react/jsx-runtime";
 import MUIButton, { ButtonOwnProps, ButtonProps } from "@mui/material/Button";
 import { MenuItemOwnProps } from "@mui/material/MenuItem";
 import { AlertColor } from "@mui/material/Alert";
@@ -9,26 +10,49 @@ import { PaletteMode, SxProps, Theme } from "@mui/material/styles";
 import { OptionalOnCondition } from "@alextheman/utility";
 import { LinkProps } from "@mui/material/Link";
 import { ListItemButtonProps } from "@mui/material/ListItemButton";
-import { TypographyProps } from "@mui/material/Typography";
 import { LiveProvider } from "react-live";
 import { SwitchProps } from "@mui/material/Switch";
 import { CommonProps, OverridableComponent } from "@mui/material/OverridableComponent";
 import { SvgIconTypeMap } from "@mui/material/SvgIcon";
 
+//#region src/components/Artwork.d.ts
+declare function Artwork(): react_jsx_runtime0.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.
+ *
+ * @param props - Props to pass to CollapsableItem
+ */
 declare function CollapsableItem({
   isInitiallyOpen,
   onOpen,
@@ -58,15 +82,6 @@ interface DropdownMenuProps {
   onClose?: () => void;
 }
 /**
- * @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({
@@ -282,14 +297,16 @@ type LoaderProviderProps<T> = LoaderContextValue<T> & {
 /**
  * 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.
+ *
+ * @param props - Props to pass to LoaderProvider.
+ * @param props.children - The components that may receive access to the LoaderContext value.
+ * @param props.loadingComponent - The component to show when the data is being fetched.
+ * @param props.isLoading - The current loading status (true if loading, false if not)
+ * @param props.error - The error given if the request gave an error.
+ * @param props.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 props.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<DataType>({
   children,
@@ -311,12 +328,14 @@ interface LoaderDataProps<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.
+ *
+ * @param props - Props to pass to LoaderData.
+ * @param props.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.
+ * @param props.dataParser - A parser for the data.
+ * @param props.loadingComponent - The component to show when the data is being fetched.
  */
 declare function LoaderData<DataType>({
   children,
@@ -347,12 +366,13 @@ interface LoaderErrorPropsWithNullable extends LoaderErrorBaseProps {
 type LoaderErrorProps = LoaderErrorPropsWithUndefinedOrNull | LoaderErrorPropsWithNullable;
 /**
  * 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.
+ *
+ * @param props - The props to be passed to LoaderError.
+ * @param props.children - The component to show if an error has been thrown.
+ * @param props.undefinedComponent - The component to show if no error was thrown but the data is undefined.
+ * @param props.nullComponent - The component to show if no error was thrown but the data is null.
+ * @param props.nullableComponent - The component to show if no error was thrown but the data is nullable (undefined or null).
+ * @param props.logError - An option to log the error to the console.
  */
 declare function LoaderError({
   children,
@@ -420,15 +440,17 @@ type LoaderProps<DataType> = Omit<LoaderProviderProps<DataType>, "children" | "l
 /**
  * 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.
+ *
+ * @param props - Props to pass to Loader.
+ * @param props.children - The elements to show after data has been loaded.
+ * @param props.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 props.undefinedComponent - The component to show if no error was thrown but the data is undefined.
+ * @param props.nullComponent - The component to show if no error was thrown but the data is null.
+ * @param props.nullableComponent - The component to show if no error was thrown but the data is nullable (undefined or null).
+ * @param props.loadingComponent - The component to show when the data is being fetched.
+ * @param props.logError - An option to log the error to the console.
  */
 declare function Loader<DataType>({
   children,
@@ -540,5 +562,5 @@ declare function SwitchWithIcons({
 //#region src/hooks/useHash.d.ts
 declare function useHash<S extends string>(initialHash: S | undefined): [S, Dispatch<SetStateAction<S>>];
 //#endregion
-export { CollapsableItem, type CollapsableItemProps, ContextHookOptions, DarkModeToggle, DropdownMenu, DropdownMenu2, type DropdownMenu2Props, DropdownMenuExternalLink, type DropdownMenuExternalLinkProps, DropdownMenuInternalLink, type DropdownMenuInternalLinkProps, DropdownMenuItem, type DropdownMenuItemProps, type DropdownMenuProps, ExternalLink, type ExternalLinkProps, FileInput, FileInputList, type FileInputListProps, type FileInputProps, FileType, IconWithPopover, type IconWithPopoverProps, InternalLink, type InternalLinkProps, ListItemInternalLink, type ListItemInternalLinkProps, 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, type NavItemBottom, type NavMenuItem, NavigationBottom, type NavigationBottomProps, NavigationDrawer, type NavigationDrawerProps, 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, type DropdownMenuExternalLinkProps, DropdownMenuInternalLink, type DropdownMenuInternalLinkProps, DropdownMenuItem, type DropdownMenuItemProps, type DropdownMenuProps, ExternalLink, type ExternalLinkProps, FileInput, FileInputList, type FileInputListProps, type FileInputProps, FileType, IconWithPopover, type IconWithPopoverProps, InternalLink, type InternalLinkProps, ListItemInternalLink, type ListItemInternalLinkProps, 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, type NavItemBottom, type NavMenuItem, NavigationBottom, type NavigationBottomProps, NavigationDrawer, type NavigationDrawerProps, 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 };
 //# sourceMappingURL=index.d.ts.map