@servicetitan/anvil2 3.14.0 → 3.15.0

package/dist/src/components/Stepper/base/StepperBase.d.ts

@@ -1,112 +1,63 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { LayoutUtilProps } from '../../../types';
 /**
- * Props for the StepperBase component
- * @extends ComponentPropsWithoutRef<"div">
+ * @extends Omit<ComponentPropsWithoutRef<"div">, "onAnimationStart" | "onDragStart" | "onDragEnd" | "onDrag">
  * @extends LayoutUtilProps
  */
 export type StepperBaseProps = Omit<ComponentPropsWithoutRef<"div">, "onAnimationStart" | "onDragStart" | "onDragEnd" | "onDrag"> & LayoutUtilProps & {
-    /**
-     * Controlled current step (0-based). Pair with onIndexChange.
-     */
+    /** Controlled current step (0-based). Pair with `onIndexChange`. */
     index?: number;
     /**
-     * Uncontrolled start. Ignored when index is set.
-     * @default 0
+     * Uncontrolled start. Ignored when `index` is set. Defaults to `0`.
      */
     defaultIndex?: number;
-    /**
-     * Fired when a step is activated.
-     * @param index The index of the newly current step
-     */
+    /** Called with the requested 0-based index. */
     onIndexChange?: (index: number) => void;
     /**
-     * When true, click and keyboard can change the current step.
-     * @default false
+     * Click, Enter, and Space can activate a step. Arrow keys only move
+     * focus. Defaults to `false`.
      */
     interactive?: boolean;
 };
 /**
- * StepperBase is a controllable stepper primitive. The caller sets the current
- * step and each step's outcome. Use Stepper for the linear wizard.
- *
- * Features:
- * - Controlled or uncontrolled current step via index / defaultIndex / onIndexChange
- * - Per-step outcome (not started, started, complete) independent of current
- * - Optional panels; a panel names its step, steps do not require panels
- * - Display-only by default; opt into click/keyboard with interactive
- * - Same track, circle, and compact-label chrome as Stepper
+ * Controllable stepper primitive: current index is controlled (`index` +
+ * `onIndexChange`) or uncontrolled (`defaultIndex`). Each step's outcome is
+ * independent of current. {@link Stepper} is the linear wizard on top.
+ * Display-only until `interactive`. Panels are optional.
  *
  * @example
  * <StepperBase index={2}>
  *   <StepperBase.List>
  *     <StepperBase.Step state="complete">Approved</StepperBase.Step>
- *     <StepperBase.Step state="complete">Approved & Reconciled</StepperBase.Step>
  *     <StepperBase.Step>Scheduled</StepperBase.Step>
  *   </StepperBase.List>
  * </StepperBase>
  */
 export declare const StepperBase: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "onDrag" | "onDragEnd" | "onDragStart" | "onAnimationStart"> & LayoutUtilProps & {
-    /**
-     * Controlled current step (0-based). Pair with onIndexChange.
-     */
+    /** Controlled current step (0-based). Pair with `onIndexChange`. */
     index?: number;
     /**
-     * Uncontrolled start. Ignored when index is set.
-     * @default 0
+     * Uncontrolled start. Ignored when `index` is set. Defaults to `0`.
      */
     defaultIndex?: number;
-    /**
-     * Fired when a step is activated.
-     * @param index The index of the newly current step
-     */
+    /** Called with the requested 0-based index. */
     onIndexChange?: (index: number) => void;
     /**
-     * When true, click and keyboard can change the current step.
-     * @default false
+     * Click, Enter, and Space can activate a step. Arrow keys only move
+     * focus. Defaults to `false`.
      */
     interactive?: boolean;
 } & import('react').RefAttributes<HTMLDivElement>> & {
-    /**
-     * Individual step. Outcome is independent of whether the step is current.
-     *
-     * Features:
-     * - state: not started, started, or complete
-     * - Optional id when a panel points at this step
-     * - Check icon when complete
-     *
-     * @example
-     * <StepperBase.Step state="complete">Approved</StepperBase.Step>
-     */
+    /** Progress marker for one step in the track. */
     Step: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref">, "onClick" | "disabled"> & {
         state?: import('./StepperBaseStep').StepperBaseStepState;
         id?: string;
         disabled?: boolean;
         onClick?: (e: import('react').MouseEvent<HTMLButtonElement>, index?: number) => void;
     } & import('react').RefAttributes<HTMLButtonElement>>;
