@servicetitan/anvil2 3.14.1 → 3.15.0

package/dist/src/components/MultiSelectMenu/types.d.ts

@@ -5,30 +5,21 @@ import { MultiSelectFieldCacheOptions, MultiSelectFieldEagerLoader, MultiSelectF
 import { AddNewItemProps } from '../../internal/types/addNewItemTypes';
 import { ConfirmationProp } from '../../internal/types/confirmationTypes';
 import { BulkActionConfig } from '../../internal/types/bulkActionTypes';
-/**
- * Configuration for the "Select All" / "Select Filtered" rows.
- */
+/** Select All / Select Filtered row. Alias of {@link BulkActionConfig}. */
 export type MultiSelectMenuBulkActionConfig<TID extends string | number = string | number> = BulkActionConfig<TID>;
-/**
- * Rich content configuration for a MultiSelectMenu option row.
- * Controls the avatar, icon, description, and chip display within an option.
- */
+/** Option-row extras (avatar, icon, description, chip). Alias of {@link SelectFieldOptionContent}. */
 export type MultiSelectMenuOptionContent = SelectFieldOptionContent;
+/** Alias of {@link SelectFieldOption}. */
 export type MultiSelectMenuOption<TID extends string | number = string | number> = SelectFieldOption<TID>;
+/** Alias of {@link SelectFieldGroupByValue}. */
 export type MultiSelectMenuGroupByValue = SelectFieldGroupByValue;
-/**
- * Configuration options for the MultiSelectMenu cache.
- * @property enabled - Whether caching is enabled. Defaults to true.
- * @property maxSize - Maximum number of cached entries before clearing the cache. Defaults to 15.
- */
+/** Alias of {@link MultiSelectFieldCacheOptions}. */
 export type MultiSelectMenuCacheOptions = MultiSelectFieldCacheOptions;
-/**
- * Imperative handle for the MultiSelectMenu component.
- * @property clearCache - Clears the options cache.
- * @property invalidate - Clears the cache and triggers a fresh options load from the data source.
- */
+/** Imperative cache control for a mounted {@link MultiSelectMenu}. */
 export type MultiSelectMenuHandle = {
+    /** Drops cached `loadOptions` results without fetching. */
     clearCache: () => void;
+    /** Drops the cache and fetches options again. */
     invalidate: () => void;
 };
 export type MultiSelectMenuEagerLoader<TID extends string | number = string | number> = MultiSelectFieldEagerLoader<TID>;
@@ -36,20 +27,21 @@ export type MultiSelectMenuPageLazyLoader<TID extends string | number = string |
 export type MultiSelectMenuOffsetLazyLoader<TID extends string | number = string | number> = MultiSelectFieldOffsetLazyLoader<TID>;
 export type MultiSelectMenuGroupLazyLoader<TID extends string | number = string | number> = MultiSelectFieldGroupLazyLoader<TID>;
 export type MultiSelectMenuPinnedOptions<TID extends string | number = string | number> = MultiSelectFieldPinnedOptions<TID>;
+/**
+ * Search-field control and debounce. Alias of {@link MultiSelectFieldSearchProps}.
+ * MultiSelectMenu defaults `debounceMs` to `200`.
+ */
 export type MultiSelectMenuSearchProps = MultiSelectFieldSearchProps;
 /**
- * Props provided to the trigger render function.
- * @property ref - Ref to attach to the trigger element for positioning
- * @property onClick - Click handler to toggle the menu
- * @property onKeyDown - Key handler for keyboard navigation
- * @property aria-haspopup - ARIA attribute indicating the trigger opens a listbox
- * @property aria-controls - ARIA attribute linking to the menu element
- * @property aria-expanded - ARIA attribute indicating whether the menu is open
- * @property data-state - Data attribute indicating the open/close state
+ * Props spread onto the trigger render-prop element. `data-state` uses `"close"`,
+ * not `"closed"`. Consumer `data-*` on {@link MultiSelectMenu} merge into this bag.
  */
 export type MultiSelectMenuTriggerProps = {
+    /** Attach to the trigger so the popover can position against it. */
     ref: RefObject<HTMLButtonElement>;
+    /** Toggles the menu. */
     onClick: () => void;
+    /** Arrow keys open; Enter and Space toggle. */
     onKeyDown: (e: KeyboardEvent<HTMLButtonElement>) => void;
     "aria-haspopup": "listbox";
     "aria-controls": string;
@@ -58,131 +50,100 @@ export type MultiSelectMenuTriggerProps = {
 } & DataAttributes;
 type MultiSelectMenuCommonProps<TID extends string | number = string | number> = {
     /**
-     * The id of the multi-select menu.
+     * Prefix for the menu, popover, and dialog ids. Defaults to a generated id.
      */
     id?: string;
     /**
-     * Render function that receives trigger props and returns the element that opens the menu.
+     * Render the element that opens the menu. Spread the bag onto a focusable
+     * button-like host.
      */
     trigger: (props: MultiSelectMenuTriggerProps) => ReactElement;
     /**
-     * Called when a key is pressed inside the menu (search field or listbox), before the
-     * menu's own key handling. Use `e.preventDefault()` to suppress the default behavior.
+     * Called when a key is pressed inside the menu (search field or listbox),
+     * before the menu's own key handling. `e.preventDefault()` suppresses the
+     * default behavior.
      */
     onMenuKeyDown?: (e: KeyboardEvent) => void;
     /**
-     * Called when the menu closes implicitly — due to Tab navigation, clicking outside,
-     * or other ambient focus loss. Focus is not restored to the trigger in these cases.
+     * Called when the menu closes from Tab, outside click, or other ambient
+     * focus loss. Focus is not restored to the trigger.
      */
     onImplicitClose?: () => void;
     /**
-     * Called when the menu closes explicitly — the user intentionally dismissed it
-     * via Escape or toggling the trigger. Focus is restored to the trigger.
+     * Called when the menu closes from Escape or toggling the trigger. Focus
+     * is restored to the trigger. Selecting a row does not close the menu.
      */
     onExplicitClose?: () => void;
     /**
-     * Accessible label for the menu. Used by screen readers but not rendered visually.
+     * Accessible name for the listbox and dialog title. Not rendered on the
+     * trigger.
      */
     label: string;
     /**
-     * Placeholder text shown in the search input inside the menu.
+     * Placeholder for the in-menu search field. Unused when `disableSearch`.
      */
     searchPlaceholder?: string;
     /**
-     * The selected options. Must be controlled state.
+     * Controlled selected options. Pass `[]` for none.
      */
     value: MultiSelectMenuOption<TID>[];
     /**
-     * Callback fired when the selected options change.
-     * @param options - The new array of selected options.
+     * Called with the next committed selection. With `confirmation`, fires on
+     * Apply rather than each row click.
      */
     onSelectedOptionsChange: (options: MultiSelectMenuOption<TID>[]) => void;
     /**
-     * Defines the initial loading behavior of the options.
-     * @default "auto"
+     * When `loadOptions` first runs. `"auto"` is `"immediate"` (mount). `"open"`
+     * waits for the first open. Defaults to `"auto"`.
      */
     initialLoad?: "auto" | "immediate" | "open";
-    /**
-     * Options to pin to the top of the list.
-     */
+    /** Favorites, recents, and similar sections. */
     pinned?: MultiSelectMenuPinnedOptions<TID>;
-    /**
-     * Configuration for caching loadOptions results.
-     * Caching is enabled by default. Set `{ enabled: false }` to disable.
-     */
+    /** Per-search `loadOptions` cache. Enabled by default; pass `{ enabled: false }` to disable. */
     cache?: MultiSelectMenuCacheOptions;
     /**
-     * Controls how the menu is displayed.
-     * @default "auto"
-     * @description "auto" uses a popover on desktop and a dialog on mobile.
-     * @description "popover" always uses a popover.
-     * @description "dialog" always uses a dialog.
+     * Menu surface. `"auto"` is a dialog on mobile and a popover otherwise.
+     * Defaults to `"auto"`.
      */
     displayMenuAs?: "auto" | "popover" | "dialog";
     /**
-     * Whether to virtualize the list using windowed rendering.
-     * @default false
+     * Windowed option rendering for large lists. Defaults to `false`.
      */
     virtualize?: boolean;
     /**
-     * Whether to disable the search input inside the menu.
-     * @default false
+     * Hides the in-menu search field. Defaults to `false`.
      */
     disableSearch?: boolean;
     /**
-     * Configuration for the "Select All" option at the top of the list.
-     * Shown when the search input is empty.
-     *
-     * Pass exactly one of `onClick` (fire-and-forget; the consumer commits via
-     * `onSelectedOptionsChange`) or `compute` (returns the next selection;
-     * integrates with confirmation drafts and supports async resolution).
-     *
-     * `compute` is required when you want the action to participate in the
-     * confirmation draft. While a `compute` promise is pending, the menu shows
-     * a loading state, disables all options, and disables Apply.
-     *
-     * `checkState` may be a static value or a function of the current selection
-     * (the confirmation draft when confirmation is enabled, otherwise the
-     * committed value), so the row's checkbox can reflect how much of the set is
-     * selected.
+     * Select All row when search is empty. Pass `onClick` (consumer commits) or
+     * `compute` (writes the next selection; required for confirmation drafts).
+     * Pending `compute` disables rows. `checkState` may be static or a function
+     * of the current selection (draft when confirmation is on).
      */
     selectAll?: MultiSelectMenuBulkActionConfig<TID>;
     /**
-     * Function that receives the current search value and returns configuration for
-     * the "Select Filtered" option at the top of the list.
-     * Shown when a search term is active (instead of Select All).
-     *
-     * See `selectAll` for the `onClick` / `compute` choice.
+     * Select Filtered row when search is non-empty. Same `onClick` / `compute`
+     * choice as `selectAll`. Unused when `disableSearch`.
      */
     selectFiltered?: (searchValue: string) => MultiSelectMenuBulkActionConfig<TID>;
     /**
-     * Width of the popover. Only applies when `displayMenuAs="popover"` (or when the adaptive mode resolves to popover). Has no effect in dialog mode.
-     * Accepts a CSS width value or "reference" to match the trigger element's width.
-     * @default 320
+     * Popover width. `"reference"` matches the trigger. Ignored in dialog
+     * mode. Defaults to `320`.
      */
     popoverWidth?: "reference" | number | string;
     /**
-     * When set, the menu becomes a buffered selection: clicks update a draft
-     * value inside the open menu, and `onSelectedOptionsChange` only fires when
-     * the user clicks Apply. Dismissing the menu (Escape, click outside,
-     * toggling the trigger) discards the draft. Pass `true` for the default
-     * "Apply" / "Cancel" labels, or an object to customize.
-     *
-     * Note: a `selectAll` / `selectFiltered` row configured with `onClick`
-     * bypasses the draft and applies immediately. Use the `compute` variant
-     * to integrate the bulk action with the draft.
-     * @default undefined (off — selections apply immediately)
+     * Buffers clicks in a draft until Apply. Dismiss (Escape, outside click,
+     * trigger toggle) discards the draft. `true` uses default Apply/Cancel
+     * labels; pass an object to customize. Off by default (commits immediately).
      */
     confirmation?: ConfirmationProp;
     /**
-     * Configures a "Clear" button in the menu footer. Presence of this prop
-     * enables the button; omit to suppress.
+     * Adds a footer Clear button. Omit to hide it.
      *
-     * - `onClick` — called when the user clicks Clear.
-     * - `label` — button label (default "Clear").
-     * - `disabled` — whether the button is inert. Filter adapters typically
-     *   tie this to `!isActive(filter)` so the button is dim when nothing is
-     *   selected.
+     * `onClick` runs, then the menu closes and focus returns to the trigger.
+     * With confirmation, that close is treated as a commit so the draft is
+     * not discarded. `label` defaults to `"Clear"`. `disabled` leaves the
+     * button inert.
      */
     clear?: {
         onClick: () => void;
@@ -192,11 +153,12 @@ type MultiSelectMenuCommonProps<TID extends string | number = string | number> =
 } & MultiSelectMenuSearchProps & AddNewItemProps & DataAttributes;
 type MultiSelectMenuGroupingProps = {
     /**
-     * Function to convert a group value to a display label.
+     * Turns an option `group` value into a section heading. Unused when options
+     * have no `group`.
      */
     groupToString?: (groupValue: MultiSelectMenuGroupByValue) => string;
     /**
-     * Custom comparator function to sort groups.
+     * Orders groups. Unused when options have no `group`.
      */
     groupSorter?: (a: MultiSelectMenuGroupByValue, b: MultiSelectMenuGroupByValue) => number;
 };
@@ -204,29 +166,44 @@ type MultiSelectMenuNonGroupingProps = {
     groupToString?: never;
     groupSorter?: never;
 };
+/** Page-number scroll loading. Grouping props are not allowed. */
 export type MultiSelectMenuPropsLazyPage<TID extends string | number = string | number> = MultiSelectMenuCommonProps<TID> & {
     lazy: "page";
     lazyOptions?: {
+        /** Options per `loadOptions` call. Defaults to `20`. */
         pageSize?: number;
     };
+    /** Called with search, page number, and page size. Return `{ options, hasMore }`. */
     loadOptions: MultiSelectMenuPageLazyLoader;
 } & MultiSelectMenuNonGroupingProps;
+/** Offset scroll loading. Grouping props are not allowed. */
 export type MultiSelectMenuPropsLazyOffset<TID extends string | number = string | number> = MultiSelectMenuCommonProps<TID> & {
     lazy: "offset";
     lazyOptions?: {
+        /** Options per `loadOptions` call. Defaults to `20`. */
         limit?: number;
     };
+    /** Called with search, offset, and limit. Return `{ options, hasMore }`. */
     loadOptions: MultiSelectMenuOffsetLazyLoader;
 } & MultiSelectMenuNonGroupingProps;
+/** Group-key scroll loading. */
 export type MultiSelectMenuPropsLazyGroup<TID extends string | number = string | number> = MultiSelectMenuCommonProps<TID> & {
     lazy: "group";
     lazyOptions?: object;
+    /** Called with search and the previous group key (`null` first). Return `{ options, hasMore }`. */
     loadOptions: MultiSelectMenuGroupLazyLoader;
 } & MultiSelectMenuGroupingProps;
+/** Eager `loadOptions`. */
 export type MultiSelectMenuPropsEager<TID extends string | number = string | number> = MultiSelectMenuCommonProps<TID> & {
+    /** Omit or `false`. Defaults to `false`. */
     lazy?: false;
+    /** Called with the current search. Return options or a promise of options. */
     loadOptions: MultiSelectMenuEagerLoader;
 } & MultiSelectMenuGroupingProps;
 export type MultiSelectMenuPropsLazy<TID extends string | number = string | number> = MultiSelectMenuPropsLazyPage<TID> | MultiSelectMenuPropsLazyOffset<TID> | MultiSelectMenuPropsLazyGroup<TID>;
+/**
+ * Multi-select menu. Discriminated by `lazy`: omit or `false` for eager
+ * `loadOptions`; `"page"` / `"offset"` / `"group"` for lazy loaders.
+ */
 export type MultiSelectMenuProps<TID extends string | number = string | number> = MultiSelectMenuPropsLazy<TID> | MultiSelectMenuPropsEager<TID>;
 export {};

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

@@ -3,7 +3,6 @@ import { HelperProps } from '../../internal/components';
 import { LayoutUtilProps, Size, DataTrackingId } from '../../types';
 import { FieldLabelProps } from '../../internal/types';
 /**
- * Props for the NumberField component.
  * @extends Omit<ComponentPropsWithoutRef<"input">, "size" | "prefix" | "type" | "inputMode" | "value" | "defaultValue" | "onFocus" | "onBlur" | "onChange">
  * @extends LayoutUtilProps
  * @extends FieldLabelProps
@@ -11,122 +10,159 @@ import { FieldLabelProps } from '../../internal/types';
  */
 export type NumberFieldProps = Omit<ComponentPropsWithoutRef<"input">, "size" | "prefix" | "type" | "inputMode" | "value" | "defaultValue" | "onFocus" | "onBlur" | "onChange"> & LayoutUtilProps & FieldLabelProps & {
     /**
-     * Error state for the field. Pass `true` to indicate error styling without a message.
-     * Pass a string, string[], or ReactElement (deprecated) for error messages.
+     * Applies error styling. A message value also renders below the field;
+     * React elements are deprecated.
      */
     error?: boolean | string | ReactElement | string[];
     /**
-     * Label for the field.
-     * Omitting `label` is deprecated — it will be required in v4.0.0. Use `hideLabel` to visually hide it.
+     * Accessible field label. Omitting it is deprecated; use `hideLabel` when
+     * the label should be visually hidden.
      */
     label?: string;
     /**
      * When `true`, hides the visible label and moves it to `aria-label` on the input.
      * Requires `label` to be set — the label is always needed for accessibility.
-     * @default false
+     * Defaults to `false`.
      */
     hideLabel?: boolean;
+    /** Text before the input; hidden from assistive technology. */
     prefix?: string;
+    /** Text after the input; hidden from assistive technology. */
     suffix?: string;
+    /** Field height. Defaults to `medium`. */
     size?: Extract<Size, "small" | "medium" | "large">;
+    /** Secondary copy rendered below the field. */
     description?: HelperProps["description"];
     /**
      * @deprecated No longer used. Error messages always use `aria-live="assertive"`.
      */
     errorAriaLive?: HelperProps["errorAriaLive"];
+    /** Always-visible hint rendered below the field. */
     hint?: HelperProps["hint"];
-    /**
-     * Warning message(s) to display. Supports a single string or an array of strings.
-     */
+    /** Warning copy rendered below the field. */
     warning?: string | string[];
+    /** Shows a spinner after the input. Defaults to `false`. */
     loading?: boolean;
     disabled?: boolean;
+    /** Lower bound for button and keyboard stepping. Defaults to `0`. */
     minValue?: number;
+    /**
+     * Upper bound for button and keyboard stepping.
+     * Defaults to `100000000000000`.
+     */
     maxValue?: number;
+    /**
+     * Limits and rounds decimal input. Raised to `minimumFractionDigits` when
+     * lower. Defaults to `0`.
+     */
     maximumFractionDigits?: number;
+    /** Pads the displayed value with trailing zeros. Defaults to `0`. */
     minimumFractionDigits?: number;
+    /**
+     * Absolute magnitude for button and keyboard changes. Defaults to `1`;
+     * zero also falls back to `1`.
+     */
     step?: number;
+    /** Numeric value in controlled mode; `null` displays an empty field. */
     value?: number | null;
+    /** Initial numeric value when uncontrolled. */
     defaultValue?: number | null;
+    /** Receives `null` for empty or unparseable input; a lone minus does not notify. */
     onChange?: (value: number | null) => void;
+    /** Called when focus enters the field or its stepper controls. */
     onFocus?: (event: React.FocusEvent) => void;
+    /** Called when focus leaves the field and its stepper controls. */
     onBlur?: (event: React.FocusEvent) => void;
+    /**
+     * Hides the stepper buttons without disabling keyboard stepping. Defaults
+     * to `false`.
+     */
     hideControls?: boolean;
     /**
-     * When `true`, applies a subdued primary background to the field to draw attention to it.
-     * @default false
+     * Applies a subdued primary background to draw attention to the field.
+     * Defaults to `false`.
      */
     isHighlighted?: boolean;
 } & DataTrackingId;
 /**
- * NumberField component for entering numeric values, with optional
- * increment/decrement stepper controls.
- *
- * Features:
- * - Min/max value constraints and configurable `step`
- * - Fraction-digit formatting via `minimumFractionDigits`/`maximumFractionDigits`
- * - Optional `hideControls` to hide the +/- stepper buttons
- * - Label, hint, description, error, and warning messaging
- * - Loading state with spinner, and a highlighted-field variant
- * - Optional prefix/suffix content
- *
- * @example
- * <NumberField
- *   label="Quantity"
- *   value={quantity}
- *   onChange={setQuantity}
- *   minValue={0}
- *   maxValue={99}
- * />
+ * Masked numeric input with increment and decrement controls. Supports
+ * controlled and uncontrolled numeric values, including an empty `null` state.
  */
 export declare const NumberField: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "ref">, "defaultValue" | "prefix" | "inputMode" | "onFocus" | "onBlur" | "onChange" | "size" | "value" | "type"> & LayoutUtilProps & Pick<import('../../internal').LabelProps, "required" | "moreInfo"> & {
     labelProps?: Omit<import('../../internal').LabelProps, "children" | "moreInfo" | "required" | "id" | "htmlFor"> & import('../..').AiMarkWithTooltipOrPopoverProps;
 } & {
     /**
-     * Error state for the field. Pass `true` to indicate error styling without a message.
-     * Pass a string, string[], or ReactElement (deprecated) for error messages.
+     * Applies error styling. A message value also renders below the field;
+     * React elements are deprecated.
      */
     error?: boolean | string | ReactElement | string[];
     /**
-     * Label for the field.
-     * Omitting `label` is deprecated — it will be required in v4.0.0. Use `hideLabel` to visually hide it.
+     * Accessible field label. Omitting it is deprecated; use `hideLabel` when
+     * the label should be visually hidden.
      */
     label?: string;
     /**
      * When `true`, hides the visible label and moves it to `aria-label` on the input.
      * Requires `label` to be set — the label is always needed for accessibility.
-     * @default false
+     * Defaults to `false`.
      */
     hideLabel?: boolean;
+    /** Text before the input; hidden from assistive technology. */
     prefix?: string;
+    /** Text after the input; hidden from assistive technology. */
     suffix?: string;
+    /** Field height. Defaults to `medium`. */
     size?: Extract<Size, "small" | "medium" | "large">;
+    /** Secondary copy rendered below the field. */
     description?: HelperProps["description"];
     /**
      * @deprecated No longer used. Error messages always use `aria-live="assertive"`.
      */
     errorAriaLive?: HelperProps["errorAriaLive"];
+    /** Always-visible hint rendered below the field. */
     hint?: HelperProps["hint"];
-    /**
-     * Warning message(s) to display. Supports a single string or an array of strings.
-     */
+    /** Warning copy rendered below the field. */
     warning?: string | string[];
+    /** Shows a spinner after the input. Defaults to `false`. */
     loading?: boolean;
     disabled?: boolean;
+    /** Lower bound for button and keyboard stepping. Defaults to `0`. */
     minValue?: number;
+    /**
+     * Upper bound for button and keyboard stepping.
+     * Defaults to `100000000000000`.
+     */
     maxValue?: number;
+    /**
+     * Limits and rounds decimal input. Raised to `minimumFractionDigits` when
+     * lower. Defaults to `0`.
+     */
     maximumFractionDigits?: number;
+    /** Pads the displayed value with trailing zeros. Defaults to `0`. */
     minimumFractionDigits?: number;
+    /**
+     * Absolute magnitude for button and keyboard changes. Defaults to `1`;
+     * zero also falls back to `1`.
+     */
     step?: number;
+    /** Numeric value in controlled mode; `null` displays an empty field. */
     value?: number | null;
+    /** Initial numeric value when uncontrolled. */
     defaultValue?: number | null;
+    /** Receives `null` for empty or unparseable input; a lone minus does not notify. */
     onChange?: (value: number | null) => void;
+    /** Called when focus enters the field or its stepper controls. */
     onFocus?: (event: React.FocusEvent) => void;
+    /** Called when focus leaves the field and its stepper controls. */
     onBlur?: (event: React.FocusEvent) => void;
+    /**
+     * Hides the stepper buttons without disabling keyboard stepping. Defaults
+     * to `false`.
+     */
     hideControls?: boolean;
     /**
-     * When `true`, applies a subdued primary background to the field to draw attention to it.
-     * @default false
+     * Applies a subdued primary background to draw attention to the field.
+     * Defaults to `false`.
      */
     isHighlighted?: boolean;
 } & DataTrackingId & import('react').RefAttributes<HTMLInputElement>>;

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

@@ -1,88 +1,44 @@
 import { ComponentPropsWithoutRef, MouseEvent, Ref } from 'react';
 import { DataTrackingId, LayoutUtilProps } from '../../types';
 /**
- * Props for the Overflow component
- * @property {string} [children] - The content to be displayed in the overflow container
- * @property {number | string | "inherit"} [height] - The height of the overflow container
- * @property {boolean | object} [truncate] - Whether to truncate content with expand/collapse functionality
+ * `truncate` is a union: omit or `false` for a scroller with edge shadows;
+ * a truthy/object form requires `direction: "column"` and adds expand/collapse.
  */
 export type OverflowProps = ComponentPropsWithoutRef<"div"> & Omit<LayoutUtilProps, "direction"> & {
-    /**
-     * The direction of the overflow container
-     * @default column
-     */
+    /** Main axis of the inner Flex. Defaults to `column`. */
     direction?: LayoutUtilProps["flexDirection"];
     /**
-     * The height of the overflow container
-     * @remarks "inherit" is not supported when truncate is enabled
+     * Size of the scroller. With `truncate`, applied as `min-height` instead.
+     * `"inherit"` is unsupported with `truncate`.
      */
     height?: number | string | "inherit";
-    /**
-     * The width of the overflow container
-     */
+    /** Size of the scroller. With `truncate`, applied as `min-width` instead. */
     width?: number | string;
     /**
-     * Ref to the scrollable content element (the inner element with `overflow: auto`).
-     * The component's own `ref` points at the outer wrapper, which does not scroll, so
-     * use this when an integration must target the actual scroller — e.g. a virtualizer's
-     * `getScrollElement`, an `IntersectionObserver` sentinel, or programmatic scrolling.
+     * The inner scroller (`overflow: auto`). The component `ref` is the
+     * non-scrolling wrapper — use this for virtualizers, sentinels, or
+     * programmatic scroll.
      */
     contentRef?: Ref<HTMLDivElement>;
 } & ({
-    /**
-     * Whether to truncate content with expand/collapse functionality
-     * @default false
-     */
+    /** Scrolling overflow with edge shadows. Defaults to `false`. */
     truncate?: false;
 } | {
-    /**
-     * Direction must be column when truncate is enabled
-     */
+    /** Required when `truncate` is set; row overflow is scroll-only. */
     direction: "column";
     /**
-     * Truncation configuration with expand/collapse functionality
+     * Clamps the column and shows expand/collapse when content is clipped.
+     * `true` uses the default button labels.
      */
     truncate: boolean | {
-        /**
-         * Text to display on the expand button
-         * @default "Show more..."
-         */
+        /** Expand control label. Boolean `true` uses `"Show more..."` instead. */
         expandText?: string;
-        /**
-         * Text to display on the collapse button
-         * @default "Show less..."
-         */
+        /** Collapse control label. Boolean `true` uses `"Show less..."` instead. */
         collapseText?: string;
-        /**
-         * Callback fired when content is expanded
-         */
+        /** Fires when the control expands the content. */
         onExpand?: (e: MouseEvent<HTMLButtonElement>) => void;
-        /**
-         * Callback fired when content is collapsed
-         */
+        /** Fires when the control collapses the content. */
         onCollapse?: (e: MouseEvent<HTMLButtonElement>) => void;
     };
 }) & DataTrackingId;
-/**
- * Overflow component for a scrollable container with edge shadow
- * indicators, and optional truncate-with-expand/collapse behavior.
- *
- * Features:
- * - Scrolls content that exceeds the configured `height`/`width`
- * - Shows shadow indicators on whichever edges have more content to scroll to
- * - Optional `truncate` mode (column direction only) with expand/collapse
- *   buttons and customizable button text
- * - `contentRef` exposes the actual scrolling element, separate from the
- *   outer wrapper `ref`, for integrations like virtualizers or IntersectionObserver
- *
- * @example
- * <Overflow height={200}>
- *   <LongContent />
- * </Overflow>
- *
- * @example
- * <Overflow direction="column" truncate={{ expandText: "Show more", collapseText: "Show less" }}>
- *   <LongContent />
- * </Overflow>
- */
 export declare const Overflow: import('react').ForwardRefExoticComponent<OverflowProps & import('react').RefAttributes<HTMLDivElement>>;