@boostdev/design-system-components 1.2.7 → 2.0.0

package/dist/client.d.cts

@@ -196,20 +196,48 @@ interface TypographyProps extends WithClassName, HTMLAttributes<HTMLElement> {
 }
 declare function Typography({ variant, component, children, className, ...rest }: TypographyProps): react_jsx_runtime.JSX.Element;
 
+/**
+ * Props for the Button component.
+ *
+ * Button spreads all unrecognised props onto the underlying element —
+ * `<button>` when `href` is absent, `<a>` when `href` is provided —
+ * so every standard HTML attribute for that element is accepted.
+ *
+ * Notably, this means `type`, `form`, `name`, `value`, `autoFocus`, all
+ * `aria-*`, all `data-*`, and every DOM event handler are valid props.
+ */
 interface ButtonProps extends WithClassName, ButtonHTMLAttributes<HTMLButtonElement | HTMLAnchorElement> {
+    /** When provided, the button renders as an `<a>` element pointing to this URL. */
     href?: string;
+    /** Visual style. `'default'` is filled; `'outline'` is transparent with a border. `'ghost'` is a deprecated alias for `'outline'`. */
     variant?: 'default' | 'outline' | /** @deprecated Use "outline" instead */ 'ghost';
+    /**
+     * Button behaviour within a form. Defaults to `'button'` (no form submission).
+     * Set to `'submit'` to trigger the parent `<form>`'s submit handler on click or Enter;
+     * `'reset'` to reset the form. Ignored when rendering as `<a>` (i.e. when `href` is set).
+     */
     type?: 'button' | 'submit' | 'reset';
+    /** Control height and padding. Defaults to `'medium'`. */
     size?: 'small' | 'medium' | 'large';
+    /** Icon rendered before the label. */
     iconStart?: ReactNode;
+    /** Icon rendered after the label. */
     iconEnd?: ReactNode;
+    /** Label content. Required unless `aria-label` is set (icon-only button). */
     children?: ReactNode;
+    /** When true, blocks interaction, sets `aria-disabled`, and removes the element from the tab order. */
     disabled?: boolean;
+    /** Adds a pulsing animation for call-to-action emphasis. Respects `prefers-reduced-motion`. */
     hasPulse?: boolean;
+    /** Click handler. Typed as `HTMLElement` because the root may be `<button>` or `<a>`. */
     onClick?: MouseEventHandler<HTMLElement>;
+    /** Anchor target (only applied when rendered as `<a>`). */
     target?: string;
+    /** Anchor rel (only applied when rendered as `<a>`). */
     rel?: string;
+    /** Accessible label. Required for icon-only buttons (no text children). */
     'aria-label'?: string;
+    /** ID(s) of element(s) that describe the button (e.g. a tooltip or helper text). */
     'aria-describedby'?: string;
 }
 declare function Button({ children, className, variant, type, iconStart, iconEnd, size, hasPulse, href, target, rel, disabled, onClick, ...rest }: Readonly<ButtonProps>): react_jsx_runtime.JSX.Element;
@@ -431,10 +459,18 @@ interface TextareaProps extends WithClassName, TextareaHTMLAttributes<HTMLTextAr
 }
 declare function Textarea({ label, name, error, hint, className, required, ...props }: Readonly<TextareaProps>): react_jsx_runtime.JSX.Element;
 