-    /**
-     * Track of steps plus the compact label on small widths.
-     *
-     * Features:
-     * - Lays out StepperBase.Step children
-     * - Shows the current step label when the track is narrow
-     *
-     * @example
-     * <StepperBase.List>
-     *   <StepperBase.Step>Scheduled</StepperBase.Step>
-     * </StepperBase.List>
-     */
+    /** Track of `StepperBase.Step` children plus the compact current label. */
     List: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & import('react').RefAttributes<HTMLDivElement>>;
-    /**
-     * Content for one step. Visible when that step is current.
-     *
-     * Features:
-     * - step is required and must match a Step id
-     * - id is optional and generated when omitted
-     *
-     * @example
-     * <StepperBase.Panel step="approved">Details</StepperBase.Panel>
-     */
+    /** Body shown while its named step is current. */
     Panel: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "onDrag" | "onDragEnd" | "onDragStart" | "onAnimationStart"> & LayoutUtilProps & {
         step: string;
         id?: string;

package/dist/src/components/Stepper/base/StepperBaseList.d.ts

@@ -1,21 +1,7 @@
 import { ComponentPropsWithoutRef } from 'react';
 /**
- * Props for the StepperBase.List component
  * @extends ComponentPropsWithoutRef<"div">
  */
 export type StepperBaseListProps = ComponentPropsWithoutRef<"div">;
-/**
- * Container for StepperBase steps.
- *
- * Features:
- * - Groups steps in the track
- * - Shows the current step label on small widths
- * - Accessible tablist
- *
- * @example
- * <StepperBase.List>
- *   <StepperBase.Step>One</StepperBase.Step>
- *   <StepperBase.Step>Two</StepperBase.Step>
- * </StepperBase.List>
- */
+/** Track of `StepperBase.Step` children plus the compact current label. */
 export declare const StepperBaseList: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/components/Stepper/base/StepperBasePanel.d.ts

@@ -1,40 +1,23 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { LayoutUtilProps } from '../../../types';
 /**
- * Props for the StepperBase.Panel component
- * @extends ComponentPropsWithoutRef<"div">
+ * @extends Omit<ComponentPropsWithoutRef<"div">, "onAnimationStart" | "onDragStart" | "onDragEnd" | "onDrag">
  * @extends LayoutUtilProps
  */
 export type StepperBasePanelProps = Omit<ComponentPropsWithoutRef<"div">, "onAnimationStart" | "onDragStart" | "onDragEnd" | "onDrag"> & LayoutUtilProps & {
-    /**
-     * id of the controlling Step.
-     */
+    /** Must match the controlling `StepperBase.Step` `id`. */
     step: string;
     /**
-     * Panel element id. Generated when omitted (used for aria-controls).
+     * Panel element id. Generated when omitted (used for `aria-controls`).
      */
     id?: string;
 };
-/**
- * Content panel for a StepperBase step.
- *
- * Features:
- * - Shown only when the named step is current
- * - Fade-in animation
- * - Overflow scrolling for long content
- *
- * @example
- * <StepperBase.Panel step="approved">
- *   Details
- * </StepperBase.Panel>
- */
+/** Body shown while its named step is current. */
 export declare const StepperBasePanel: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "onDrag" | "onDragEnd" | "onDragStart" | "onAnimationStart"> & LayoutUtilProps & {
-    /**
-     * id of the controlling Step.
-     */
+    /** Must match the controlling `StepperBase.Step` `id`. */
     step: string;
     /**
-     * Panel element id. Generated when omitted (used for aria-controls).
+     * Panel element id. Generated when omitted (used for `aria-controls`).
      */
     id?: string;
 } & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/components/Stepper/base/StepperBaseStep.d.ts

@@ -2,65 +2,42 @@ import { MouseEvent, ComponentPropsWithoutRef } from 'react';
 import { StepperBaseStepState } from './internal/StepperBaseContext';
 export type { StepperBaseStepState };
 /**
- * Props for the StepperBase.Step component
- * @extends ComponentPropsWithoutRef<"button">
+ * @extends Omit<ComponentPropsWithoutRef<"button">, "onClick" | "disabled">
  */
 export type StepperBaseStepProps = Omit<ComponentPropsWithoutRef<"button">, "onClick" | "disabled"> & {
     /**
-     * Outcome of this step. Independent of whether it is current (index).
-     * Current + any state is legal.
-     * @default "not started"
+     * Visual outcome, independent of whether this step is current. Current plus
+     * any state is legal. Defaults to `"not started"`.
      */
     state?: StepperBaseStepState;
-    /**
-     * Stable id. Required when a Panel points at this step.
-     */
+    /** Required when a `StepperBase.Panel` `step` points here. */
     id?: string;
     /**
-     * When true, this step cannot become current via click or keyboard.
-     * @default false
+     * Blocks becoming current via click or keyboard. Defaults to `false`.
      */
     disabled?: boolean;
     /**
-     * Notify only. Does not replace onIndexChange.
-     * @param e Mouse event
-     * @param index Index of the step in the list
+     * Notify only; does not replace `onIndexChange`. Receives this step's
+     * 0-based index.
      */
     onClick?: (e: MouseEvent<HTMLButtonElement>, index?: number) => void;
 };
-/**
- * Individual step for StepperBase.
- *
- * Features:
- * - Outcome independent of the current step
- * - Check icon when complete
- * - Optional id for panel pairing
- *
- * @example
- * <StepperBase.Step id="approved" state="complete">
- *   Approved
- * </StepperBase.Step>
- */
+/** Progress marker for one step in the track. */
 export declare const StepperBaseStep: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref">, "onClick" | "disabled"> & {
     /**
-     * Outcome of this step. Independent of whether it is current (index).
-     * Current + any state is legal.
-     * @default "not started"
+     * Visual outcome, independent of whether this step is current. Current plus
+     * any state is legal. Defaults to `"not started"`.
      */
     state?: StepperBaseStepState;
-    /**
-     * Stable id. Required when a Panel points at this step.
-     */
+    /** Required when a `StepperBase.Panel` `step` points here. */
     id?: string;
     /**
-     * When true, this step cannot become current via click or keyboard.
-     * @default false
+     * Blocks becoming current via click or keyboard. Defaults to `false`.
      */
     disabled?: boolean;
     /**
-     * Notify only. Does not replace onIndexChange.
-     * @param e Mouse event
-     * @param index Index of the step in the list
+     * Notify only; does not replace `onIndexChange`. Receives this step's
+     * 0-based index.
      */
     onClick?: (e: MouseEvent<HTMLButtonElement>, index?: number) => void;
 } & import('react').RefAttributes<HTMLButtonElement>>;

