@adamjanicki/ui 1.8.7 → 1.8.8

package/components/Accordion/Accordion.d.ts

@@ -2,37 +2,26 @@ import React from "react";
 import { type BoxProps } from "../Box/Box";
 import type { ReadonlyableArray } from "../../types/common";
 type Props = Omit<BoxProps, "children"> & {
-    /**
-     * Drawers to render as accordion sections
-     */
+    /** Drawers to render as accordion sections */
     drawers: ReadonlyableArray<Drawer>;
-    /**
-     * Duration of the drawer animation (in seconds)
-     */
+    /** Duration of the drawer animation (in seconds) */
     duration?: number;
     /**
-     * Whether to hide the dividers between drawers
+     * Whether to hide the dividers between drawers.
      * @default false
      */
     hideDividers?: boolean;
 };
+/** A vertical list of collapsible drawers */
 declare const Accordion: React.ForwardRefExoticComponent<Omit<Props, "ref"> & React.RefAttributes<HTMLDivElement>>;
 type Drawer = {
-    /**
-     * Label for the accordion drawer
-     */
+    /** Label for the accordion drawer */
     label: string;
-    /**
-     * Content hidden within this accordion drawer
-     */
+    /** Content hidden within this accordion drawer */
     content: React.ReactNode;
-    /**
-     * Whether the drawer is open
-     */
+    /** Whether the drawer is open */
     open: boolean;
-    /**
-     * Callback that fires when the open state changes for this drawer
-     */
+    /** Callback that fires when the open state changes for this drawer */
     onOpenChange: (open: boolean) => void;
 };
 type DrawerProps = {

package/components/Alert/Alert.d.ts

@@ -2,10 +2,9 @@ import React from "react";
 import type { ContentType } from "../../types/common";
 import { type BoxProps } from "../Box/Box";
 type Props = BoxProps & {
-    /**
-     * The type of alert to display.
-     */
+    /** The type of alert to display */
     type: ContentType;
 };
+/** A styled container for status messages */
 declare const Alert: React.ForwardRefExoticComponent<Omit<Props, "ref"> & React.RefAttributes<HTMLDivElement>>;
 export default Alert;

package/components/Animated/Animated.d.ts

@@ -2,17 +2,11 @@ import React from "react";
 import type { ReadonlyableArray, Style, Vfx } from "../../types/common";
 import { type BoxProps } from "../Box/Box";
 type AnimationState = {
-    /**
-     * Class to apply to the component when at this state
-     */
+    /** Class to apply to the component when at this state */
     className?: string;
-    /**
-     * Inline styles to apply to the component at this state
-     */
+    /** Inline styles to apply to the component at this state */
     style?: Style;
-    /**
-     * The VFX or other organizational css to apply at this state
-     */
+    /** The VFX or other organizational CSS to apply at this state */
     vfx?: Vfx;
 };
 type Props = BoxProps & {
@@ -22,37 +16,30 @@ type Props = BoxProps & {
      */
     visible: boolean;
     /**
-     * Duration of the animation in seconds
+     * Duration of the animation in seconds.
      * @default 0.25
      */
     duration?: number | {
-        /**
-         * Length of the forward direction
-         */
+        /** Length of the forward direction */
         forward: number;
-        /**
-         * Length of the reverse direction
-         */
+        /** Length of the reverse direction */
         reverse: number;
     };
     /**
-     * Whether to keep the component mounted when it is not animated
+     * Whether to keep the component mounted when it is not animated.
      * @default false
      */
     keepMounted?: boolean;
-    /**
-     * Animation css for the start state
-     */
+    /** Animation CSS for the start state */
     animateTo?: AnimationState;
-    /**
-     * animation css for the end state
-     */
+    /** Animation CSS for the end state */
     animateFrom?: AnimationState;
     /**
-     * The properties to apply a transition
+     * The properties to apply a transition.
      * @default ['all']
      */
     transitionProperties?: ReadonlyableArray<string>;
 };
+/** Wrapper for animating enter/exit states */
 declare const Animated: React.ForwardRefExoticComponent<Omit<Props, "ref"> & React.RefAttributes<HTMLDivElement>>;
 export default Animated;

package/components/Avatar/Avatar.d.ts

@@ -3,19 +3,18 @@ import type { SizeToken } from "../../types/common";
 import { type BoxProps } from "../Box/Box";
 type Props = Omit<BoxProps, "children"> & {
     /**
-     * Size of the avatar
+     * Size of the avatar.
      * @default "s"
      */
     size?: SizeToken | number;
-    /**
-     * Image to be used in the background
-     */
+    /** Image to be used in the background */
     backgroundImage?: string;
     /**
-     * Username to render the first char of,
-     * or as a fallback if there's a 404 getting the backgroundImage url
+     * Username to render the first char of,.
+     * Or as a fallback if there's a 404 getting the backgroundImage URL.
      */
     username: string;
 };
+/** An image or letter to represent a user/similar */
 declare const Avatar: React.ForwardRefExoticComponent<Omit<Props, "ref"> & React.RefAttributes<HTMLDivElement>>;
 export default Avatar;

package/components/Badge/Badge.d.ts

@@ -2,10 +2,9 @@ import React from "react";
 import type { ContentType } from "../../types/common";
 import { type BoxProps } from "../Box/Box";
 type Props = BoxProps & {
-    /**
-     * The type of badge to display.
-     */
+    /** The type of badge to display */
     type: ContentType;
 };
+/** A small label for status */
 declare const Badge: React.ForwardRefExoticComponent<Omit<Props, "ref"> & React.RefAttributes<HTMLDivElement>>;
 export default Badge;

package/components/Banner/Banner.d.ts

@@ -2,10 +2,9 @@ import React from "react";
 import type { ContentType } from "../../types/common";
 import { type BoxProps } from "../Box/Box";
 type Props = BoxProps & {
-    /**
-     * The type of banner to display.
-     */
+    /** The type of banner to display */
     type: ContentType;
 };
+/** A full-width banner for page-level messages */
 declare const Banner: React.ForwardRefExoticComponent<Omit<Props, "ref"> & React.RefAttributes<HTMLDivElement>>;
 export default Banner;

package/components/Box/Box.d.ts

@@ -1,6 +1,8 @@
 import React from "react";
-declare const Box: React.ForwardRefExoticComponent<Omit<React.ClassAttributes<HTMLDivElement> & React.HTMLAttributes<HTMLDivElement> & {
+/** Basic layout component */
+declare const Box: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
     vfx?: import("../../types/common").Vfx;
-}, "ref"> & React.RefAttributes<HTMLDivElement>>;
+} & React.RefAttributes<HTMLDivElement>>;
+/** Props for the `Box` component */
 export type BoxProps = React.ComponentProps<typeof Box>;
 export default Box;

package/components/Button/Button.d.ts

@@ -1,22 +1,25 @@
 import React from "react";
 import ui from "../ui";
 type DefaultButtonProps = React.ComponentProps<typeof ui.button>;
+/** Visual styling options for `Button` and `ButtonLink` */
 export type VisualButtonProps = {
     /**
-     * Type of button
+     * Type of button.
      * @default "primary"
      */
     variant?: "primary" | "secondary";
     /**
-     * [Optional] Size of the button, if wishing to make smaller
+     * Size of the button, if wishing to make smaller.
      * @default "regular"
      */
     size?: "regular" | "small";
 };
 type ButtonProps = DefaultButtonProps & VisualButtonProps;
-export declare const UnstyledButton: React.ForwardRefExoticComponent<Omit<Omit<React.ClassAttributes<HTMLButtonElement> & React.ButtonHTMLAttributes<HTMLButtonElement> & {
+/** An unstyled `button` */
+export declare const UnstyledButton: React.ForwardRefExoticComponent<Omit<Omit<React.DetailedHTMLProps<React.ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
     vfx?: import("../../types/common").Vfx;
-}, "ref"> & React.RefAttributes<HTMLButtonElement>, "ref"> & React.RefAttributes<HTMLButtonElement>>;
+} & React.RefAttributes<HTMLButtonElement>, "ref"> & React.RefAttributes<HTMLButtonElement>>;
+/** A styled `button` component */
 declare const Button: React.ForwardRefExoticComponent<Omit<ButtonProps, "ref"> & React.RefAttributes<HTMLButtonElement>>;
 export declare const getButtonProps: ({ variant, size, }: VisualButtonProps) => {
     readonly className: "aui-button-primary" | "aui-button-secondary";

package/components/Button/IconButton.d.ts

@@ -4,22 +4,17 @@ import { UnstyledButton } from "./Button";
 type DefaultButtonProps = React.ComponentProps<typeof UnstyledButton>;
 type IconButtonProps = Omit<DefaultButtonProps, "children"> & {
     /**
-     * The hover effect to play when the user hovers over the button
+     * The hover effect to play when the user hovers over the button.
      * @default "dim"
      */
     variant?: "dim" | "undim";
-    /**
-     * Which icon to render in the button
-     */
+    /** Which icon to render in the button */
     icon: IconProps["icon"];
-    /**
-     * The size of the icon
-     */
+    /** The size of the icon */
     size?: IconProps["size"];
-    /**
-     * Other props to pass to the icon element
-     */
+    /** Other props to pass to the icon element */
     iconProps?: Omit<IconProps, "icon" | "size">;
 };
+/** A button that renders an `Icon` component */
 export declare const IconButton: React.ForwardRefExoticComponent<Omit<IconButtonProps, "ref"> & React.RefAttributes<HTMLButtonElement>>;
 export {};

package/components/Carousel/Carousel.d.ts

@@ -2,56 +2,43 @@ import React from "react";
 import type { Children, ReadonlyableArray, Style } from "../../types/common";
 import { type BoxProps } from "../Box/Box";
 type ButtonProps = {
-    /**
-     * Children to render inside the button
-     */
+    /** Children to render inside the button */
     children?: Children;
-    /**
-     * Additional class name to apply to the button
-     */
+    /** Additional class name to apply to the button */
     className?: string;
-    /**
-     * Additional styles to apply to the button
-     */
+    /** Additional styles to apply to the button */
     style?: Style;
 };
 type Props = BoxProps & {
-    /**
-     * The child elements/slides of the carousel
-     */
+    /** The child elements/slides of the carousel */
     children: ReadonlyableArray<React.ReactNode>;
     /**
-     * How long the transition lasts (in seconds)
+     * How long the transition lasts (in seconds).
      * @default 1
      */
     duration?: number;
     /**
-     * The interval at which autoplay runs (in seconds)
-     * @default false
+     * The interval at which autoplay runs (in seconds).
+     * @example 5
      */
     autoplayInterval?: number;
     /**
-     * Whether to hide the arrow controls
+     * Whether to hide the arrow controls.
      * @default false
      */
     hideArrows?: boolean;
     /**
-     * Whether to hide the dot controls
+     * Whether to hide the dot controls.
      * @default false
      */
     hideDots?: boolean;
-    /**
-     * [Optional] props to supply to the dot buttons
-     */
+    /** Props to supply to the dot buttons */
     dotProps?: Omit<ButtonProps, "children">;
-    /**
-     * [Optional] props to supply to the left arrow button
-     */
+    /** Props to supply to the left arrow button */
     leftArrowProps?: ButtonProps;
-    /**
-     * [Optional] props to supply to the right arrow button
-     */
+    /** Props to supply to the right arrow button */
     rightArrowProps?: ButtonProps;
 };
+/** A carousel for paging through a list of slides */
 declare const Carousel: React.ForwardRefExoticComponent<Omit<Props, "ref"> & React.RefAttributes<HTMLDivElement>>;
 export default Carousel;

package/components/ClickOutside/ClickOutside.d.ts

@@ -13,14 +13,15 @@ type Props = {
     /**
      * The function to call when a click occurs outside the child element.
      *
-     * @param event - The mouse event object
+     * @param event The mouse event object.
      */
     onClickOutside: (event: MouseEvent) => void;
     /**
-     * The mouse event to trigger on
+     * The mouse event to trigger on.
      * @default "click"
      */
     mouseEvent?: keyof typeof mouseEvents;
 };
+/** Fire a callback when a click occurs outside the child target */
 declare const ClickOutside: ({ children, onClickOutside, mouseEvent, }: Props) => React.JSX.Element;
 export default ClickOutside;

package/components/ErrorBoundary/ErrorBoundary.d.ts

@@ -5,30 +5,21 @@ type FallbackProps = {
     reset: () => void;
 };
 type Props = {
-    /**
-     * Component to render when an error is caught
-     */
+    /** Component to render when an error is caught */
     Fallback: React.ComponentType<FallbackProps>;
-    /**
-     * Children wrapped by the error boundary
-     */
+    /** Children wrapped by the error boundary */
     children: React.ReactNode;
-    /**
-     * Called when an error is caught
-     */
+    /** Called when an error is caught */
     onError?: (error: Error, info: React.ErrorInfo) => void;
-    /**
-     * Called when the error state is reset
-     */
+    /** Called when the error state is reset */
     onReset?: () => void;
-    /**
-     * Dependencies to trigger a reset on change
-     */
+    /** Dependencies to trigger a reset on change */
     deps?: ReadonlyableArray<unknown>;
 };
 type State = {
     error: Error | null;
 };
+/** Catch rendering errors and render a fallback component */
 export default class ErrorBoundary extends React.Component<Props, State> {
     state: State;
     static getDerivedStateFromError(error: Error): {

package/components/Hamburger/DoubleCross.d.ts

@@ -1,3 +1,4 @@
 import { type Props } from "./Hamburger";
+/** A double-bar "cross" hamburger */
 declare const DoubleCross: (props: Props) => import("react/jsx-runtime").JSX.Element;
 export default DoubleCross;

package/components/Hamburger/DoubleFlip.d.ts

@@ -1,3 +1,4 @@
 import { type Props } from "./Hamburger";
+/** A double-bar "flip" hamburger */
 declare const DoubleFlip: (props: Props) => import("react/jsx-runtime").JSX.Element;
 export default DoubleFlip;

package/components/Hamburger/DoubleSpin.d.ts

@@ -1,3 +1,4 @@
 import { type Props } from "./Hamburger";
+/** A double-bar "spin" hamburger */
 declare const DoubleSpin: (props: Props) => import("react/jsx-runtime").JSX.Element;
 export default DoubleSpin;

package/components/Hamburger/Hamburger.d.ts

@@ -1,48 +1,40 @@
 import type { Style } from "../../types/common";
+/** Props shared by all the hamburgers */
 export type Props = {
     /**
-     * Size of the button in pixels
+     * Size of the button in pixels.
      * @default 36
      */
     size?: number;
-    /**
-     * Line height of the bars in pixels
-     */
+    /** Line height of the bars in pixels */
     lineHeight?: number;
     /**
-     * Direction the animation originates from;
-     * play around with this to see how it affects the animation because some of the animations are complicated
+     * Direction the animation originates from.
+     * Play around with this to see how it affects the animation because some of the animations are complicated.
      * @default "left"
      */
     direction?: "left" | "right";
-    /**
-     * Whether the button is open or closed
-     */
+    /** Whether the button is open or closed */
     open: boolean;
-    /**
-     * Function to call when the button is clicked, usually should toggle the `open` state
-     */
+    /** Function to call when the button is clicked, usually should toggle the `open` state */
     onClick?: () => void;
     /**
-     * Aria label for the button
+     * Aria label for the button.
      * @default "hamburger"
      */
     "aria-label"?: string;
     /**
-     * Duration of the animation in seconds
+     * Duration of the animation in seconds.
      * @default 0.25
      */
     duration?: number;
-    /**
-     * [Optional] additional class name to apply to the button
-     */
+    /** Additional class name to apply to the button */
     className?: string;
-    /**
-     * [Optional] additional styles to apply to the button
-     */
+    /** Additional styles to apply to the button */
     style?: Style;
     /**
-     * [Optional] round borders of the bars
+     * Round borders of the bars.
+     * @default false
      */
     rounded?: boolean;
 };
@@ -56,13 +48,16 @@ type InnerProps = Omit<Props, "variant" | "direction"> & {
     double?: boolean;
     openStyle: OpenStyle;
 };
+/** Default angles for rotate-style hamburger animations */
 export declare const defaultAngles: {
     readonly right: 45;
     readonly left: -45;
 };
+/** Alternate angles for flip-style hamburger animations */
 export declare const flipAngles: {
     readonly right: -135;
     readonly left: -225;
 };
+/** Base hamburger button used by the exported hamburger variants */
 declare const Hamburger: (props: InnerProps) => import("react/jsx-runtime").JSX.Element;
 export default Hamburger;

package/components/Hamburger/TripleFade.d.ts

@@ -1,3 +1,4 @@
 import { type Props } from "./Hamburger";
+/** A three-bar hamburger that fades the middle bar */
 declare const TripleFade: (props: Props) => import("react/jsx-runtime").JSX.Element;
 export default TripleFade;

package/components/Hamburger/TripleFlip.d.ts

@@ -1,3 +1,4 @@
 import { type Props } from "./Hamburger";
+/** A three-bar "flip" hamburger */
 declare const TripleFlip: (props: Props) => import("react/jsx-runtime").JSX.Element;
 export default TripleFlip;

package/components/Hamburger/TriplePrestige.d.ts

@@ -1,3 +1,4 @@
 import { type Props } from "./Hamburger";
+/** The default hamburger */
 declare const TriplePrestige: (props: Props) => import("react/jsx-runtime").JSX.Element;
 export default TriplePrestige;

package/components/Hamburger/TripleSpin.d.ts

@@ -1,3 +1,4 @@
 import { type Props } from "./Hamburger";
+/** A three-bar "spin" hamburger */
 declare const TripleSpin: (props: Props) => import("react/jsx-runtime").JSX.Element;
 export default TripleSpin;

package/components/Icon/Icon.d.ts

@@ -2,16 +2,19 @@ import React from "react";
 import type { SizeToken } from "../../types/common";
 import ui from "../ui";
 import type { IconType } from "../../types/icon";
+/** Props for `Icon` */
 export type Props = Omit<React.ComponentProps<typeof ui.svg>, "children" | "viewBox"> & {
-    /**
-     * Icon type to render (import from `components/Icon/icons`)
-     */
+    /** Icon type to render (import from `components/Icon/icons`) */
     icon: IconType;
     /**
-     * Size of the icon; will control both width and height
+     * Size of the icon; will control both width and height.
      * @default "s"
      */
     size?: SizeToken;
 };
+/**
+ * Render from a selected set of defined icon paths.
+ * Icons can be imported from `/icons`.
+ */
 declare const Icon: React.ForwardRefExoticComponent<Omit<Props, "ref"> & React.RefAttributes<SVGSVGElement>>;
 export default Icon;

package/components/Input/IconInput.d.ts

@@ -2,18 +2,13 @@ import React from "react";
 import { Props as InputProps } from "./Input";
 import { type BoxProps } from "../Box/Box";
 type IconInputProps = Omit<BoxProps, "children"> & {
-    /**
-     * [Optional] Icon to display at the start of the input
-     */
+    /** Icon to display at the start of the input */
     startIcon?: React.ReactNode;
-    /**
-     * [Optional] Icon to display at the end of the input
-     */
+    /** Icon to display at the end of the input */
     endIcon?: React.ReactNode;
-    /**
-     * [Optional] Props to pass directly to the input element
-     */
+    /** Props to pass directly to the input element */
     inputProps?: InputProps;
 };
+/** An input wrapper with optional icons */
 declare const IconInput: React.ForwardRefExoticComponent<Omit<IconInputProps, "ref"> & React.RefAttributes<HTMLDivElement>>;
 export default IconInput;

package/components/Input/Input.d.ts

@@ -1,7 +1,9 @@
 import React from "react";
 import ui from "../ui";
+/** Props for `Input` */
 export type Props = React.ComponentProps<typeof ui.input>;
-declare const Input: React.ForwardRefExoticComponent<Omit<Omit<React.ClassAttributes<HTMLInputElement> & React.InputHTMLAttributes<HTMLInputElement> & {
+/** A styled `input` component */
+declare const Input: React.ForwardRefExoticComponent<Omit<Omit<React.DetailedHTMLProps<React.InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "ref"> & {
     vfx?: import("../../types/common").Vfx;
-}, "ref"> & React.RefAttributes<HTMLInputElement>, "ref"> & React.RefAttributes<HTMLInputElement>>;
+} & React.RefAttributes<HTMLInputElement>, "ref"> & React.RefAttributes<HTMLInputElement>>;
 export default Input;

package/components/Input/TextArea.d.ts

@@ -1,5 +1,6 @@
 import React from "react";
-declare const TextArea: React.ForwardRefExoticComponent<Omit<Omit<React.ClassAttributes<HTMLTextAreaElement> & React.TextareaHTMLAttributes<HTMLTextAreaElement> & {
+/** A styled `textarea` component */
+declare const TextArea: React.ForwardRefExoticComponent<Omit<Omit<React.DetailedHTMLProps<React.TextareaHTMLAttributes<HTMLTextAreaElement>, HTMLTextAreaElement>, "ref"> & {
     vfx?: import("../../types/common").Vfx;
-}, "ref"> & React.RefAttributes<HTMLTextAreaElement>, "ref"> & React.RefAttributes<HTMLTextAreaElement>>;
+} & React.RefAttributes<HTMLTextAreaElement>, "ref"> & React.RefAttributes<HTMLTextAreaElement>>;
 export default TextArea;

package/components/Layer/Layer.d.ts

@@ -1,25 +1,24 @@
 import React from "react";
 import { type BoxProps } from "../Box/Box";
 type Props = Omit<BoxProps, "children"> & {
-    /**
-     * Callback that fires when the user clicks outside the layer
-     */
+    /** Callback that fires when the user clicks outside the layer */
     onClose?: () => void;
     /**
      * The child of the layer.
-     * IMPORTANT: the child must be able to accept a ref
+     * IMPORTANT: the child must be able to accept a ref.
      */
     children: React.ReactElement<any>;
     /**
-     * [Optional] Whether to return focus to the element that triggered the layer
+     * Whether to return focus to the element that triggered the layer.
      * @default false
      */
     returnFocusOnEscape?: boolean;
     /**
-     * [Optional] disable the scroll lock behavior of the layer
+     * Disable the scroll lock behavior of the layer.
      * @default false
      */
     disableScrollLock?: boolean;
 };
+/** A focus-trapped backdrop that closes on click outside */
 declare const Layer: React.ForwardRefExoticComponent<Omit<Props, "ref"> & React.RefAttributes<HTMLDivElement>>;
 export default Layer;