-interface ButtonGroupProps extends WithClassName, HTMLAttributes<HTMLDivElement> {
+interface ButtonContainerProps extends WithClassName, HTMLAttributes<HTMLDivElement> {
     variant?: 'flow' | 'card' | 'modal' | 'content';
 }
-declare function ButtonGroup({ children, className, variant, ...rest }: ButtonGroupProps): react_jsx_runtime.JSX.Element;
+declare function ButtonContainer({ children, className, variant, ...rest }: ButtonContainerProps): react_jsx_runtime.JSX.Element;
+/**
+ * @deprecated Use `ButtonContainer` instead. `ButtonGroup` will be removed in the next major version.
+ */
+declare const ButtonGroup: typeof ButtonContainer;
+/**
+ * @deprecated Use `ButtonContainerProps` instead. `ButtonGroupProps` will be removed in the next major version.
+ */
+type ButtonGroupProps = ButtonContainerProps;
 
 type CardOwnProps = WithClassName & {
     variant?: 'default' | 'elevated' | 'outlined';
@@ -460,4 +496,4 @@ interface IconWrapperProps extends WithClassName, HTMLAttributes<HTMLDivElement>
 }
 declare function IconWrapper({ children, className, ...rest }: IconWrapperProps): react_jsx_runtime.JSX.Element;
 
-export { Accordion, type AccordionItem, Alert, Avatar, Badge, Breadcrumb, type BreadcrumbItem, Button, ButtonGroup, type ButtonGroupProps, type ButtonProps, Calendar, Card, Carousel, Checkbox, CheckboxGroup, type CheckboxGroupProps, Collapsible, type CollapsibleProps, Combobox, type ComboboxOption, Command, type CommandItem, type DescriptionItem, DescriptionList, Dialog, Drawer, DropdownMenu, type DropdownMenuItem, FileInput, FormInput, IconWrapper, type IconWrapperProps, Link, Loading, NotificationBanner, NumberInput, Pagination, Popover, Progress, ProgressCircle, Radio, RadioGroup, type RadioGroupProps, Rating, SectionHeader, SegmentedControl, type SegmentedControlProps, Select, type SelectOption, Separator, Skeleton, SkipLink, Slider, Switch, type TabItem, Table, type TableColumn, Tabs, Textarea, ToastProvider, Tooltip, Typography, type WithClassName, useToast };
+export { Accordion, type AccordionItem, Alert, Avatar, Badge, Breadcrumb, type BreadcrumbItem, Button, ButtonContainer, type ButtonContainerProps, ButtonGroup, type ButtonGroupProps, type ButtonProps, Calendar, Card, Carousel, Checkbox, CheckboxGroup, type CheckboxGroupProps, Collapsible, type CollapsibleProps, Combobox, type ComboboxOption, Command, type CommandItem, type DescriptionItem, DescriptionList, Dialog, Drawer, DropdownMenu, type DropdownMenuItem, FileInput, FormInput, IconWrapper, type IconWrapperProps, Link, Loading, NotificationBanner, NumberInput, Pagination, Popover, Progress, ProgressCircle, Radio, RadioGroup, type RadioGroupProps, Rating, SectionHeader, SegmentedControl, type SegmentedControlProps, Select, type SelectOption, Separator, Skeleton, SkipLink, Slider, Switch, type TabItem, Table, type TableColumn, Tabs, Textarea, ToastProvider, Tooltip, Typography, type WithClassName, useToast };

package/dist/client.d.ts

@@ -196,20 +196,48 @@ interface TypographyProps extends WithClassName, HTMLAttributes<HTMLElement> {
 }
 declare function Typography({ variant, component, children, className, ...rest }: TypographyProps): react_jsx_runtime.JSX.Element;
 
+/**
+ * Props for the Button component.
+ *
+ * Button spreads all unrecognised props onto the underlying element —
+ * `<button>` when `href` is absent, `<a>` when `href` is provided —
+ * so every standard HTML attribute for that element is accepted.
+ *
+ * Notably, this means `type`, `form`, `name`, `value`, `autoFocus`, all
+ * `aria-*`, all `data-*`, and every DOM event handler are valid props.
+ */
 interface ButtonProps extends WithClassName, ButtonHTMLAttributes<HTMLButtonElement | HTMLAnchorElement> {
+    /** When provided, the button renders as an `<a>` element pointing to this URL. */
     href?: string;
+    /** Visual style. `'default'` is filled; `'outline'` is transparent with a border. `'ghost'` is a deprecated alias for `'outline'`. */
     variant?: 'default' | 'outline' | /** @deprecated Use "outline" instead */ 'ghost';
+    /**
+     * Button behaviour within a form. Defaults to `'button'` (no form submission).
+     * Set to `'submit'` to trigger the parent `<form>`'s submit handler on click or Enter;
+     * `'reset'` to reset the form. Ignored when rendering as `<a>` (i.e. when `href` is set).
+     */
     type?: 'button' | 'submit' | 'reset';
+    /** Control height and padding. Defaults to `'medium'`. */
     size?: 'small' | 'medium' | 'large';
+    /** Icon rendered before the label. */
     iconStart?: ReactNode;
+    /** Icon rendered after the label. */
     iconEnd?: ReactNode;
+    /** Label content. Required unless `aria-label` is set (icon-only button). */
     children?: ReactNode;
+    /** When true, blocks interaction, sets `aria-disabled`, and removes the element from the tab order. */
     disabled?: boolean;
+    /** Adds a pulsing animation for call-to-action emphasis. Respects `prefers-reduced-motion`. */
     hasPulse?: boolean;
+    /** Click handler. Typed as `HTMLElement` because the root may be `<button>` or `<a>`. */
     onClick?: MouseEventHandler<HTMLElement>;
+    /** Anchor target (only applied when rendered as `<a>`). */
     target?: string;
+    /** Anchor rel (only applied when rendered as `<a>`). */
     rel?: string;
+    /** Accessible label. Required for icon-only buttons (no text children). */
     'aria-label'?: string;
+    /** ID(s) of element(s) that describe the button (e.g. a tooltip or helper text). */
     'aria-describedby'?: string;
 }
 declare function Button({ children, className, variant, type, iconStart, iconEnd, size, hasPulse, href, target, rel, disabled, onClick, ...rest }: Readonly<ButtonProps>): react_jsx_runtime.JSX.Element;
@@ -431,10 +459,18 @@ interface TextareaProps extends WithClassName, TextareaHTMLAttributes<HTMLTextAr
 }
 declare function Textarea({ label, name, error, hint, className, required, ...props }: Readonly<TextareaProps>): react_jsx_runtime.JSX.Element;
 
