@lukeashford/aurelius 2.4.0 → 2.6.0

package/README.md

@@ -108,6 +108,8 @@ export default createAureliusESLintConfig({
 
 ### 4. Update package.json scripts
 
+Add a lint script and wire it into your workflow:
+
 ```json
 {
   "scripts": {
@@ -118,6 +120,9 @@ export default createAureliusESLintConfig({
 }
 ```
 
+If your project already has CI (or you're asked to add one), include `npm run lint` in that
+pipeline so lint failures block merges.
+
 ### 5. Use components
 
 ```tsx

package/dist/index.d.mts

@@ -19,37 +19,25 @@ declare const Input: React.ForwardRefExoticComponent<InputProps & React.RefAttri
 
 type CardVariant = 'default' | 'elevated' | 'outlined' | 'ghost' | 'featured';
 interface CardProps extends React.HTMLAttributes<HTMLDivElement> {
-    /** Visual style variant */
     variant?: CardVariant;
-    /** Enables hover effects and cursor pointer */
     interactive?: boolean;
-    /** Shows selected state with checkmark */
     selected?: boolean;
-    /** Remove default padding (useful with compound components) */
     noPadding?: boolean;
 }
 interface CardHeaderProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'title'> {
-    /** Card title */
     title?: React.ReactNode;
-    /** Subtitle or description */
     subtitle?: React.ReactNode;
-    /** Action elements (buttons, icons, etc.) */
     action?: React.ReactNode;
 }
 interface CardBodyProps extends React.HTMLAttributes<HTMLDivElement> {
 }
 interface CardFooterProps extends React.HTMLAttributes<HTMLDivElement> {
-    /** Align content */
     align?: 'start' | 'center' | 'end' | 'between';
 }
 interface CardMediaProps extends React.HTMLAttributes<HTMLDivElement> {
-    /** Image source */
     src?: string;
-    /** Alt text for image */
     alt?: string;
-    /** Aspect ratio */
     aspect?: 'video' | 'square' | 'wide';
-    /** Position in card */
     position?: 'top' | 'bottom';
 }
 declare const Card: React.ForwardRefExoticComponent<CardProps & React.RefAttributes<HTMLDivElement>> & {
@@ -61,7 +49,6 @@ declare const Card: React.ForwardRefExoticComponent<CardProps & React.RefAttribu
 
 type ContainerSize = 'sm' | 'md' | 'lg' | 'xl' | 'fluid' | 'responsive';
 interface ContainerProps extends React.HTMLAttributes<HTMLDivElement> {
-    /** Container size variant */
     size?: ContainerSize;
 }
 declare const Container: React.ForwardRefExoticComponent<ContainerProps & React.RefAttributes<HTMLDivElement>>;
@@ -70,15 +57,10 @@ type RowGutter = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 8 | 10 | 12;
 type RowJustify = 'start' | 'center' | 'end' | 'between' | 'around' | 'evenly';
 type RowAlign = 'start' | 'center' | 'end' | 'stretch' | 'baseline';
 interface RowProps extends React.HTMLAttributes<HTMLDivElement> {
-    /** Gap between columns (both directions). Use gutterX/gutterY for independent control. */
     gutter?: RowGutter;
-    /** Horizontal gap between columns */
     gutterX?: RowGutter;
-    /** Vertical gap between rows */
     gutterY?: RowGutter;
-    /** Horizontal alignment of columns */
     justify?: RowJustify;
-    /** Vertical alignment of columns */
     align?: RowAlign;
 }
 declare const Row: React.ForwardRefExoticComponent<RowProps & React.RefAttributes<HTMLDivElement>>;
@@ -86,36 +68,17 @@ declare const Row: React.ForwardRefExoticComponent<RowProps & React.RefAttribute
 type ColSpan = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 'auto' | 'full';
 type ColOffset = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11;
 type ColOrder = 'first' | 'last' | 'none' | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
-/** Responsive prop object for breakpoint-specific values */
 interface ResponsiveValue<T> {
-    /** Base value (mobile-first) */
     base?: T;
-    /** Value at sm breakpoint (640px+) */
     sm?: T;
-    /** Value at md breakpoint (768px+) */
     md?: T;
-    /** Value at lg breakpoint (1024px+) */
     lg?: T;
-    /** Value at xl breakpoint (1280px+) */
     xl?: T;
-    /** Value at 2xl breakpoint (1536px+) */
     '2xl'?: T;
 }
 interface ColProps extends React.HTMLAttributes<HTMLDivElement> {
-    /**
-     * Column span (1-12), 'auto' for content-based width, or 'full' for full row width.
-     * Can be a single value or responsive object: { base: 12, md: 6, lg: 4 }
-     */
     span?: ColSpan | ResponsiveValue<ColSpan>;
-    /**
-     * Column offset (0-11) - shifts column to the right.
-     * Can be a single value or responsive object.
-     */
     offset?: ColOffset | ResponsiveValue<ColOffset>;
-    /**
-     * Column order for reordering.
-     * Can be a single value or responsive object.
-     */
     order?: ColOrder | ResponsiveValue<ColOrder>;
 }
 declare const Col: React.ForwardRefExoticComponent<ColProps & React.RefAttributes<HTMLDivElement>>;
@@ -125,17 +88,11 @@ type StackAlign = 'start' | 'center' | 'end' | 'stretch' | 'baseline';
 type StackJustify = 'start' | 'center' | 'end' | 'between' | 'around' | 'evenly';
 type StackGap = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 8 | 10 | 12;
 interface StackProps extends React.HTMLAttributes<HTMLDivElement> {
-    /** Stack direction */
     direction?: StackDirection;
-    /** Alignment of items on the cross axis */
     align?: StackAlign;
-    /** Justification of items on the main axis */
     justify?: StackJustify;
-    /** Gap between items */
     gap?: StackGap;
-    /** Whether items should wrap */
     wrap?: boolean;
-    /** Render as a different element */
     as?: 'div' | 'section' | 'article' | 'nav' | 'aside' | 'header' | 'footer' | 'main';
 }
 declare const Stack: React.ForwardRefExoticComponent<StackProps & React.RefAttributes<HTMLDivElement>>;
@@ -143,13 +100,9 @@ declare const Stack: React.ForwardRefExoticComponent<StackProps & React.RefAttri
 type DividerOrientation = 'horizontal' | 'vertical';
 type DividerVariant = 'solid' | 'dashed' | 'dotted';
 interface DividerProps extends React.HTMLAttributes<HTMLHRElement> {
-    /** Orientation of the divider */
     orientation?: DividerOrientation;
-    /** Visual style variant */
     variant?: DividerVariant;
-    /** Optional label to show in the center */
     label?: React.ReactNode;
-    /** Color variant */
     color?: 'default' | 'gold' | 'muted';
 }
 declare const Divider: React.ForwardRefExoticComponent<DividerProps & React.RefAttributes<HTMLHRElement>>;
@@ -181,7 +134,6 @@ interface TooltipProps {
 declare const Tooltip: React.FC<TooltipProps>;
 
 interface TableProps extends React.TableHTMLAttributes<HTMLTableElement> {
-    /** Make the table horizontally scrollable */
     responsive?: boolean;
 }
 declare const Table: React.ForwardRefExoticComponent<TableProps & React.RefAttributes<HTMLTableElement>>;
@@ -195,16 +147,12 @@ interface TableFooterProps extends React.HTMLAttributes<HTMLTableSectionElement>
 }
 declare const TableFooter: React.ForwardRefExoticComponent<TableFooterProps & React.RefAttributes<HTMLTableSectionElement>>;
 interface TableRowProps extends React.HTMLAttributes<HTMLTableRowElement> {
-    /** Highlight row on hover */
     hoverable?: boolean;
-    /** Show selected state */
     selected?: boolean;
 }
 declare const TableRow: React.ForwardRefExoticComponent<TableRowProps & React.RefAttributes<HTMLTableRowElement>>;
 interface TableHeadProps extends React.ThHTMLAttributes<HTMLTableCellElement> {
-    /** Enable sorting indicator */
     sortable?: boolean;
-    /** Current sort direction */
     sortDirection?: 'asc' | 'desc' | null;
 }
 declare const TableHead: React.ForwardRefExoticComponent<TableHeadProps & React.RefAttributes<HTMLTableCellElement>>;
@@ -216,29 +164,20 @@ interface TableCaptionProps extends React.HTMLAttributes<HTMLTableCaptionElement
 declare const TableCaption: React.ForwardRefExoticComponent<TableCaptionProps & React.RefAttributes<HTMLTableCaptionElement>>;
 
 interface ListProps extends React.HTMLAttributes<HTMLUListElement> {
-    /** Visual style variant */
     variant?: 'default' | 'bordered' | 'divided';
-    /** Ordered list (numbered) */
     ordered?: boolean;
 }
 declare const List: React.ForwardRefExoticComponent<ListProps & React.RefAttributes<HTMLUListElement>>;
 interface ListItemProps extends React.LiHTMLAttributes<HTMLLIElement> {
-    /** Icon or avatar on the left */
     leading?: React.ReactNode;
-    /** Action element on the right */
     trailing?: React.ReactNode;
-    /** Make the item interactive (clickable) */
     interactive?: boolean;
-    /** Selected state */
     selected?: boolean;
-    /** Disabled state */
     disabled?: boolean;
 }
 declare const ListItem: React.ForwardRefExoticComponent<ListItemProps & React.RefAttributes<HTMLLIElement>>;
 interface ListItemTextProps extends React.HTMLAttributes<HTMLDivElement> {
-    /** Primary text */
     primary: React.ReactNode;
-    /** Secondary text */
     secondary?: React.ReactNode;
 }
 declare const ListItemText: React.ForwardRefExoticComponent<ListItemTextProps & React.RefAttributes<HTMLDivElement>>;
@@ -290,27 +229,16 @@ interface SwitchProps extends Omit<React.ButtonHTMLAttributes<HTMLButtonElement>
 declare const Switch: React.ForwardRefExoticComponent<SwitchProps & React.RefAttributes<HTMLButtonElement>>;
 
 interface SliderProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'onChange'> {
-    /** Current value */
     value?: number;
-    /** Default value for uncontrolled mode */
     defaultValue?: number;
-    /** Minimum value */
     min?: number;
-    /** Maximum value */
     max?: number;
-    /** Step increment */
     step?: number;
-    /** Callback when value changes */
     onChange?: (value: number) => void;
-    /** Callback when dragging ends */
     onChangeEnd?: (value: number) => void;
-    /** Whether the slider is disabled */
     disabled?: boolean;
-    /** Show value tooltip while dragging */
     showTooltip?: boolean;
-    /** Format the displayed value */
     formatValue?: (value: number) => string;
-    /** Size variant */
     size?: 'sm' | 'md' | 'lg';
 }
 declare const Slider: React.ForwardRefExoticComponent<SliderProps & React.RefAttributes<HTMLDivElement>>;
@@ -353,19 +281,12 @@ declare const Skeleton: React.ForwardRefExoticComponent<SkeletonProps & React.Re
 type ProgressSize = 'sm' | 'md' | 'lg';
 type ProgressVariant = 'default' | 'success' | 'warning' | 'error';
 interface ProgressProps extends React.HTMLAttributes<HTMLDivElement> {
-    /** Current value (0-100) */
     value?: number;
-    /** Maximum value (defaults to 100) */
     max?: number;
-    /** Size variant */
     size?: ProgressSize;
-    /** Color variant */
     variant?: ProgressVariant;
-    /** Whether to show the value label */
     showValue?: boolean;
-    /** Custom label format function */
     formatValue?: (value: number, max: number) => string;
-    /** Whether the progress is indeterminate */
     indeterminate?: boolean;
 }
 declare const Progress: React.ForwardRefExoticComponent<ProgressProps & React.RefAttributes<HTMLDivElement>>;
@@ -386,9 +307,7 @@ declare function useToast(): {
 };
 interface ToastProviderProps {
     children: React.ReactNode;
-    /** Position of toasts on screen */
     position?: ToastPosition;
-    /** Default duration for toasts (ms) */
     defaultDuration?: number;
 }
 declare const ToastProvider: React.FC<ToastProviderProps>;
@@ -407,19 +326,12 @@ declare const Modal: {
 
 type DrawerPosition = 'left' | 'right' | 'top' | 'bottom';
 interface DrawerProps {
-    /** Whether the drawer is open */
     isOpen: boolean;
-    /** Callback when the drawer should close */
     onClose: () => void;
-    /** Position of the drawer */
     position?: DrawerPosition;
-    /** Title for the drawer header */
     title?: string;
-    /** Width/height of the drawer (depending on position) */
     size?: 'sm' | 'md' | 'lg' | 'xl' | 'full';
-    /** Content */
     children: React.ReactNode;
-    /** Additional class name for the drawer panel */
     className?: string;
 }
 declare const Drawer: React.FC<DrawerProps>;
@@ -444,47 +356,29 @@ interface PopoverProps {
 declare const Popover: React.FC<PopoverProps>;
 
 interface ConfirmDialogProps extends Omit<ModalProps, 'children'> {
-    /** Description text */
     description?: React.ReactNode;
-    /** Text for the confirm button */
     confirmText?: string;
-    /** Text for the cancel button */
     cancelText?: string;
-    /** Callback when confirmed */
     onConfirm: () => void | Promise<void>;
-    /** Callback when cancelled */
     onCancel?: () => void;
-    /** Variant of the confirm button */
     confirmVariant?: 'primary' | 'important' | 'danger';
-    /** Whether the confirm action is loading */
     isLoading?: boolean;
 }
 declare const ConfirmDialog: React.FC<ConfirmDialogProps>;
 interface AlertDialogProps extends Omit<ModalProps, 'children'> {
-    /** Description text */
     description?: React.ReactNode;
-    /** Text for the acknowledge button */
     acknowledgeText?: string;
-    /** Variant based on alert type */
     variant?: 'default' | 'warning' | 'error';
 }
 declare const AlertDialog: React.FC<AlertDialogProps>;
 interface PromptDialogProps extends Omit<ModalProps, 'children'> {
-    /** Description text */
     description?: React.ReactNode;
-    /** Placeholder for the input */
     placeholder?: string;
-    /** Default value for the input */
     defaultValue?: string;
-    /** Text for the submit button */
     submitText?: string;
-    /** Text for the cancel button */
     cancelText?: string;
-    /** Callback with the input value when submitted */
     onSubmit: (value: string) => void | Promise<void>;
-    /** Callback when cancelled */
     onCancel?: () => void;
-    /** Whether the submit action is loading */
     isLoading?: boolean;
 }
 declare const PromptDialog: React.FC<PromptDialogProps>;
@@ -541,28 +435,21 @@ declare const AccordionContent: React.ForwardRefExoticComponent<AccordionContent
 
 interface MenuProps {
     children: React.ReactNode;
-    /** Controlled open state */
     open?: boolean;
-    /** Callback when open state changes */
     onOpenChange?: (open: boolean) => void;
 }
 declare const Menu: React.FC<MenuProps>;
 interface MenuTriggerProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
-    /** Render as a different element (using render props) */
     asChild?: boolean;
 }
 declare const MenuTrigger: React.ForwardRefExoticComponent<MenuTriggerProps & React.RefAttributes<HTMLButtonElement>>;
 interface MenuContentProps extends React.HTMLAttributes<HTMLDivElement> {
-    /** Alignment of the menu */
     align?: 'start' | 'center' | 'end';
-    /** Side of the trigger to render on */
     side?: 'top' | 'bottom';
 }
 declare const MenuContent: React.ForwardRefExoticComponent<MenuContentProps & React.RefAttributes<HTMLDivElement>>;
 interface MenuItemProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
-    /** Icon to display before the label */
     icon?: React.ReactNode;
-    /** Show destructive styling */
     destructive?: boolean;
 }
 declare const MenuItem: React.ForwardRefExoticComponent<MenuItemProps & React.RefAttributes<HTMLButtonElement>>;
@@ -570,9 +457,7 @@ declare const MenuSeparator: React.ForwardRefExoticComponent<React.HTMLAttribute
 declare const MenuLabel: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;
 
 interface NavbarProps extends React.HTMLAttributes<HTMLElement> {
-    /** Fixed to top of viewport */
     fixed?: boolean;
-    /** Add border at bottom */
     bordered?: boolean;
 }
 declare const Navbar: React.ForwardRefExoticComponent<NavbarProps & React.RefAttributes<HTMLElement>>;
@@ -580,29 +465,24 @@ interface NavbarBrandProps extends React.HTMLAttributes<HTMLDivElement> {
 }
 declare const NavbarBrand: React.ForwardRefExoticComponent<NavbarBrandProps & React.RefAttributes<HTMLDivElement>>;
 interface NavbarContentProps extends React.HTMLAttributes<HTMLDivElement> {
-    /** Position of the content */
     position?: 'start' | 'center' | 'end';
 }
 declare const NavbarContent: React.ForwardRefExoticComponent<NavbarContentProps & React.RefAttributes<HTMLDivElement>>;
 interface NavbarItemProps extends React.HTMLAttributes<HTMLDivElement> {
-    /** Active state */
     active?: boolean;
 }
 declare const NavbarItem: React.ForwardRefExoticComponent<NavbarItemProps & React.RefAttributes<HTMLDivElement>>;
 interface NavbarLinkProps extends React.AnchorHTMLAttributes<HTMLAnchorElement> {
-    /** Active state */
     active?: boolean;
 }
 declare const NavbarLink: React.ForwardRefExoticComponent<NavbarLinkProps & React.RefAttributes<HTMLAnchorElement>>;
 declare const NavbarDivider: React.ForwardRefExoticComponent<React.HTMLAttributes<HTMLDivElement> & React.RefAttributes<HTMLDivElement>>;
 
 interface BreadcrumbProps extends React.HTMLAttributes<HTMLElement> {
-    /** Custom separator element */
     separator?: React.ReactNode;
 }
 declare const Breadcrumb: React.ForwardRefExoticComponent<BreadcrumbProps & React.RefAttributes<HTMLElement>>;
 interface BreadcrumbItemProps extends React.HTMLAttributes<HTMLSpanElement> {
-    /** Whether this is the current page */
     current?: boolean;
 }
 declare const BreadcrumbItem: React.ForwardRefExoticComponent<BreadcrumbItemProps & React.RefAttributes<HTMLSpanElement>>;
@@ -611,15 +491,10 @@ interface BreadcrumbLinkProps extends React.AnchorHTMLAttributes<HTMLAnchorEleme
 declare const BreadcrumbLink: React.ForwardRefExoticComponent<BreadcrumbLinkProps & React.RefAttributes<HTMLAnchorElement>>;
 
 interface PaginationProps extends React.HTMLAttributes<HTMLElement> {
-    /** Current page (1-indexed) */
     page: number;
-    /** Total number of pages */
     totalPages: number;
-    /** Callback when page changes */
     onPageChange: (page: number) => void;
-    /** Number of sibling pages to show */
     siblingCount?: number;
-    /** Show first/last page buttons */
     showEdges?: boolean;
 }
 declare const Pagination: React.ForwardRefExoticComponent<PaginationProps & React.RefAttributes<HTMLElement>>;
@@ -630,7 +505,9 @@ interface Step {
     label: string;
 }
 interface StepperProps extends React.HTMLAttributes<HTMLDivElement> {
+    /** Array of steps. Each requires: id (string | number), label (string). */
     steps: Step[];
+    /** ID of the current step (must match a step.id from the steps array). */
     currentStep: string | number;
     status?: StepStatus;
 }
@@ -649,9 +526,10 @@ interface ChatHistoryItem extends Omit<MessageProps, 'variant' | 'children'> {
     variant?: MessageVariant;
 }
 interface ChatHistoryProps extends React.HTMLAttributes<HTMLDivElement> {
+    /** Array of chat messages. Each item requires: content (string), variant ('user' | 'assistant'). Optional: id, isStreaming. */
     messages: ChatHistoryItem[];
 }
-declare const ChatHistory: React.ForwardRefExoticComponent<ChatHistoryProps & React.RefAttributes<HTMLDivElement>>;
+declare const ChatHistory: React.FC<ChatHistoryProps>;
 
 interface StreamingCursorProps extends React.HTMLAttributes<HTMLSpanElement> {
     variant?: 'block' | 'line' | 'underscore';