@servicetitan/anvil2 3.14.0 → 3.15.0

package/dist/src/components/Menu/internal/MenuContext.d.ts

@@ -1,15 +1,6 @@
 import { MenuProps } from '../Menu';
-/**
- * Context props for Menu components
- */
 export type MenuContextProps = {
-    /**
-     * Function to close the root menu
-     */
     closeRootMenu: () => void;
-    /**
-     * Whether auto height is disabled
-     */
     disableAutoHeight: MenuProps["disableAutoHeight"];
 };
 export declare const MenuContext: import('react').Context<MenuContextProps | null>;

package/dist/src/components/Menu/internal/MenuNested.d.ts

@@ -1,42 +1,9 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { IconProps } from '../../Icon';
 import { MenuCommonProps } from '../types';
-/**
- * Props for the MenuNested component
- * @extends ComponentPropsWithoutRef<"button">
- * @extends MenuCommonProps
- */
 export type MenuNestedProps = ComponentPropsWithoutRef<"button"> & MenuCommonProps & {
-    /**
-     * Icon to display on the nested menu button
-     */
+    /** Shown before the default submenu trigger's label. */
     icon?: IconProps["svg"];
 };
-/**
- * MenuNested component for creating nested submenus within a Menu.
- *
- * Features:
- * - Hover-based menu opening and closing
- * - Automatic positioning with fallback strategies
- * - Keyboard navigation with arrow keys
- * - Scroll indicators for overflow content
- * - Automatic height adjustment
- * - Focus management and accessibility
- * - Popover API support with legacy fallback
- * - Smooth transitions and animations
- * - Context integration with parent menus
- *
- * @example
- * <Menu label="Edit">
- *   <Menu.Item label="Cut" onClick={() => console.log('Cut clicked')} />
- *   <Menu label="Copy as">
- *     <Menu.Item label="Text" onClick={() => console.log('Copy as Text')} />
- *     <Menu.Item label="Video" onClick={() => console.log('Copy as Video')} />
- *     <Menu label="Image">
- *       <Menu.Item label=".png" onClick={() => console.log('Copy as PNG')} />
- *       <Menu.Item label=".jpg" onClick={() => console.log('Copy as JPG')} />
- *     </Menu>
- *   </Menu>
- * </Menu>
- */
+/** Implements nested `Menu` instances as horizontally positioned submenus. */
 export declare const MenuNested: (props: MenuNestedProps) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/Menu/internal/menuSelectors.d.ts

@@ -1,4 +1 @@
-/**
- * Returns a selector for focusable menu items within a scroller element.
- */
 export declare const getMenuFocusableItemsSelector: (scrollerId: string) => string;

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

