@backstage/ui 0.14.0-next.0 → 0.14.0-next.2

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as react from 'react';
 import { ReactNode, CSSProperties, HTMLAttributes, ComponentPropsWithoutRef, ReactElement, ElementType, ComponentPropsWithRef, ComponentProps } from 'react';
-import { DisclosureProps, HeadingProps, DisclosurePanelProps, DisclosureGroupProps, ButtonProps as ButtonProps$1, DialogTriggerProps as DialogTriggerProps$1, ModalOverlayProps, TabsProps as TabsProps$1, TabListProps as TabListProps$1, TabProps as TabProps$1, TabPanelProps as TabPanelProps$1, LinkProps as LinkProps$1, CheckboxProps as CheckboxProps$1, RadioGroupProps as RadioGroupProps$1, RadioProps as RadioProps$1, TableProps as TableProps$1, TableHeaderProps as TableHeaderProps$1, TableBodyProps as TableBodyProps$1, ColumnProps as ColumnProps$1, RowProps as RowProps$1, CellProps as CellProps$1, TagListProps, TagGroupProps as TagGroupProps$1, TagProps as TagProps$1, TextFieldProps as TextFieldProps$1, TooltipProps as TooltipProps$1, TooltipTriggerComponentProps, MenuTriggerProps as MenuTriggerProps$1, SubmenuTriggerProps as SubmenuTriggerProps$1, PopoverProps as PopoverProps$1, MenuProps as MenuProps$1, ListBoxProps, MenuItemProps as MenuItemProps$1, ListBoxItemProps, MenuSectionProps as MenuSectionProps$1, SeparatorProps, SearchFieldProps as SearchFieldProps$1, GridListProps, GridListItemProps, SelectProps as SelectProps$1, SwitchProps as SwitchProps$1, ToggleButtonProps as ToggleButtonProps$1, ToggleButtonGroupProps as ToggleButtonGroupProps$1 } from 'react-aria-components';
+import { DisclosureProps, DisclosureGroupProps, DisclosurePanelProps, HeadingProps, ButtonProps as ButtonProps$1, ModalOverlayProps, DialogTriggerProps as DialogTriggerProps$1, TabProps as TabProps$1, TabListProps as TabListProps$1, TabPanelProps as TabPanelProps$1, TabsProps as TabsProps$1, LinkProps as LinkProps$1, CheckboxProps as CheckboxProps$1, CheckboxGroupProps as CheckboxGroupProps$1, RadioProps as RadioProps$1, RadioGroupProps as RadioGroupProps$1, SliderProps as SliderProps$1, CellProps as CellProps$1, ColumnProps as ColumnProps$1, RowProps as RowProps$1, TableProps as TableProps$1, TableBodyProps as TableBodyProps$1, TableHeaderProps as TableHeaderProps$1, TagProps as TagProps$1, TagListProps, TagGroupProps as TagGroupProps$1, TextFieldProps as TextFieldProps$1, TooltipProps as TooltipProps$1, TooltipTriggerComponentProps, PopoverProps as PopoverProps$1, MenuProps as MenuProps$1, ListBoxProps, MenuItemProps as MenuItemProps$1, ListBoxItemProps, MenuSectionProps as MenuSectionProps$1, SeparatorProps, MenuTriggerProps as MenuTriggerProps$1, SubmenuTriggerProps as SubmenuTriggerProps$1, SearchFieldProps as SearchFieldProps$1, GridListProps, GridListItemProps, SelectProps as SelectProps$1, SwitchProps as SwitchProps$1, ToggleButtonProps as ToggleButtonProps$1, ToggleButtonGroupProps as ToggleButtonGroupProps$1 } from 'react-aria-components';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { NavigateOptions } from 'react-router-dom';
 import { SortDescriptor as SortDescriptor$1 } from 'react-stately';
@@ -24,7 +24,11 @@ type JustifyContent = 'stretch' | 'start' | 'center' | 'end' | 'around' | 'betwe
 type AlignItems = 'stretch' | 'start' | 'center' | 'end';
 /** @public */
 type BorderRadius = 'none' | '2xs' | 'xs' | 'sm' | 'md' | 'lg' | 'xl' | '2xl';
-/** @public */
+/**
+ * Border variants available for UI utility props.
+ *
+ * @public
+ */
 type Border = 'none' | 'base' | 'error' | 'warning' | 'selected';
 /** @public */
 type Columns = '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' | '11' | '12' | 'auto';
@@ -59,20 +63,37 @@ type TextColors = 'primary' | 'secondary';
 type TextColorStatus = 'danger' | 'warning' | 'success' | 'info';
 /** @public */
 type TextWeights = 'regular' | 'bold';