-interface ButtonGroupProps extends WithClassName, HTMLAttributes<HTMLDivElement> {
+interface ButtonContainerProps extends WithClassName, HTMLAttributes<HTMLDivElement> {
     variant?: 'flow' | 'card' | 'modal' | 'content';
 }
-declare function ButtonGroup({ children, className, variant, ...rest }: ButtonGroupProps): react_jsx_runtime.JSX.Element;
+declare function ButtonContainer({ children, className, variant, ...rest }: ButtonContainerProps): react_jsx_runtime.JSX.Element;
+/**
+ * @deprecated Use `ButtonContainer` instead. `ButtonGroup` will be removed in the next major version.
+ */
+declare const ButtonGroup: typeof ButtonContainer;
+/**
+ * @deprecated Use `ButtonContainerProps` instead. `ButtonGroupProps` will be removed in the next major version.
+ */
+type ButtonGroupProps = ButtonContainerProps;
 
 type CardOwnProps = WithClassName & {
     variant?: 'default' | 'elevated' | 'outlined';
@@ -460,4 +496,4 @@ interface IconWrapperProps extends WithClassName, HTMLAttributes<HTMLDivElement>
 }
 declare function IconWrapper({ children, className, ...rest }: IconWrapperProps): react_jsx_runtime.JSX.Element;
 
-export { Accordion, type AccordionItem, Alert, Avatar, Badge, Breadcrumb, type BreadcrumbItem, Button, ButtonGroup, type ButtonGroupProps, type ButtonProps, Calendar, Card, Carousel, Checkbox, CheckboxGroup, type CheckboxGroupProps, Collapsible, type CollapsibleProps, Combobox, type ComboboxOption, Command, type CommandItem, type DescriptionItem, DescriptionList, Dialog, Drawer, DropdownMenu, type DropdownMenuItem, FileInput, FormInput, IconWrapper, type IconWrapperProps, Link, Loading, NotificationBanner, NumberInput, Pagination, Popover, Progress, ProgressCircle, Radio, RadioGroup, type RadioGroupProps, Rating, SectionHeader, SegmentedControl, type SegmentedControlProps, Select, type SelectOption, Separator, Skeleton, SkipLink, Slider, Switch, type TabItem, Table, type TableColumn, Tabs, Textarea, ToastProvider, Tooltip, Typography, type WithClassName, useToast };
+export { Accordion, type AccordionItem, Alert, Avatar, Badge, Breadcrumb, type BreadcrumbItem, Button, ButtonContainer, type ButtonContainerProps, ButtonGroup, type ButtonGroupProps, type ButtonProps, Calendar, Card, Carousel, Checkbox, CheckboxGroup, type CheckboxGroupProps, Collapsible, type CollapsibleProps, Combobox, type ComboboxOption, Command, type CommandItem, type DescriptionItem, DescriptionList, Dialog, Drawer, DropdownMenu, type DropdownMenuItem, FileInput, FormInput, IconWrapper, type IconWrapperProps, Link, Loading, NotificationBanner, NumberInput, Pagination, Popover, Progress, ProgressCircle, Radio, RadioGroup, type RadioGroupProps, Rating, SectionHeader, SegmentedControl, type SegmentedControlProps, Select, type SelectOption, Separator, Skeleton, SkipLink, Slider, Switch, type TabItem, Table, type TableColumn, Tabs, Textarea, ToastProvider, Tooltip, Typography, type WithClassName, useToast };