@@ -1,87 +1,79 @@
 import { Placement, UseFloatingOptions } from '@floating-ui/react';
 import { AriaAttributes, FocusEvent, KeyboardEvent, MouseEvent, ReactElement, Ref } from 'react';
 /**
- * Props supplied to a `trigger` render function, for both root and nested menus.
- *
- * Spread all of them onto the returned element. Every prop is optional, so
- * dropping one still type-checks — but `role`, `data-anv`, and `tabIndex` are what
- * the parent menu's focus query matches on, and a trigger missing them is skipped
- * by keyboard navigation.
+ * Props supplied to a custom trigger. Spread them onto the returned element;
+ * nested trigger semantics participate in the parent's keyboard navigation.
  */
 export type MenuReturnProps = {
+    /** Not supplied by root or nested menus. */
     "data-open"?: boolean;
+    /** Matches the menu popover's `id`. */
     "aria-controls"?: AriaAttributes["aria-controls"];
+    /** Follows internal or controlled open state. */
     "aria-expanded"?: AriaAttributes["aria-expanded"];
+    /** Always `true` on root and nested triggers. */
     "aria-haspopup"?: AriaAttributes["aria-haspopup"];
+    /** Open state for styling the trigger. */
     "data-state": "open" | "close";
     /** Marks the trigger as a focusable menu item. Nested menus only. */
     "data-anv"?: "menu-item";
-    /** Nested menus only. */
+    /** Supplies menu-item semantics to nested triggers. */
     role?: "menuitem";
+    /** Associates a nested trigger with roving focus. */
     id?: string;
     /** Roving tab index — `0` while the item is focused, `-1` otherwise. */
     tabIndex?: number;
     className?: string;
+    /** Toggles a root menu or opens a nested menu. */
     onClick?: () => void;
+    /** Root: Escape closes and ArrowDown enters. Nested: ArrowRight opens. */
     onKeyDown?: (e: KeyboardEvent<HTMLElement>) => void;
+    /** Nested only; sets the next rendered `tabIndex` to `0`. */
     onFocus?: (e: FocusEvent<HTMLElement>) => void;
+    /** Nested only; returns the next rendered `tabIndex` to `-1`. */
     onBlur?: (e: FocusEvent<HTMLElement>) => void;
+    /** Focuses nested triggers on pointer entry. */
     onMouseEnter?: (e: MouseEvent<HTMLElement>) => void;
+    /** Attach to the trigger element for positioning and focus restoration. */
     ref?: Ref<HTMLButtonElement>;
 };
 /**
- * Common props shared between Menu components
- * @extends ComponentPropsWithoutRef<"button">
+ * Behavior shared by root and nested menus.
  */
 export type MenuCommonProps = {
-    /**
-     * Disables the shift of floating element
-     * @internal
-     */
+    /** Ignored by menu positioning. @internal */
     disableShift?: boolean;
-    /**
-     * Disables the flip of floating element
-     * @internal
-     */
+    /** Ignored by menu positioning. @internal */
     disableFlip?: boolean;
-    /**
-     * Disables the flip cross-axis fallback of floating element
-     * @internal
-     */
+    /** Ignored by menu positioning. @internal */
     disableFlipFallback?: boolean;
+    /** Preferred root-menu placement. Nested menus open horizontally. Defaults to `bottom-start`. */
+    placement?: Extract<Placement, "bottom-start" | "top-start" | "bottom-end" | "top-end">;
     /**
-     * Changes height and positioning for select/combobox
-     * @default bottom-start
+     * Controlled visibility.
+     * @deprecated Menu should open through user interaction. Scheduled for removal in the next major.
      */
-    placement?: Extract<Placement, "bottom-start" | "top-start" | "bottom-end" | "top-end">;
-    /** @deprecated to be removed on next major - Menu should open by user interaction */
     open?: boolean;
-    /** @deprecated to be removed on next major - Menu should open by user interaction */
-    defaultOpen?: boolean;
     /**
-     * Callback fired when the menu opens or closes
+     * Initial visibility in uncontrolled mode. Defaults to `false`.
+     * @deprecated Menu should open through user interaction. Scheduled for removal in the next major.
      */
+    defaultOpen?: boolean;
+    /** Ignored; visibility changes do not emit a callback. */
     onOpenChange?: UseFloatingOptions["onOpenChange"];
-    /**
-     * Callback fired when clicking outside the menu
-     */
+    /** Called on pointer down outside the root menu and its trigger. */
     onOutsidePress?: (e: globalThis.MouseEvent) => void;
-    /**
-     * Disables automatic height adjustment for the menu
-     */
+    /** Prevents viewport-constrained height and vertical shifting. */
     disableAutoHeight?: boolean;
     /**
      * Custom trigger element render function. Spread the supplied props onto the
      * element you return, including `ref`.
      */
     trigger?: (props: MenuReturnProps) => ReactElement;
-    /**
-     * The label text displayed on the menu button
-     */
+    /** Content of the default trigger; optional when using `trigger`. */
     label?: string;
+    /** Applies a class to the root menu content rather than its trigger. */
     contentClassName?: string;
-    /**
-     * Maximum height of the popover content
-     */
+    /** Caps root-menu content height after viewport sizing. */
     maxHeight?: number | string;
 };

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

@@ -1,24 +1,6 @@
 import { MultiSelectFieldHandle, MultiSelectFieldProps } from './types';
 import { ForwardedRef, ReactNode } from 'react';