-/** @public */
+/**
+ * Shared utility props supported by layout-oriented UI components.
+ *
+ * @public
+ */
 interface UtilityProps extends SpaceProps {
+    /** Aligns children on the cross axis in flex and grid layouts. */
     alignItems?: Responsive<AlignItems>;
+    /** Applies a semantic border variant. */
     border?: Responsive<Border>;
+    /** Applies a semantic border radius token. */
     borderRadius?: Responsive<BorderRadius>;
+    /** Sets the ending grid column line. */
     colEnd?: Responsive<Columns | 'auto'>;
+    /** Sets the number of grid columns to span. */
     colSpan?: Responsive<Columns | 'full'>;
+    /** Sets the starting grid column line. */
     colStart?: Responsive<Columns | 'auto'>;
+    /** Sets the number of columns for grid containers. */
     columns?: Responsive<Columns>;
+    /** Controls the CSS display value. */
     display?: Responsive<Display>;
+    /** Controls the direction of flex items. */
     flexDirection?: Responsive<FlexDirection>;
+    /** Controls how flex items wrap. */
     flexWrap?: Responsive<FlexWrap>;
+    /** Sets spacing between children in flex and grid layouts. */
     gap?: Responsive<Space>;
+    /** Aligns children on the main axis in flex and grid layouts. */
     justifyContent?: Responsive<JustifyContent>;
+    /** Sets the number of grid rows to span. */
     rowSpan?: Responsive<Columns | 'full'>;
 }
 /**
@@ -126,7 +147,11 @@ type BoxUtilityProps = {
 interface BoxProps extends SpaceProps, BoxOwnProps, BoxUtilityProps, Omit<React.HTMLAttributes<HTMLDivElement>, 'children'> {
 }
 
-/** @public */
+/**
+ * A general-purpose layout primitive that can render as any HTML element and supports spacing, sizing, and background props.
+ *
+ * @public
+ */
 declare const Box: react.ForwardRefExoticComponent<BoxProps & react.RefAttributes<HTMLDivElement>>;
 
 /**
@@ -248,7 +273,11 @@ interface FlexProps extends SpaceProps, FlexOwnProps, Omit<React.HTMLAttributes<
     direction?: Responsive<'row' | 'column' | 'row-reverse' | 'column-reverse'>;
 }
 
-/** @public */
+/**
+ * A flexbox layout container with props for controlling gap, alignment, justification, and direction.
+ *
+ * @public
+ */
 declare const Flex: react.ForwardRefExoticComponent<FlexProps & react.RefAttributes<HTMLDivElement>>;
 
 /**
@@ -290,7 +319,11 @@ interface ContainerProps extends ContainerOwnProps, Omit<React.ComponentPropsWit
     pt?: SpaceProps['pt'];
 }
 
-/** @public */
+/**
+ * A centered layout wrapper that constrains content to a maximum width and provides consistent page-level padding.
+ *
+ * @public
+ */
 declare const Container: react.ForwardRefExoticComponent<ContainerProps & react.RefAttributes<HTMLDivElement>>;
 
 /**
@@ -415,13 +448,29 @@ type AccordionGroupOwnProps = {
 interface AccordionGroupProps extends Omit<DisclosureGroupProps, 'className'>, AccordionGroupOwnProps {
 }
 
-/** @public */
+/**
+ * A collapsible section that reveals or hides its content when the trigger is activated.
+ *
+ * @public
+ */
 declare const Accordion: react.ForwardRefExoticComponent<AccordionProps & react.RefAttributes<HTMLDivElement>>;
-/** @public */
+/**
+ * The clickable heading that toggles the visibility of an accordion panel.
+ *
+ * @public
+ */
 declare const AccordionTrigger: react.ForwardRefExoticComponent<AccordionTriggerProps & react.RefAttributes<HTMLHeadingElement>>;
-/** @public */
+/**
+ * The content area of an accordion that is revealed when the trigger is activated.
+ *
+ * @public
+ */
 declare const AccordionPanel: react.ForwardRefExoticComponent<AccordionPanelProps & react.RefAttributes<HTMLDivElement>>;