package/dist/src/components/Stepper/internal/StepperWizardBootstrap.d.ts

@@ -1,3 +1,7 @@
+/**
+ * After the first step registers, `defaultIndex >=` step count marks the
+ * wizard complete on the last step. Runs once.
+ */
 export declare function StepperWizardBootstrap({ defaultIndex, }: {
     defaultIndex?: number;
 }): null;

package/dist/src/components/Stepper/internal/countRegisteredSteps.d.ts

@@ -1,2 +1,3 @@
 import { StepperBaseContextValue } from '../base/internal/StepperBaseContext';
+/** Walks 0, 1, … until `getStep` returns undefined. A hole in the map ends the count. */
 export declare function countRegisteredSteps(getStep: StepperBaseContextValue["getStep"]): number;

package/dist/src/components/Switch/Switch.d.ts

@@ -1,86 +1,39 @@
 import { ChangeEvent, ComponentPropsWithoutRef, ReactElement } from 'react';
 import { AiMarkWithTooltipOrPopoverProps, DataTrackingId, LayoutUtilProps } from '../../types';
-/**
- * State object returned by the Switch onChange callback
- */
 export type SwitchState = {
-    /**
-     * Whether the switch is currently checked
-     */
+    /** Checked state after the event. */
     checked: boolean;
-    /**
-     * The value of the switch input
-     */
+    /** Value from the switch input. */
     value?: string | number | readonly string[];
 };
 /**
- * Props for the Switch component
- * @extends ComponentPropsWithoutRef<"input">
+ * @extends Omit<ComponentPropsWithoutRef<"input">, "onChange">
  * @extends LayoutUtilProps
  */
 export type SwitchProps = Omit<ComponentPropsWithoutRef<"input">, "onChange"> & LayoutUtilProps & {
-    /**
-     * Callback when switch is changed.
-     * @param e Change event object
-     * @param state Current switch state with checked status and value
-     */
+    /** Called with the input event and resulting checked state. */
     onChange?: (e: ChangeEvent<HTMLInputElement>, state: SwitchState) => void;
     /**
-     * Label for the switch.
-     * @remarks This should either be a string or have text content inside for accessibility
+     * Visible label content. When omitted, provide `aria-label`; otherwise the
+     * accessible name defaults to "Toggle option".
      */
     label?: ReactElement | string;
-    /**
-     * AI mark configuration to display next to the label.
-     * Can be a boolean to show a simple AI mark, or an object with tooltip/popover configuration.
-     */
+    /** AI mark rendered after the visible label. */
     labelAiMark?: AiMarkWithTooltipOrPopoverProps["aiMark"];
-    /**
-     * Description text to display below the label
-     */
+    /** Secondary copy rendered below the label. */
     description?: string;
 } & DataTrackingId;