-/**
- * MultiSelectField component: a form field for selecting multiple options at once from a searchable dropdown, showing the chosen values as tags or chips.
- *
- * Features:
- * - Multiple selection with chip display
- * - Search and filtering capabilities (disable with `disableSearch`)
- * - Lazy loading with pagination (page, offset, or group modes)
- * - Optional "Select All" functionality
- * - Optional "Select Filtered" functionality (selects options matching current search)
- * - Sticky positioning for Select All / Select Filtered items
- * - Supports both popover and dialog display modes
- * - Adaptive display based on device (mobile uses dialog)
- * - Cache support for loadOptions results
- * - Single row mode to restrict height (singleRow prop)
- * - Chip count limiting (maxChips prop)
- * - Full accessibility support with ARIA attributes
- * - Controlled selection state
- * - Optional "Add new item" affordance below the option list with consumer-owned dialog
- */
+/** Controlled multi-select field. Searchable combobox unless `disableSearch`; selected values render as chips. */
 export declare const MultiSelectField: <TID extends string | number = string | number>(propsWithLayout: MultiSelectFieldProps<TID> & {
     ref?: ForwardedRef<MultiSelectFieldHandle>;
 }) => ReactNode;

package/dist/src/components/MultiSelectField/MultiSelectFieldSync.d.ts

@@ -2,18 +2,12 @@ import { MatchSorterOptions } from 'match-sorter';
 import { MultiSelectFieldProps, MultiSelectFieldOption } from './types';
 import { SyncFilterFn } from '../../internal/functions/syncFilterUtils';
 export type MultiSelectFieldSyncProps<TID extends string | number = string | number> = Omit<MultiSelectFieldProps<TID>, "loadOptions" | "lazy" | "debounceMs" | "cache" | "initialLoad" | "selectAll" | "selectFiltered"> & {
-    /**
-     * The options to display in the multi-select field.
-     */
+    /** In-memory options. Search filters this list instead of calling `loadOptions`. */
     options: MultiSelectFieldOption<TID>[];
     /**
-     * Controls how options are filtered and sorted when the user types a search value.
-     * Can be a function that returns options in the desired display order,
-     * or a MatchSorterOptions object to customize the default match-sorter behavior.
-     *
-     * Before any search is performed, options appear in the order they are supplied.
-     * By default, options are filtered by `label` and `searchText` using match-sorter,
-     * which also ranks results by match quality (best matches first).
+     * Filter and sort as the user types. A function returns the display order;
+     * a match-sorter options object customizes the default. Defaults to
+     * match-sorter on `label` and `searchText`.
      *
      * @example
      * <MultiSelectFieldSync
@@ -33,69 +27,20 @@ export type MultiSelectFieldSyncProps<TID extends string | number = string | num
      */
     filter?: SyncFilterFn<TID, MultiSelectFieldOption<TID>> | MatchSorterOptions<MultiSelectFieldOption<TID>>;
     /**
-     * Enables the "Select All" option at the top of the list.
-     * Can be a boolean to enable with default label, or an object to customize the label.
-     * Click handling and check state are managed automatically based on the options and value.
-     *
-     * Select All and Select Filtered are mutually exclusive:
-     * - Select All is shown when the search input is empty.
-     * - Select Filtered (if enabled) is shown when a search term is active.
-     *
-     * The label can be a string or a function that receives a boolean indicating whether all options are selected.
-     *
-     * @example
-     * <MultiSelectFieldSync selectAll options={options} {...props} />
-     *
-     * @example
-     * <MultiSelectFieldSync selectAll={{ label: "Select All Items" }} options={options} {...props} />
-     *
-     * @example
-     * <MultiSelectFieldSync
-     *   selectAll={{ label: (checked) => checked ? "Deselect All" : "Select All" }}
-     *   options={options}
-     *   {...props}
-     * />
+     * Select All when search is empty. `true` uses the default label; an object
+     * customizes the label. Click and check state are owned by Sync.
      */
     selectAll?: boolean | {
         label?: string | ((checked: boolean) => string);
     };
     /**
-     * Enables the "Select Filtered" option when a search term is active.
-     * Can be a boolean to enable with default label, or a function that receives the
-     * search value and returns a config object with a custom label.
-     * Click handling and check state are managed automatically based on the filtered options and value.
-     *
-     * When clicked, all enabled options matching the current search term are selected (or deselected if all are already selected).
-     *
-     * Select All and Select Filtered are mutually exclusive:
-     * - Select All (if enabled) is shown when the search input is empty.
-     * - Select Filtered is shown when a search term is active.
-     *
-     * @example
-     * <MultiSelectFieldSync selectAll selectFiltered options={options} {...props} />
-     *
-     * @example
-     * <MultiSelectFieldSync
-     *   selectFiltered={(searchValue) => ({
-     *     label: `Select items matching "${searchValue}"`,
-     *   })}
-     *   options={options}
-     *   {...props}
-     * />
+     * Select Filtered when search is non-empty. `true` uses the default label;
+     * a function may return a custom label. Click and check state are owned by
+     * Sync.
      */
     selectFiltered?: boolean | ((searchValue: string) => {
         label?: string;
     });
 };