-/** @public */
+/**
+ * A container that groups multiple Accordion items, optionally allowing several panels to be expanded at once.
+ *
+ * @public
+ */
 declare const AccordionGroup: react.ForwardRefExoticComponent<AccordionGroupProps & react.RefAttributes<HTMLDivElement>>;
 
 /**
@@ -631,7 +680,11 @@ type AvatarOwnProps = {
 interface AvatarProps extends Omit<React.ComponentPropsWithoutRef<'div'>, 'children' | 'className'>, AvatarOwnProps {
 }
 
-/** @public */
+/**
+ * Displays a user's profile image with an automatic fallback to their initials when the image fails to load.
+ *
+ * @public
+ */
 declare const Avatar: react.ForwardRefExoticComponent<AvatarProps & react.RefAttributes<HTMLDivElement>>;
 
 /**
@@ -661,6 +714,62 @@ declare const AvatarDefinition: {
     };
 };
 
+/**
+ * Own props for the Badge component.
+ *
+ * @public
+ */
+type BadgeOwnProps = {
+    /**
+     * The icon to display before the badge text.
+     */
+    icon?: React.ReactNode;
+    /**
+     * The size of the badge.
+     */
+    size?: 'small' | 'medium';
+    children?: React.ReactNode;
+    className?: string;
+};
+/**
+ * Props for the Badge component.
+ *
+ * @public
+ */
+interface BadgeProps extends BadgeOwnProps, Omit<React.HTMLAttributes<HTMLSpanElement>, keyof BadgeOwnProps> {
+}
+
+/**
+ * A non-interactive badge for labeling or categorizing content.
+ *
+ * @public
+ */
+declare const Badge: react.ForwardRefExoticComponent<BadgeProps & react.RefAttributes<HTMLSpanElement>>;
+
+/**
+ * Component definition for Badge
+ * @public
+ */
+declare const BadgeDefinition: {
+    readonly styles: {
+        readonly [key: string]: string;
+    };
+    readonly classNames: {
+        readonly root: "bui-Badge";
+        readonly icon: "bui-BadgeIcon";
+    };
+    readonly bg: "consumer";
+    readonly propDefs: {
+        readonly icon: {};
+        readonly size: {
+            readonly dataAttribute: true;
+            readonly default: "small";
+        };
+        readonly children: {};
+        readonly className: {};
+    };
+};
+
 /** @public */
 type ButtonOwnProps = {
     size?: Responsive<'small' | 'medium'>;
@@ -869,6 +978,7 @@ declare const CardDefinition: {
     readonly styles: {
         readonly [key: string]: string;
     };
+    readonly resolveHref: true;
     readonly classNames: {
         readonly root: "bui-Card";
         readonly trigger: "bui-CardTrigger";
@@ -987,15 +1097,35 @@ type DialogFooterOwnProps = {
 interface DialogFooterProps extends DialogFooterOwnProps, Omit<React.ComponentPropsWithoutRef<'div'>, keyof DialogFooterOwnProps> {
 }
 
-/** @public */
+/**
+ * A wrapper that connects a trigger element to a Dialog, controlling its open and close state.
+ *
+ * @public
+ */
 declare const DialogTrigger: (props: DialogTriggerProps) => react_jsx_runtime.JSX.Element;
-/** @public */
+/**
+ * A modal overlay that presents content requiring user interaction or acknowledgment, dismissible by clicking outside or pressing Escape.
+ *
+ * @public
+ */
 declare const Dialog: react.ForwardRefExoticComponent<DialogProps & react.RefAttributes<HTMLDivElement>>;
-/** @public */
+/**
+ * The header section of a Dialog, containing the title and a close button.
+ *
+ * @public
+ */
 declare const DialogHeader: react.ForwardRefExoticComponent<DialogHeaderProps & react.RefAttributes<HTMLDivElement>>;
-/** @public */
+/**
+ * The main scrollable content area of a Dialog.
+ *
+ * @public
+ */
 declare const DialogBody: react.ForwardRefExoticComponent<DialogBodyProps & react.RefAttributes<HTMLDivElement>>;
-/** @public */
+/**
+ * The footer section of a Dialog, typically used to place action buttons.
+ *
+ * @public
+ */
 declare const DialogFooter: react.ForwardRefExoticComponent<DialogFooterProps & react.RefAttributes<HTMLDivElement>>;
 
 /**
@@ -1091,13 +1221,21 @@ type FieldLabelOwnProps = {
      * The id of the text field
      */
     id?: string;
+    /**
+     * The id to apply to the description element for aria-describedby
+     */
+    descriptionId?: string;
     className?: string;
 };
 /** @public */
 interface FieldLabelProps extends FieldLabelOwnProps, Omit<React.ComponentPropsWithoutRef<'div'>, keyof FieldLabelOwnProps> {
 }
 
-/** @public */
+/**
+ * Renders a label for a form field with optional secondary label and description text.
+ *
+ * @public
+ */
 declare const FieldLabel: react.ForwardRefExoticComponent<FieldLabelProps & react.RefAttributes<HTMLDivElement>>;
 
 /**
@@ -1120,6 +1258,7 @@ declare const FieldLabelDefinition: {
         readonly description: {};
         readonly htmlFor: {};
         readonly id: {};
+        readonly descriptionId: {};
         readonly className: {};
     };
 };
@@ -1359,7 +1498,7 @@ interface HeaderOwnProps {
     title?: string;
     customActions?: React.ReactNode;
     tabs?: HeaderNavTabItem[];
-    activeTabId?: string;
+    activeTabId?: string | null;
     breadcrumbs?: HeaderBreadcrumb[];
     className?: string;
 }
@@ -1467,9 +1606,7 @@ declare const HeaderNavDefinition: {
         readonly active: "bui-HeaderNavActive";
         readonly hovered: "bui-HeaderNavHovered";
     };
-    readonly analytics: true;
     readonly propDefs: {
-        readonly noTrack: {};
         readonly tabs: {};
         readonly activeTabId: {};
         readonly children: {};
@@ -1484,7 +1621,16 @@ declare const HeaderNavItemDefinition: {
     readonly classNames: {
         readonly root: "bui-HeaderNavItem";
     };
+    readonly analytics: true;
+    readonly resolveHref: true;
     readonly propDefs: {
+        readonly noTrack: {};
+        readonly id: {};
+        readonly label: {};
+        readonly href: {};
+        readonly active: {};
+        readonly registerRef: {};
+        readonly onHighlight: {};
         readonly className: {};
     };
 };
@@ -1517,7 +1663,11 @@ type ButtonIconOwnProps = {
 interface ButtonIconProps extends Omit<ButtonProps$1, keyof ButtonIconOwnProps>, ButtonIconOwnProps {
 }
 
-/** @public */
+/**
+ * An icon-only button that supports a loading state and requires an accessible label.
+ *
+ * @public
+ */
 declare const ButtonIcon: react.ForwardRefExoticComponent<ButtonIconProps & react.RefAttributes<HTMLButtonElement>>;
 
 /**
@@ -1569,7 +1719,11 @@ type ButtonLinkOwnProps = {
 interface ButtonLinkProps extends Omit<LinkProps$1, keyof ButtonLinkOwnProps>, ButtonLinkOwnProps {
 }
 
-/** @public */
+/**
+ * A button-styled anchor element for navigation, supporting optional start and end icon slots and analytics event tracking.
+ *
+ * @public
+ */
 declare const ButtonLink: react.ForwardRefExoticComponent<ButtonLinkProps & react.RefAttributes<HTMLAnchorElement>>;
 
 /**
@@ -1586,6 +1740,7 @@ declare const ButtonLinkDefinition: {
     };
     readonly bg: "consumer";
     readonly analytics: true;
+    readonly resolveHref: true;
     readonly propDefs: {
         readonly noTrack: {};
         readonly size: {
@@ -1612,7 +1767,11 @@ type CheckboxOwnProps = {
 interface CheckboxProps extends Omit<CheckboxProps$1, 'children' | 'className'>, CheckboxOwnProps {
 }
 
-/** @public */
+/**
+ * A form checkbox input with support for indeterminate state and accessible labeling.
+ *
+ * @public
+ */
 declare const Checkbox: react.ForwardRefExoticComponent<CheckboxProps & react.RefAttributes<HTMLLabelElement>>;
 
 /**
@@ -1633,6 +1792,55 @@ declare const CheckboxDefinition: {
     };
 };
 
+/**
+ * Own props for the CheckboxGroup component.
+ * @public
+ */
+type CheckboxGroupOwnProps = {
+    className?: string;
+    children?: ReactNode;
+    label?: FieldLabelProps['label'];
+    secondaryLabel?: FieldLabelProps['secondaryLabel'];
+    description?: FieldLabelProps['description'];
+    isRequired?: CheckboxGroupProps$1['isRequired'];
+    orientation?: 'horizontal' | 'vertical';
+};
+/**
+ * Props for the CheckboxGroup component.
+ * @public
+ */
+interface CheckboxGroupProps extends Omit<CheckboxGroupProps$1, keyof CheckboxGroupOwnProps>, CheckboxGroupOwnProps {
+}
+
+/**
+ * A group of checkboxes for selecting multiple options from a list.
+ * @public
+ */
+declare const CheckboxGroup: react.ForwardRefExoticComponent<CheckboxGroupProps & react.RefAttributes<HTMLDivElement>>;
+
+/**
+ * Component definition for CheckboxGroup
+ * @public
+ */
+declare const CheckboxGroupDefinition: {
+    readonly styles: {
+        readonly [key: string]: string;
+    };
+    readonly classNames: {
+        readonly root: "bui-CheckboxGroup";
+        readonly content: "bui-CheckboxGroupContent";
+    };
+    readonly propDefs: {
+        readonly className: {};
+        readonly children: {};
+        readonly label: {};
+        readonly secondaryLabel: {};
+        readonly description: {};
+        readonly isRequired: {};
+        readonly orientation: {};
+    };
+};
+
 /** @public */
 type RadioGroupOwnProps = {
     children?: ReactNode;
@@ -1653,9 +1861,17 @@ type RadioOwnProps = {
 interface RadioProps extends RadioOwnProps, Omit<RadioProps$1, keyof RadioOwnProps> {
 }
 
-/** @public */
+/**
+ * A group of radio buttons for selecting a single option from a set, with an integrated label, description, and error display.
+ *
+ * @public
+ */
 declare const RadioGroup: react.ForwardRefExoticComponent<RadioGroupProps & react.RefAttributes<HTMLDivElement>>;
-/** @public */
+/**
+ * A single radio button for use within a RadioGroup.
+ *
+ * @public
+ */
 declare const Radio: react.ForwardRefExoticComponent<RadioProps & react.RefAttributes<HTMLLabelElement>>;
 
 /**
@@ -1695,6 +1911,54 @@ declare const RadioDefinition: {
     };
 };
 
+/** @public */
+interface SliderOwnProps {
+    className?: string;
+    label?: FieldLabelProps['label'];
+    secondaryLabel?: FieldLabelProps['secondaryLabel'];
+    description?: FieldLabelProps['description'];
+    isRequired?: boolean;
+}
+/** @public */
+interface SliderProps<T extends number | number[]> extends Omit<SliderProps$1<T>, 'children' | 'className'>, SliderOwnProps {
+}
+
+/**
+ * A draggable input for selecting a numeric value or range within a defined interval, with an integrated label and value output.
+ *
+ * @public
+ */
+declare const Slider: (<T extends number | number[]>(props: SliderProps<T> & {
+    ref?: React.ForwardedRef<HTMLDivElement>;
+}) => JSX.Element) & {
+    displayName: string;
+};
+
+/**
+ * Component definition for Slider
+ * @public
+ */
+declare const SliderDefinition: {
+    readonly styles: {
+        readonly [key: string]: string;
+    };
+    readonly classNames: {
+        readonly root: "bui-Slider";
+        readonly header: "bui-SliderHeader";
+        readonly track: "bui-SliderTrack";
+        readonly trackFill: "bui-SliderTrackFill";
+        readonly thumb: "bui-SliderThumb";
+        readonly output: "bui-SliderOutput";
+    };
+    readonly propDefs: {
+        readonly className: {};
+        readonly label: {};
+        readonly secondaryLabel: {};
+        readonly description: {};
+        readonly isRequired: {};
+    };
+};
+
 /** @public */
 interface PageSizeOption {
     label: string;
@@ -1717,6 +1981,7 @@ type TablePaginationOwnProps = {
         offset?: number;
         totalCount?: number;
     }) => string;
+    showPaginationLabel?: boolean;
 };
 /** @public */
 interface TablePaginationProps extends TablePaginationOwnProps {
@@ -1759,6 +2024,9 @@ declare const TablePaginationDefinition: {
             readonly default: true;
         };
         readonly getLabel: {};
+        readonly showPaginationLabel: {
+            readonly default: true;
+        };
     };
 };
 
@@ -1976,37 +2244,76 @@ interface TableProps<T extends TableItem> {
     virtualized?: VirtualizedProp;
 }
 
-/** @public */
+/**
+ * A full-featured data table with built-in pagination, sorting, row selection, loading and error states, and optional virtualization.
+ * Pair with `useTable` to manage data fetching and state, or pass `data`, `columnConfig`, and `pagination` directly for manual control.
+ *
+ * @public
+ */
 declare function Table<T extends TableItem>({ columnConfig, data, loading, isStale, error, pagination, sort, rowConfig, selection, emptyState, className, style, virtualized, }: TableProps<T>): react_jsx_runtime.JSX.Element;
 
-/** @public */
+/**
+ * The low-level table root element for building custom table layouts from atomic components.
+ * For most use cases, prefer the `Table` convenience wrapper.
+ *
+ * @public
+ */
 declare const TableRoot: (props: TableRootProps) => react_jsx_runtime.JSX.Element;
 
-/** @public */
+/**
+ * The header row of a table, rendering column labels and an optional select-all checkbox for toggle selection mode.
+ *
+ * @public
+ */
 declare const TableHeader: <T extends object>(props: TableHeaderProps<T>) => react_jsx_runtime.JSX.Element;
 
-/** @public */
+/**
+ * The body section of a table that renders data rows from the provided items collection.
+ *
+ * @public
+ */
 declare const TableBody: <T extends object>(props: TableBodyProps<T>) => react_jsx_runtime.JSX.Element;
 
-/** @public */
+/**
+ * A table column header cell with an optional sort toggle and support for resizable widths.
+ *
+ * @public
+ */
 declare const Column: (props: ColumnProps) => react_jsx_runtime.JSX.Element;
 
-/** @public */
+/**
+ * A table row that can optionally act as a navigation link or trigger an action when clicked, with analytics tracking.
+ *
+ * @public
+ */
 declare function Row<T extends object>(props: RowProps<T>): react_jsx_runtime.JSX.Element;
 
-/** @public */
+/**
+ * A low-level table cell primitive for building custom cell content.
+ * For standard use cases, prefer `CellText` or `CellProfile`.
+ *
+ * @public
+ */
 declare const Cell: {
     (props: CellProps): react_jsx_runtime.JSX.Element;
     displayName: string;
 };
 
-/** @public */
+/**
+ * A table cell that renders a primary text title with an optional secondary description, leading icon, and link.
+ *
+ * @public
+ */
 declare const CellText: {
     (props: CellTextProps): react_jsx_runtime.JSX.Element;
     displayName: string;
 };
 
-/** @public */
+/**
+ * A table cell that renders an avatar image alongside a name, with an optional description and link.
+ *
+ * @public
+ */
 declare const CellProfile: (props: CellProfileProps) => react_jsx_runtime.JSX.Element;
 
 /** @public */
@@ -2032,10 +2339,14 @@ interface QueryOptions<TFilter> {
     onSearchChange?: (search: string) => void;
 }
 /** @public */
-interface PaginationOptions extends Partial<Pick<TablePaginationProps, 'pageSize' | 'pageSizeOptions' | 'onPageSizeChange' | 'onNextPage' | 'onPreviousPage' | 'showPageSizeOptions' | 'getLabel'>> {
+interface PaginationOptions extends Partial<Pick<TablePaginationProps, 'pageSize' | 'pageSizeOptions' | 'onPageSizeChange' | 'onNextPage' | 'onPreviousPage' | 'showPageSizeOptions' | 'getLabel' | 'showPaginationLabel'>> {
     initialOffset?: number;
 }
 /** @public */
+interface CompletePaginationOptions extends PaginationOptions {
+    type?: 'page' | 'none';
+}
+/** @public */
 interface OffsetParams<TFilter> {
     offset: number;
     pageSize: number;
@@ -2068,7 +2379,7 @@ interface CursorResponse<T> {
 /** @public */
 type UseTableCompleteOptions<T extends TableItem, TFilter = unknown> = QueryOptions<TFilter> & {
     mode: 'complete';
-    paginationOptions?: PaginationOptions;
+    paginationOptions?: CompletePaginationOptions;
     sortFn?: (data: T[], sort: SortDescriptor) => T[];
     filterFn?: (data: T[], filter: TFilter) => T[];
     searchFn?: (data: T[], search: string) => T[];
@@ -2101,8 +2412,17 @@ interface UseTableResult<T extends TableItem, TFilter = unknown> {
     search: SearchState;
 }
 
+/**
+ * A hook that manages table data fetching, pagination, sorting, search, and filtering.
+ * Supports three modes: `complete` for client-side data, `offset` for server-side offset pagination, and `cursor` for server-side cursor pagination.
+ *
+ * @public
+ */
+declare function useTable<T extends TableItem, TFilter = unknown>(options: UseTableCompleteOptions<T, TFilter>): UseTableResult<T, TFilter>;
+/** @public */
+declare function useTable<T extends TableItem, TFilter = unknown>(options: UseTableOffsetOptions<T, TFilter>): UseTableResult<T, TFilter>;
 /** @public */
-declare function useTable<T extends TableItem, TFilter = unknown>(options: UseTableOptions<T, TFilter>): UseTableResult<T, TFilter>;
+declare function useTable<T extends TableItem, TFilter = unknown>(options: UseTableCursorOptions<T, TFilter>): UseTableResult<T, TFilter>;
 
 /**
  * Component definition for Table
@@ -2215,7 +2535,11 @@ type TextOwnProps = {
 /** @public */
 type TextProps<T extends ElementType = 'span'> = TextOwnProps & Omit<ComponentPropsWithRef<T>, keyof TextOwnProps>;
 
-/** @public */
+/**
+ * A typographic primitive that renders text with design system variants, weights, and colors, and can render as any HTML element.
+ *
+ * @public
+ */
 declare const Text: {
     <T extends ElementType = "p">(props: TextProps<T> & {
         ref?: React.ComponentPropsWithRef<T>["ref"];
@@ -2289,7 +2613,11 @@ interface TextFieldProps extends Omit<TextFieldProps$1, 'className' | 'descripti
     type?: 'text' | 'email' | 'tel' | 'url';
 }
 
-/** @public */
+/**
+ * A single-line text input with an integrated label, optional icon, and inline error display.
+ *
+ * @public
+ */
 declare const TextField: react.ForwardRefExoticComponent<TextFieldProps & react.RefAttributes<HTMLDivElement>>;
 
 /**
@@ -2346,7 +2674,11 @@ type PasswordFieldOwnProps = {
 interface PasswordFieldProps extends Omit<TextFieldProps$1, 'className' | 'description'>, PasswordFieldOwnProps {
 }
 
-/** @public */
+/**
+ * A text input for password entry with a toggleable visibility button, integrated label, and inline error display.
+ *
+ * @public
+ */
 declare const PasswordField: react.ForwardRefExoticComponent<PasswordFieldProps & react.RefAttributes<HTMLDivElement>>;
 
 /**
@@ -2387,9 +2719,17 @@ type TooltipOwnProps = {
 interface TooltipProps extends Omit<TooltipProps$1, 'children' | 'className'>, TooltipOwnProps {
 }
 
-/** @public */
+/**
+ * A wrapper that connects a trigger element to a Tooltip, controlling its show and hide behavior with a configurable delay.
+ *
+ * @public
+ */
 declare const TooltipTrigger: (props: TooltipTriggerComponentProps) => react_jsx_runtime.JSX.Element;
-/** @public */
+/**
+ * A floating label that provides contextual information about an element when it receives hover or focus.
+ *
+ * @public
+ */
 declare const Tooltip: react.ForwardRefExoticComponent<TooltipProps & react.RefAttributes<HTMLDivElement>>;
 
 /**
@@ -2494,7 +2834,11 @@ type MenuSeparatorOwnProps = {
 interface MenuSeparatorProps extends MenuSeparatorOwnProps, Omit<SeparatorProps, keyof MenuSeparatorOwnProps> {
 }
 
-/** @public */
+/**
+ * A wrapper that connects a trigger element to a dropdown menu, controlling its open and close state.
+ *
+ * @public
+ */
 declare const MenuTrigger: (props: MenuTriggerProps) => react_jsx_runtime.JSX.Element;
 /** @public */
 declare const SubmenuTrigger: (props: SubmenuTriggerProps) => react_jsx_runtime.JSX.Element;
@@ -2688,9 +3032,17 @@ type SearchAutocompleteItemOwnProps = {
 interface SearchAutocompleteItemProps extends SearchAutocompleteItemOwnProps, Omit<ListBoxItemProps, keyof SearchAutocompleteItemOwnProps> {
 }
 
-/** @public */
+/**
+ * A search input that shows a dropdown list of suggestions as the user types, with loading and empty states.
+ *
+ * @public
+ */
 declare function SearchAutocomplete(props: SearchAutocompleteProps): react_jsx_runtime.JSX.Element;
-/** @public */
+/**
+ * An individual option item within a SearchAutocomplete dropdown.
+ *
+ * @public
+ */
 declare function SearchAutocompleteItem(props: SearchAutocompleteItemProps): react_jsx_runtime.JSX.Element;
 
 /**
@@ -2763,7 +3115,11 @@ type SearchFieldOwnProps = {
 interface SearchFieldProps extends Omit<SearchFieldProps$1, 'className' | 'description'>, SearchFieldOwnProps {
 }
 
-/** @public */
+/**
+ * A text input optimized for search queries, with a built-in clear button, optional icon, and support for a collapsible mode.
+ *
+ * @public
+ */
 declare const SearchField: react.ForwardRefExoticComponent<SearchFieldProps & react.RefAttributes<HTMLDivElement>>;
 
 /**
@@ -2818,7 +3174,11 @@ type LinkOwnProps = {
 interface LinkProps extends Omit<LinkProps$1, 'children' | 'className'>, LinkOwnProps {
 }
 
-/** @public */
+/**
+ * A styled anchor element that supports analytics event tracking on click.
+ *
+ * @public
+ */
 declare const Link: react.ForwardRefExoticComponent<LinkProps & react.RefAttributes<HTMLAnchorElement>>;
 
 /**
@@ -2833,6 +3193,7 @@ declare const LinkDefinition: {
         readonly root: "bui-Link";
     };
     readonly analytics: true;
+    readonly resolveHref: true;
     readonly propDefs: {
         readonly noTrack: {};
         readonly variant: {
@@ -2957,6 +3318,7 @@ declare const ListRowDefinition: {
         readonly [key: string]: string;
     };
     readonly bg: "consumer";
+    readonly resolveHref: true;
     readonly classNames: {
         readonly root: "bui-ListRow";
         readonly check: "bui-ListRowCheck";
@@ -3022,7 +3384,11 @@ interface SelectProps<T extends 'single' | 'multiple'> extends SelectOwnProps, O
     selectionMode?: T;
 }
 
-/** @public */
+/**
+ * A dropdown picker for selecting one or multiple options from a list, with optional search filtering and inline error display.
+ *
+ * @public
+ */
 declare const Select: react.ForwardRefExoticComponent<SelectProps<"multiple" | "single"> & react.RefAttributes<HTMLDivElement>>;
 
 /**
@@ -3066,7 +3432,11 @@ type SkeletonOwnProps = {
 interface SkeletonProps extends Omit<ComponentProps<'div'>, 'children' | 'className' | 'style'>, SkeletonOwnProps {
 }
 
-/** @public */
+/**
+ * A placeholder shape displayed while content is loading, matching the size and layout of the content it replaces.
+ *
+ * @public
+ */
 declare const Skeleton: (props: SkeletonProps) => react_jsx_runtime.JSX.Element;
 
 /**
@@ -3108,7 +3478,11 @@ type SwitchOwnProps = {
 interface SwitchProps extends Omit<SwitchProps$1, 'className'>, SwitchOwnProps {
 }
 
-/** @public */
+/**
+ * A toggle control for switching between on and off states, with an optional visible label.
+ *
+ * @public
+ */
 declare const Switch: react.ForwardRefExoticComponent<SwitchProps & react.RefAttributes<HTMLLabelElement>>;
 
 /**
@@ -3145,7 +3519,11 @@ type ToggleButtonOwnProps = {
 interface ToggleButtonProps extends Omit<ToggleButtonProps$1, 'children' | 'className'>, ToggleButtonOwnProps {
 }
 
-/** @public */
+/**
+ * A button that maintains a pressed or unpressed state, with optional start and end icon slots.
+ *
+ * @public
+ */
 declare const ToggleButton: react.ForwardRefExoticComponent<ToggleButtonProps & react.RefAttributes<HTMLButtonElement>>;
 
 /**
@@ -3181,7 +3559,11 @@ type ToggleButtonGroupOwnProps = {
 interface ToggleButtonGroupProps extends Omit<ToggleButtonGroupProps$1, 'className' | 'children'>, ToggleButtonGroupOwnProps {
 }
 
-/** @public */
+/**
+ * A container that groups ToggleButton items and manages their collective selection state.
+ *
+ * @public
+ */
 declare const ToggleButtonGroup: react.ForwardRefExoticComponent<ToggleButtonGroupProps & react.RefAttributes<HTMLDivElement>>;
 
 /**
@@ -3374,5 +3756,5 @@ declare function useAnalytics(): AnalyticsTracker;
  */
 declare function getNodeText(node: ReactNode | ((...args: any[]) => ReactNode)): string | undefined;
 
-export { Accordion, AccordionDefinition, AccordionGroup, AccordionGroupDefinition, AccordionPanel, AccordionPanelDefinition, AccordionTrigger, AccordionTriggerDefinition, Alert, AlertDefinition, Avatar, AvatarDefinition, BUIProvider, BgProvider, Box, BoxDefinition, Button, ButtonDefinition, ButtonIcon, ButtonIconDefinition, ButtonLink, ButtonLinkDefinition, Card, CardBody, CardBodyDefinition, CardDefinition, CardFooter, CardFooterDefinition, CardHeader, CardHeaderDefinition, Cell, CellProfile, CellText, Checkbox, CheckboxDefinition, Column, Container, ContainerDefinition, Dialog, DialogBody, DialogBodyDefinition, DialogDefinition, DialogFooter, DialogFooterDefinition, DialogHeader, DialogHeaderDefinition, DialogTrigger, FieldLabel, FieldLabelDefinition, Flex, FlexDefinition, FullPage, FullPageDefinition, Grid, GridDefinition, GridItemDefinition, Header, HeaderDefinition, HeaderNavDefinition, HeaderNavGroupDefinition, HeaderNavItemDefinition, HeaderPage, HeaderPageDefinition, Link, LinkDefinition, List, ListDefinition, ListRow, ListRowDefinition, Menu, MenuAutocomplete, MenuAutocompleteListbox, MenuDefinition, MenuItem, MenuListBox, MenuListBoxItem, MenuSection, MenuSeparator, MenuTrigger, PasswordField, PasswordFieldDefinition, PluginHeader, PluginHeaderDefinition, Popover, PopoverDefinition, Radio, RadioDefinition, RadioGroup, RadioGroupDefinition, Row, SearchAutocomplete, SearchAutocompleteDefinition, SearchAutocompleteItem, SearchField, SearchFieldDefinition, Select, SelectDefinition, Skeleton, SkeletonDefinition, SubmenuTrigger, Switch, SwitchDefinition, Tab, TabList, TabPanel, Table, TableBody, TableDefinition, TableHeader, TablePagination, TablePaginationDefinition, TableRoot, Tabs, TabsDefinition, Tag, TagGroup, TagGroupDefinition, Text, TextDefinition, TextField, TextFieldDefinition, ToggleButton, ToggleButtonDefinition, ToggleButtonGroup, ToggleButtonGroupDefinition, Tooltip, TooltipDefinition, TooltipTrigger, VisuallyHidden, VisuallyHiddenDefinition, getNodeText, useAnalytics, useBgConsumer, useBgProvider, useBreakpoint, useTable };
-export type { AccordionGroupOwnProps, AccordionGroupProps, AccordionOwnProps, AccordionPanelOwnProps, AccordionPanelProps, AccordionProps, AccordionTriggerOwnProps, AccordionTriggerProps, AlertOwnProps, AlertProps, AlignItems, AnalyticsEventAttributes, AnalyticsTracker, AvatarOwnProps, AvatarProps, BUIProviderProps, BgContextValue, BgProviderProps, Border, BorderRadius, BoxOwnProps, BoxProps, BoxUtilityProps, Breakpoint, ButtonIconOwnProps, ButtonIconProps, ButtonLinkOwnProps, ButtonLinkProps, ButtonOwnProps, ButtonProps, CardBaseProps, CardBodyOwnProps, CardBodyProps, CardButtonVariant, CardFooterOwnProps, CardFooterProps, CardHeaderOwnProps, CardHeaderProps, CardLinkVariant, CardOwnProps, CardProps, CardStaticVariant, CellOwnProps, CellProfileOwnProps, CellProfileProps, CellProps, CellTextOwnProps, CellTextProps, CheckboxOwnProps, CheckboxProps, ColumnConfig, ColumnOwnProps, ColumnProps, Columns, ContainerBg, ContainerOwnProps, ContainerProps, CursorParams, CursorResponse, DialogBodyOwnProps, DialogBodyProps, DialogFooterOwnProps, DialogFooterProps, DialogHeaderOwnProps, DialogHeaderProps, DialogOwnProps, DialogProps, DialogTriggerProps, Display, FieldLabelOwnProps, FieldLabelProps, FilterState, FlexDirection, FlexOwnProps, FlexProps, FlexWrap, FullPageOwnProps, FullPageProps, GridItemOwnProps, GridItemProps, GridOwnProps, GridProps, HeaderBreadcrumb, HeaderNavTab, HeaderNavTabGroup, HeaderNavTabItem, HeaderOwnProps, HeaderPageBreadcrumb, HeaderPageOwnProps, HeaderPageProps, HeaderProps, HeaderTab, JustifyContent, LinkOwnProps, LinkProps, ListOwnProps, ListProps, ListRowOwnProps, ListRowProps, MarginProps, MenuAutocompleteListBoxOwnProps, MenuAutocompleteListBoxProps, MenuAutocompleteOwnProps, MenuAutocompleteProps, MenuItemOwnProps, MenuItemProps, MenuListBoxItemOwnProps, MenuListBoxItemProps, MenuListBoxOwnProps, MenuListBoxProps, MenuOwnProps, MenuPopoverOwnProps, MenuProps, MenuSectionOwnProps, MenuSectionProps, MenuSeparatorOwnProps, MenuSeparatorProps, MenuTriggerProps, NoPagination, OffsetParams, OffsetResponse, Option, PaddingProps, PagePagination, PageSizeOption, PaginationOptions, PasswordFieldOwnProps, PasswordFieldProps, PluginHeaderOwnProps, PluginHeaderProps, PopoverOwnProps, PopoverProps, ProviderBg, QueryOptions, RadioGroupOwnProps, RadioGroupProps, RadioOwnProps, RadioProps, Responsive, RowConfig, RowOwnProps, RowProps, RowRenderFn, SearchAutocompleteItemOwnProps, SearchAutocompleteItemProps, SearchAutocompleteOwnProps, SearchAutocompleteProps, SearchFieldOwnProps, SearchFieldProps, SearchState, SelectOwnProps, SelectProps, SkeletonOwnProps, SkeletonProps, SortDescriptor, SortState, Space, SpaceProps, SubmenuTriggerProps, SwitchOwnProps, SwitchProps, TabListOwnProps, TabListProps, TabMatchStrategy, TabOwnProps, TabPanelOwnProps, TabPanelProps, TabProps, TableBodyOwnProps, TableBodyProps, TableHeaderOwnProps, TableHeaderProps, TableItem, TablePaginationOwnProps, TablePaginationProps, TablePaginationType, TableProps, TableRootOwnProps, TableRootProps, TableSelection, TabsOwnProps, TabsProps, TagGroupOwnProps, TagGroupProps, TagOwnProps, TagProps, TextColorStatus, TextColors, TextFieldOwnProps, TextFieldProps, TextOwnProps, TextProps, TextVariants, TextWeights, ToggleButtonGroupOwnProps, ToggleButtonGroupProps, ToggleButtonOwnProps, ToggleButtonProps, TooltipOwnProps, TooltipProps, UseAnalyticsFn, UseTableCompleteOptions, UseTableCursorOptions, UseTableOffsetOptions, UseTableOptions, UseTableResult, UtilityProps, VirtualizedProp, VisuallyHiddenOwnProps, VisuallyHiddenProps };
+export { Accordion, AccordionDefinition, AccordionGroup, AccordionGroupDefinition, AccordionPanel, AccordionPanelDefinition, AccordionTrigger, AccordionTriggerDefinition, Alert, AlertDefinition, Avatar, AvatarDefinition, BUIProvider, Badge, BadgeDefinition, BgProvider, Box, BoxDefinition, Button, ButtonDefinition, ButtonIcon, ButtonIconDefinition, ButtonLink, ButtonLinkDefinition, Card, CardBody, CardBodyDefinition, CardDefinition, CardFooter, CardFooterDefinition, CardHeader, CardHeaderDefinition, Cell, CellProfile, CellText, Checkbox, CheckboxDefinition, CheckboxGroup, CheckboxGroupDefinition, Column, Container, ContainerDefinition, Dialog, DialogBody, DialogBodyDefinition, DialogDefinition, DialogFooter, DialogFooterDefinition, DialogHeader, DialogHeaderDefinition, DialogTrigger, FieldLabel, FieldLabelDefinition, Flex, FlexDefinition, FullPage, FullPageDefinition, Grid, GridDefinition, GridItemDefinition, Header, HeaderDefinition, HeaderNavDefinition, HeaderNavGroupDefinition, HeaderNavItemDefinition, HeaderPage, HeaderPageDefinition, Link, LinkDefinition, List, ListDefinition, ListRow, ListRowDefinition, Menu, MenuAutocomplete, MenuAutocompleteListbox, MenuDefinition, MenuItem, MenuListBox, MenuListBoxItem, MenuSection, MenuSeparator, MenuTrigger, PasswordField, PasswordFieldDefinition, PluginHeader, PluginHeaderDefinition, Popover, PopoverDefinition, Radio, RadioDefinition, RadioGroup, RadioGroupDefinition, Row, SearchAutocomplete, SearchAutocompleteDefinition, SearchAutocompleteItem, SearchField, SearchFieldDefinition, Select, SelectDefinition, Skeleton, SkeletonDefinition, Slider, SliderDefinition, SubmenuTrigger, Switch, SwitchDefinition, Tab, TabList, TabPanel, Table, TableBody, TableDefinition, TableHeader, TablePagination, TablePaginationDefinition, TableRoot, Tabs, TabsDefinition, Tag, TagGroup, TagGroupDefinition, Text, TextDefinition, TextField, TextFieldDefinition, ToggleButton, ToggleButtonDefinition, ToggleButtonGroup, ToggleButtonGroupDefinition, Tooltip, TooltipDefinition, TooltipTrigger, VisuallyHidden, VisuallyHiddenDefinition, getNodeText, useAnalytics, useBgConsumer, useBgProvider, useBreakpoint, useTable };
+export type { AccordionGroupOwnProps, AccordionGroupProps, AccordionOwnProps, AccordionPanelOwnProps, AccordionPanelProps, AccordionProps, AccordionTriggerOwnProps, AccordionTriggerProps, AlertOwnProps, AlertProps, AlignItems, AnalyticsEventAttributes, AnalyticsTracker, AvatarOwnProps, AvatarProps, BUIProviderProps, BadgeOwnProps, BadgeProps, BgContextValue, BgProviderProps, Border, BorderRadius, BoxOwnProps, BoxProps, BoxUtilityProps, Breakpoint, ButtonIconOwnProps, ButtonIconProps, ButtonLinkOwnProps, ButtonLinkProps, ButtonOwnProps, ButtonProps, CardBaseProps, CardBodyOwnProps, CardBodyProps, CardButtonVariant, CardFooterOwnProps, CardFooterProps, CardHeaderOwnProps, CardHeaderProps, CardLinkVariant, CardOwnProps, CardProps, CardStaticVariant, CellOwnProps, CellProfileOwnProps, CellProfileProps, CellProps, CellTextOwnProps, CellTextProps, CheckboxGroupOwnProps, CheckboxGroupProps, CheckboxOwnProps, CheckboxProps, ColumnConfig, ColumnOwnProps, ColumnProps, Columns, CompletePaginationOptions, ContainerBg, ContainerOwnProps, ContainerProps, CursorParams, CursorResponse, DialogBodyOwnProps, DialogBodyProps, DialogFooterOwnProps, DialogFooterProps, DialogHeaderOwnProps, DialogHeaderProps, DialogOwnProps, DialogProps, DialogTriggerProps, Display, FieldLabelOwnProps, FieldLabelProps, FilterState, FlexDirection, FlexOwnProps, FlexProps, FlexWrap, FullPageOwnProps, FullPageProps, GridItemOwnProps, GridItemProps, GridOwnProps, GridProps, HeaderBreadcrumb, HeaderNavTab, HeaderNavTabGroup, HeaderNavTabItem, HeaderOwnProps, HeaderPageBreadcrumb, HeaderPageOwnProps, HeaderPageProps, HeaderProps, HeaderTab, JustifyContent, LinkOwnProps, LinkProps, ListOwnProps, ListProps, ListRowOwnProps, ListRowProps, MarginProps, MenuAutocompleteListBoxOwnProps, MenuAutocompleteListBoxProps, MenuAutocompleteOwnProps, MenuAutocompleteProps, MenuItemOwnProps, MenuItemProps, MenuListBoxItemOwnProps, MenuListBoxItemProps, MenuListBoxOwnProps, MenuListBoxProps, MenuOwnProps, MenuPopoverOwnProps, MenuProps, MenuSectionOwnProps, MenuSectionProps, MenuSeparatorOwnProps, MenuSeparatorProps, MenuTriggerProps, NoPagination, OffsetParams, OffsetResponse, Option, PaddingProps, PagePagination, PageSizeOption, PaginationOptions, PasswordFieldOwnProps, PasswordFieldProps, PluginHeaderOwnProps, PluginHeaderProps, PopoverOwnProps, PopoverProps, ProviderBg, QueryOptions, RadioGroupOwnProps, RadioGroupProps, RadioOwnProps, RadioProps, Responsive, RowConfig, RowOwnProps, RowProps, RowRenderFn, SearchAutocompleteItemOwnProps, SearchAutocompleteItemProps, SearchAutocompleteOwnProps, SearchAutocompleteProps, SearchFieldOwnProps, SearchFieldProps, SearchState, SelectOwnProps, SelectProps, SkeletonOwnProps, SkeletonProps, SliderOwnProps, SliderProps, SortDescriptor, SortState, Space, SpaceProps, SubmenuTriggerProps, SwitchOwnProps, SwitchProps, TabListOwnProps, TabListProps, TabMatchStrategy, TabOwnProps, TabPanelOwnProps, TabPanelProps, TabProps, TableBodyOwnProps, TableBodyProps, TableHeaderOwnProps, TableHeaderProps, TableItem, TablePaginationOwnProps, TablePaginationProps, TablePaginationType, TableProps, TableRootOwnProps, TableRootProps, TableSelection, TabsOwnProps, TabsProps, TagGroupOwnProps, TagGroupProps, TagOwnProps, TagProps, TextColorStatus, TextColors, TextFieldOwnProps, TextFieldProps, TextOwnProps, TextProps, TextVariants, TextWeights, ToggleButtonGroupOwnProps, ToggleButtonGroupProps, ToggleButtonOwnProps, ToggleButtonProps, TooltipOwnProps, TooltipProps, UseAnalyticsFn, UseTableCompleteOptions, UseTableCursorOptions, UseTableOffsetOptions, UseTableOptions, UseTableResult, UtilityProps, VirtualizedProp, VisuallyHiddenOwnProps, VisuallyHiddenProps };