-/**
- * Switch component for toggling between on/off states.
- *
- * Features:
- * - Toggle switch with smooth animations
- * - Check icon indicator when active
- * - Accessible with proper ARIA roles and attributes
- * - Keyboard navigation support (Space/Enter)
- * - Controlled and uncontrolled state management
- * - Customizable label and styling
- * - Layout utilities for positioning and spacing
- * - Focus management with visible focus indicators
- * - Hover states and visual feedback
- * - Disabled state support
- * - Automatic tracking ID generation for analytics
- *
- * @example
- * <Switch
- *   label="Enable notifications"
- *   onChange={(e, state) => console.log('Switch toggled:', state.checked)}
- * />
- */
+/** Checkbox-backed switch for toggling an option on or off. */
 export declare const Switch: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "ref">, "onChange"> & LayoutUtilProps & {
-    /**
-     * Callback when switch is changed.
-     * @param e Change event object
-     * @param state Current switch state with checked status and value
-     */
+    /** Called with the input event and resulting checked state. */
     onChange?: (e: ChangeEvent<HTMLInputElement>, state: SwitchState) => void;
     /**
-     * Label for the switch.
-     * @remarks This should either be a string or have text content inside for accessibility
+     * Visible label content. When omitted, provide `aria-label`; otherwise the
+     * accessible name defaults to "Toggle option".
      */
     label?: ReactElement | string;
-    /**
-     * AI mark configuration to display next to the label.
-     * Can be a boolean to show a simple AI mark, or an object with tooltip/popover configuration.
-     */
+    /** AI mark rendered after the visible label. */
     labelAiMark?: AiMarkWithTooltipOrPopoverProps["aiMark"];
-    /**
-     * Description text to display below the label
-     */
+    /** Secondary copy rendered below the label. */
     description?: string;
 } & DataTrackingId & import('react').RefAttributes<HTMLInputElement>>;

package/dist/src/components/Tab/Tab.d.ts