-/**
- * MultiSelectFieldSync is a simplified version of MultiSelectField that is used to display a list of options in a multi-select field.
- *
- * Features:
- * - Accepts `options` instead of `loadOptions` and `lazy`.
- * - Performs client-side filtering of the options.
- * - Optionally accepts a function to filter the options, or a MatchSorterOptions object to customize the default filtering.
- * - Simplified `selectAll` prop that automatically handles click and check state.
- * - Simplified `selectFiltered` prop that automatically selects/deselects filtered options.
- * - Supports all the other props of MultiSelectField.
- */
+/** {@link MultiSelectField} for a client-side `options` list. */
 export declare const MultiSelectFieldSync: <TID extends string | number>(props: MultiSelectFieldSyncProps<TID>) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/MultiSelectField/internal/MultiSelectFieldComboboxMode.d.ts

@@ -1,5 +1,3 @@
 import { MultiSelectFieldComboboxInternalProps } from './types';
-/**
- * Combobox mode: searchable multi-select using useCombobox.
- */
+/** Searchable combobox rendering mode. */
 export declare const MultiSelectFieldComboboxMode: <TID extends string | number>({ labelAiMark, id, helperUid, selectedOptions, onSelectedOptionsChange, displayAs, isDisabledOrReadOnly, disabled, readOnly, isHighlighted, required, placeholder, size, error, hasHelperText, disableClearButton, prefix, suffix, label, hideLabel, hint, moreInfo, moreInfoId, errorMessages, warning, description, className, style, layoutStyles, pinned, groupToString, groupSorter, virtualize, options, loading, loadingMore, hasMore, loadOptions, loadMore, initialLoad, initialLoadPerformed, setInitialLoadPerformed, inputWrapperRef, debounceMs, selectAll, selectFiltered, bulkPending, onBulkActivate, singleRow, maxChips, getChipProps, onSearchChange, addItemLabel, onAddNewItem, handleRemoveOption, handleClear, dataAttributes, }: MultiSelectFieldComboboxInternalProps<TID>) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/MultiSelectField/internal/MultiSelectFieldInput.d.ts

@@ -1,29 +1,6 @@
 import { PassThroughProps, Size } from '../../../types';
 import { ReactElement, RefObject, MouseEvent } from 'react';
 import { MultiSelectFieldChipProps, MultiSelectFieldOption } from '../types';