@@ -1,62 +1,25 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { LayoutUtilProps } from '../../types';
 /**
- * Props for the Tab component
  * @extends Omit<ComponentPropsWithoutRef<"div">, "onAnimationStart" | "onDragStart" | "onDragEnd" | "onDrag">
  * @extends LayoutUtilProps
  */
 export type TabProps = Omit<ComponentPropsWithoutRef<"div">, "onAnimationStart" | "onDragStart" | "onDragEnd" | "onDrag"> & LayoutUtilProps & {
-    /**
-     * The index of the tab that should be active by default.
-     * Use for uncontrolled usage. For controlled usage, use `index` instead.
-     * @default 0
-     */
+    /** Initially selected tab for uncontrolled usage. Defaults to `0`. */
     defaultIndex?: number;
-    /**
-     * The index of the currently active tab.
-     * Use for controlled usage. For uncontrolled usage, use `defaultIndex` instead.
-     */
+    /** Selected tab for controlled usage. */
     index?: number;
-    /**
-     * Callback fired when the active tab changes.
-     * Use with `index` for controlled usage.
-     * @param index The index of the newly active tab
-     */
+    /** Called with the selected tab index when selection changes. */
     onIndexChange?: (index: number) => void;
-    /**
-     * Whether the tabs should fill the available width.
-     * @default false
-     */
+    /** Makes tab buttons share the available width. Defaults to `false`. */
     fill?: boolean;
 };
 /**
- * Tab component: a tabbed navigation control for switching between panels, sections, or views using a horizontal row of tabs.
- *
- * Features:
- * - Keyboard navigation support (arrow keys, Enter, Space)
- * - Accessible with proper ARIA roles and attributes
- * - Smooth animations and transitions
- * - RTL language support
- * - Automatic focus management
- * - Scroll behavior for overflow tabs
- * - Compound component pattern with Tab.Button, Tab.List, and Tab.Panel
- * - Supports controlled state via `index` and `onIndexChange` props
- * - Supports layout utilities for positioning and spacing
- *
- * @example
- * // Uncontrolled
- * <Tab defaultIndex={0}>
- *   <Tab.List>
- *     <Tab.Button id="tab1" controls="panel1">First Tab</Tab.Button>
- *     <Tab.Button id="tab2" controls="panel2">Second Tab</Tab.Button>
- *   </Tab.List>
- *   <Tab.Panel id="panel1">Content for first tab</Tab.Panel>
- *   <Tab.Panel id="panel2">Content for second tab</Tab.Panel>
- * </Tab>
+ * Tabbed content with controlled or uncontrolled selection. Arrow keys move
+ * focus; Enter or Space selects the focused tab.
  *
  * @example
- * // Controlled
- * <Tab index={activeIndex} onIndexChange={setActiveIndex}>
+ * <Tab>
  *   <Tab.List>
  *     <Tab.Button id="tab1" controls="panel1">First Tab</Tab.Button>
  *     <Tab.Button id="tab2" controls="panel2">Second Tab</Tab.Button>
@@ -66,88 +29,24 @@ export type TabProps = Omit<ComponentPropsWithoutRef<"div">, "onAnimationStart"
  * </Tab>
  */
 export declare const Tab: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "onDrag" | "onDragEnd" | "onDragStart" | "onAnimationStart"> & LayoutUtilProps & {
-    /**
-     * The index of the tab that should be active by default.
-     * Use for uncontrolled usage. For controlled usage, use `index` instead.
-     * @default 0
-     */
+    /** Initially selected tab for uncontrolled usage. Defaults to `0`. */
     defaultIndex?: number;
-    /**
-     * The index of the currently active tab.
-     * Use for controlled usage. For uncontrolled usage, use `defaultIndex` instead.
-     */
+    /** Selected tab for controlled usage. */
     index?: number;
-    /**
-     * Callback fired when the active tab changes.
-     * Use with `index` for controlled usage.
-     * @param index The index of the newly active tab
-     */
+    /** Called with the selected tab index when selection changes. */
     onIndexChange?: (index: number) => void;
-    /**
-     * Whether the tabs should fill the available width.
-     * @default false
-     */
+    /** Makes tab buttons share the available width. Defaults to `false`. */
     fill?: boolean;
 } & import('react').RefAttributes<HTMLDivElement>> & {
-    /**
-     * TabButton component for individual tab navigation buttons.
-     *
-     * Features:
-     * - Automatic ARIA attributes for accessibility
-     * - Visual indicator for active state
-     * - Keyboard navigation support
-     * - Smooth animations with reduced motion support
-     * - Proper focus management
-     * - RTL language support
-     * - Automatic tracking ID generation for analytics
-     *
-     * @example
-     * <Tab.Button id="tab1" controls="panel1" onClick={(e, index) => console.log('Tab clicked:', index)}>
-     *   First Tab
-     * </Tab.Button>
-     */
+    /** Selectable tab associated with a `Tab.Panel`. */
     Button: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref">, "onClick" | "disabled"> & {
         id: string;
         controls: string;
         onClick?: (e: import('react').MouseEvent<HTMLButtonElement>, index?: number) => void;
     } & import('../..').DataTrackingId & import('react').RefAttributes<HTMLButtonElement>>;
-    /**
-     * TabList component for containing and managing tab buttons.
-     *
-     * Features:
-     * - Horizontal scrolling for overflow tabs
-     * - Navigation arrows for overflow content
-     * - RTL language support
-     * - Automatic overflow detection
-     * - Proper ARIA roles for accessibility
-     * - Smooth scrolling behavior
-     * - Visual indicator positioning
-     *
-     * @example
-     * <Tab.List>
-     *   <Tab.Button id="tab1" controls="panel1">First Tab</Tab.Button>
-     *   <Tab.Button id="tab2" controls="panel2">Second Tab</Tab.Button>
-     *   <Tab.Button id="tab3" controls="panel3">Third Tab</Tab.Button>
-     * </Tab.List>
-     */
+    /** Scrollable tablist for `Tab.Button` children. */
     List: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & import('react').RefAttributes<HTMLDivElement>>;
-    /**
-     * TabPanel component for displaying tab content.
-     *
-     * Features:
-     * - Automatic visibility based on active tab
-     * - Smooth fade animations
-     * - Proper ARIA attributes for accessibility
-     * - Automatic association with tab buttons
-     * - Focus management
-     * - Layout animations
-     *
-     * @example
-     * <Tab.Panel id="panel1">
-     *   <h2>First Tab Content</h2>
-     *   <p>This is the content for the first tab.</p>
-     * </Tab.Panel>
-     */
+    /** Content rendered while its associated `Tab.Button` is selected. */
     Panel: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "onDrag" | "onDragEnd" | "onDragStart" | "onAnimationStart"> & {
         id: string;
     } & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/components/Tab/TabButton.d.ts

@@ -1,54 +1,22 @@
 import { MouseEvent, ComponentPropsWithoutRef } from 'react';
 import { DataTrackingId } from '../../types';
 /**
- * Props for the TabButton component
  * @extends Omit<ComponentPropsWithoutRef<"button">, "onClick" | "disabled">
  */
 export type TabButtonProps = Omit<ComponentPropsWithoutRef<"button">, "onClick" | "disabled"> & {
-    /**
-     * Unique identifier for the tab button.
-     */
+    /** Used by the associated panel as its accessible label reference. */
     id: string;
-    /**
-     * ID of the tab panel that this button controls.
-     */
+    /** Must match the associated `Tab.Panel` `id`. */
     controls: string;
-    /**
-     * Callback function called when the tab button is clicked.
-     * @param e The mouse event
-     * @param index The index of the tab button
-     */
+    /** Runs before selection updates and receives this button's tab index. */
     onClick?: (e: MouseEvent<HTMLButtonElement>, index?: number) => void;
 } & DataTrackingId;
-/**
- * TabButton component for individual tab navigation buttons.
- *
- * Features:
- * - Automatic ARIA attributes for accessibility
- * - Visual indicator for active state
- * - Keyboard navigation support
- * - Smooth animations with reduced motion support
- * - Proper focus management
- * - RTL language support
- *
- * @example
- * <Tab.Button id="tab1" controls="panel1" onClick={(e, index) => console.log('Tab clicked:', index)}>
- *   First Tab
- * </Tab.Button>
- */
+/** Selectable tab associated with a tab panel. */
 export declare const TabButton: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref">, "onClick" | "disabled"> & {
-    /**
-     * Unique identifier for the tab button.
-     */
+    /** Used by the associated panel as its accessible label reference. */
     id: string;
-    /**
-     * ID of the tab panel that this button controls.
-     */
+    /** Must match the associated `Tab.Panel` `id`. */
     controls: string;
-    /**
-     * Callback function called when the tab button is clicked.
-     * @param e The mouse event
-     * @param index The index of the tab button
-     */
+    /** Runs before selection updates and receives this button's tab index. */
     onClick?: (e: MouseEvent<HTMLButtonElement>, index?: number) => void;
 } & DataTrackingId & import('react').RefAttributes<HTMLButtonElement>>;

package/dist/src/components/Tab/TabList.d.ts

@@ -1,26 +1,7 @@
 import { ComponentPropsWithoutRef } from 'react';
 /**
- * Props for the TabList component
  * @extends ComponentPropsWithoutRef<"div">
  */
 export type TabListProps = ComponentPropsWithoutRef<"div">;
-/**
- * TabList component for containing and managing tab buttons.
- *
- * Features:
- * - Horizontal scrolling for overflow tabs
- * - Navigation arrows for overflow content
- * - RTL language support
- * - Automatic overflow detection
- * - Proper ARIA roles for accessibility
- * - Smooth scrolling behavior
- * - Visual indicator positioning
- *
- * @example
- * <Tab.List>
- *   <Tab.Button id="tab1" controls="panel1">First Tab</Tab.Button>
- *   <Tab.Button id="tab2" controls="panel2">Second Tab</Tab.Button>
- *   <Tab.Button id="tab3" controls="panel3">Third Tab</Tab.Button>
- * </Tab.List>
- */
+/** Scrollable tablist that reveals navigation controls when tabs overflow. */
 export declare const TabList: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & import('react').RefAttributes<HTMLDivElement>>;