-/**
- * Props for the MultiSelectFieldInput component
- * @property {string} [placeholder] - Placeholder text displayed when input is empty
- * @property {Extract<Size, "small" | "medium" | "large">} [size] - Size variant of the input
- * @property {boolean} [disableClearButton] - Hides the clear button when true
- * @property {boolean} [disableToggleButton] - Hides the toggle button when true
- * @property {boolean} [disabled] - Disables the input entirely
- * @property {boolean} [readOnly] - Cannot be modified but remains interactive
- * @property {boolean} [isHighlighted] - Applies a subdued primary background to draw attention to the field
- * @property {boolean} [error] - Shows error styling on the input when true
- * @property {() => void} [onClear] - Callback fired when the clear button is clicked
- * @property {string} [id] - HTML id attribute for the input element
- * @property {RefObject<HTMLDivElement>} [inputWrapperRef] - Ref for the input wrapper div element
- * @property {PassThroughProps<"div">} [htmlInputWrapperProps] - Additional props passed to the wrapper div
- * @property {PassThroughProps<"input">} [inputProps] - Additional props passed to the input element
- * @property {PassThroughProps<"button">} [toggleButtonProps] - Additional props passed to the toggle button
- * @property {string | ReactElement} [prefix] - Content to display before the input
- * @property {string | ReactElement} [suffix] - Content to display after the input
- * @property {MultiSelectFieldOption[]} [selectedOptions] - Array of selected options to display as chips
- * @property {(option: MultiSelectFieldOption) => void} [onRemoveOption] - Callback when a chip is removed
- * @property {boolean} [singleRow] - When true, restricts the field to a single row height
- * @property {number} [maxChips] - Maximum number of chips to display before showing +N indicator (default: 10)
- */
 export type MultiSelectFieldInputProps<TID extends string | number> = {
     placeholder?: string;
     size?: Extract<Size, "small" | "medium" | "large">;
@@ -48,32 +25,7 @@ export type MultiSelectFieldInputProps<TID extends string | number> = {
     getChipProps?: (option: MultiSelectFieldOption<TID>) => MultiSelectFieldChipProps;
     onWrapperClick?: (e: MouseEvent<HTMLDivElement>) => void;
 };
-/**
- * Internal input component for the MultiSelectField that provides the text input,
- * chip display for selected options, and action buttons.
- *
- * Features:
- * - Text input for filtering options
- * - Chip display for selected options with remove functionality
- * - Optional clear button for removing all selections
- * - Optional toggle button for opening/closing the dropdown menu
- * - Supports multiple size variants (small, medium, large)
- * - Fully accessible with proper ARIA labels on buttons
- * - Supports pass-through props for customization of internal elements
- * - Optional prefix and suffix content
- * - Error state styling
- * - Single row mode with singleRow prop
- * - Chip count limiting with maxChips prop
- *
- * @example
- * <MultiSelectFieldInput
- *   placeholder="Search..."
- *   size="medium"
- *   selectedOptions={[{ id: 1, label: "Option 1" }]}
- *   onRemoveOption={(option) => handleRemove(option)}
- *   onClear={() => handleClearAll()}
- * />
- */
+/** Search input with selected-option chips and field controls. */
 export declare const MultiSelectFieldInput: {
     <TID extends string | number>({ placeholder, size, disableClearButton, disableToggleButton, disabled, readOnly, isHighlighted, error, onClear, id, inputWrapperRef, htmlInputWrapperProps, inputProps, toggleButtonProps, prefix, suffix, selectedOptions, onRemoveOption, singleRow, maxChips, getChipProps, onWrapperClick, }: MultiSelectFieldInputProps<TID>): import("react/jsx-runtime").JSX.Element;
     displayName: string;

package/dist/src/components/MultiSelectField/internal/MultiSelectFieldSelectMode.d.ts

@@ -1,6 +1,3 @@
 import { MultiSelectFieldBaseInternalProps } from './types';
-/**
- * Select mode: non-searchable multi-select using useSelect.
- * Active when disableSearch is true.
- */
+/** Listbox rendering mode used when `disableSearch` is true. */
 export declare const MultiSelectFieldSelectMode: <TID extends string | number>({ labelAiMark, id, helperUid, selectedOptions, onSelectedOptionsChange, displayAs, isDisabledOrReadOnly, disabled, readOnly, isHighlighted, required, placeholder, size, error, hasHelperText, disableClearButton, prefix, suffix, label, hideLabel, hint, moreInfo, moreInfoId, errorMessages, warning, description, className, style, layoutStyles, pinned, groupToString, groupSorter, virtualize, options, loading, loadingMore, hasMore, loadOptions, loadMore, initialLoad, initialLoadPerformed, setInitialLoadPerformed, inputWrapperRef, selectAll, bulkPending, onBulkActivate, singleRow, maxChips, getChipProps, addItemLabel, onAddNewItem, handleRemoveOption, handleClear, dataAttributes, }: MultiSelectFieldBaseInternalProps<TID>) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/MultiSelectField/internal/MultiSelectFieldTrigger.d.ts

@@ -22,10 +22,7 @@ export type MultiSelectFieldTriggerProps<TID extends string | number> = {
     maxChips?: number;
     getChipProps?: (option: MultiSelectFieldOption<TID>) => MultiSelectFieldChipProps;
 };
-/**
- * Non-searchable trigger for MultiSelectField when disableSearch is true.
- * Renders chips for selected items in a div-based trigger (no input element).
- */
+/** Listbox trigger with selected-option chips. */
 export declare const MultiSelectFieldTrigger: {
     <TID extends string | number>({ placeholder, size, disableClearButton, disabled, readOnly, isHighlighted, error, onClear, id, inputWrapperRef, toggleButtonProps, prefix, suffix, selectedOptions, onRemoveOption, singleRow, maxChips, getChipProps, popoverTarget, }: MultiSelectFieldTriggerProps<TID>): import("react/jsx-runtime").JSX.Element;
     displayName: string;

package/dist/src/components/MultiSelectField/internal/types.d.ts

@@ -54,7 +54,6 @@ export type MultiSelectFieldBaseInternalProps<TID extends string | number> = {
     };
     /** True while a `compute`-driven bulk action's promise is in flight. */
     bulkPending: boolean;
-    /** Called when the user activates the select-all or select-filtered row. */
     onBulkActivate: (kind: "selectAll" | "selectFiltered", searchValue: string) => void;
     singleRow?: boolean;
     maxChips?: number;
@@ -63,7 +62,6 @@ export type MultiSelectFieldBaseInternalProps<TID extends string | number> = {
         id: string | number;
     }) => void;
     handleClear: () => void;
-    /** Consumer-supplied `data-*` attributes forwarded to the field wrapper. */
     dataAttributes?: DataAttributes;
 } & AddNewItemProps;
 export type MultiSelectFieldComboboxInternalProps<TID extends string | number> = MultiSelectFieldBaseInternalProps<TID> & {

package/dist/src/components/MultiSelectField/internal/useChipLayout.d.ts

@@ -4,13 +4,7 @@ type UseChipLayoutOptions = {
     singleRow?: boolean;
     maxChips?: number;
 };
-/**
- * Manages chip layout calculations shared between MultiSelectFieldInput and
- * MultiSelectFieldTrigger. Handles single-row overflow detection, visible chip
- * count, and the "+N" hidden chip indicator.
- * @param options - Configuration for chip layout behaviour
- * @returns rowsRef to attach to the chip container, plus computed display/hidden counts
- */
+/** Measures single-row chip overflow and reserves space for the `+N` chip. */
 export declare function useChipLayout({ selectedOptionsLength, singleRow, maxChips, }: UseChipLayoutOptions): {
     rowsRef: RefObject<HTMLDivElement>;
     displayCount: number;

package/dist/src/components/MultiSelectField/internal/useComboMultiple.d.ts

@@ -3,48 +3,31 @@ import { MultiSelectFieldGroupByValue, MultiSelectFieldOption, MultiSelectFieldP
 import { SelectItem } from '../../../internal/types/selectFieldInternalTypes';
 import { CheckState } from '../../../types';
 export type UseComboMultipleOptions<TID extends string | number = string | number> = {
-    /** An array of currently loaded options */
     options: MultiSelectFieldOption<TID>[];
-    /** Options to pin to the top of the list */
     pinned?: MultiSelectFieldPinnedOptions<TID>;
-    /** Function to convert a group value to a display label */
     groupToString?: (groupValue: MultiSelectFieldGroupByValue) => string;
-    /** Function to sort group sections */
     groupSorter?: (a: MultiSelectFieldGroupByValue, b: MultiSelectFieldGroupByValue) => number;
-    /** Configuration for the "Select All" option (shown when search is empty). */
     selectAll?: {
         label: string;
         checkState: CheckState;
     };
-    /** Function that receives the search value and returns config for "Select Filtered". */
     selectFiltered?: (searchValue: string) => {
         label?: string;
         checkState: CheckState;
     };
-    /** True while a `compute`-driven bulk action is in flight. Disables option rows. */
     bulkPending: boolean;
-    /** Called when the user activates the select-all or select-filtered row. */
     onBulkActivate: (kind: "selectAll" | "selectFiltered", searchValue: string) => void;
-    /** The currently selected options (controlled from outside) */
     selectedOptions: MultiSelectFieldOption<TID>[];
     onSelectedOptionsChange: (options: MultiSelectFieldOption<TID>[]) => void;
     displayAs: "popover" | "dialog";
     disabled: boolean;
-    /** Whether options are currently loading (hides select-filtered to prevent stale selections) */
+    /** Hides Select Filtered so it cannot act on stale results. */
     loading?: boolean;
-    /** Whether the list is virtualized (disables built-in scroll behavior) */
+    /** No-ops Downshift scrolling; the list still uses `onScrollToHighlight`. */
     virtualize?: boolean;
     onScrollToHighlight?: (index: number) => void;
 } & Pick<UseComboboxProps<SelectItem>, "onInputValueChange" | "onIsOpenChange">;
-/**
- * Hook that wraps downshift's useCombobox for multi-select behavior.
- * Unlike useCombo, this hook:
- * - Keeps the menu open after item selection
- * - Does not track internal selection state (controlled externally)
- * - Preserves input value on item selection for continued filtering
- * @param options - Configuration options for the hook
- * @returns Downshift combobox props and state
- */
+/** Adapts Downshift's combobox state for controlled, keep-open multi-selection. */
 export declare const useComboMultiple: <TID extends string | number>({ options, pinned, groupToString, groupSorter, selectAll, selectFiltered, bulkPending, onBulkActivate, selectedOptions, onSelectedOptionsChange, onInputValueChange, onIsOpenChange, displayAs, disabled, loading, virtualize, onScrollToHighlight, }: UseComboMultipleOptions<TID>) => {
     inputValue: string;
     wrapperDivRef: import('react').RefObject<HTMLDivElement>;

package/dist/src/components/MultiSelectField/internal/useSelectModeMultiple.d.ts

@@ -10,9 +10,7 @@ export type UseSelectModeMultipleOptions<TID extends string | number> = {
         label: string;
         checkState: CheckState;
     };
-    /** True while a `compute`-driven bulk action is in flight. Disables option rows. */
     bulkPending: boolean;
-    /** Called when the user activates the select-all row. */
     onBulkActivate: (kind: "selectAll" | "selectFiltered", searchValue: string) => void;
     selectedOptions: MultiSelectFieldOption<TID>[];
     onSelectedOptionsChange: (options: MultiSelectFieldOption<TID>[]) => void;
@@ -24,10 +22,7 @@ export type UseSelectModeMultipleOptions<TID extends string | number> = {
     virtualize?: boolean;
     onScrollToHighlight?: (index: number) => void;
 };
-/**
- * Wraps downshift's useSelect for non-searchable multi-select fields.
- * Keeps menu open after selection and handles bulk actions.
- */
+/** Adapts Downshift's select state for controlled, keep-open multi-selection. */
 export declare const useSelectModeMultiple: <TID extends string | number>({ options, pinned, groupToString, groupSorter, selectAll, bulkPending, onBulkActivate, selectedOptions, onSelectedOptionsChange, onIsOpenChange, displayAs, disabled, virtualize, onScrollToHighlight, }: UseSelectModeMultipleOptions<TID>) => {
     wrapperDivRef: import('react').RefObject<HTMLDivElement>;
     getToggleButtonProps: <Options>(options?: import('downshift').UseSelectGetToggleButtonPropsOptions & Options, otherOptions?: import('downshift').GetPropsCommonOptions) => import('downshift').Overwrite<import('downshift').UseSelectGetToggleButtonReturnValue, Options>;

package/dist/src/components/MultiSelectField/parts.d.ts

@@ -1,15 +1,3 @@
-/**
- * `data-anv-part` names for MultiSelectField's interactive sub-elements.
- *
- * Scope a query by the consumer's `data-cy` on the field root
- * (`[data-cy="x"] [data-anv-part="input"]`). Portaled parts (`menu`, `option`,
- * `dialog`, `popover`) come from the shared option internals and render in the
- * top layer — target them by part attribute or the field's `#{id}-popover` /
- * `#{id}-dialog`.
- *
- * Every role MultiSelectField needs is a shared one, so all values come from
- * `COMMON_PART`.
- */
 export declare const PARTS: {
     readonly trigger: "trigger";
     readonly input: "input";