@servicetitan/anvil2 3.13.6 → 3.14.0

package/dist/src/internal/components/OptionsDialog/OptionsDialog.d.ts

@@ -1,12 +1,24 @@
 import { FocusableElement } from '../../..';
+/**
+ * Native modal host for select options. Sizes to the visual viewport.
+ */
 export declare const OptionsDialog: ({ id, isOpen, onClose, field, children, title, initialFocusResolver, footer, }: {
+    /** Scroll-lock and dialog identity. */
     id: string;
+    /** Calls `showModal` when true and `close` when false. */
     isOpen: boolean;
+    /** Escape, the cancel button, and host close paths. */
     onClose: () => void;
+    /** Accessible name rendered as the dialog `h1`. */
     title: string;
+    /** Optional search/trigger control above the list. */
     field?: React.ReactNode;
     children: React.ReactNode;
+    /**
+     * Picks initial focus among tabbables. Defaults to the first control that
+     * is not the cancel button.
+     */
     initialFocusResolver?: (focusables: FocusableElement[]) => FocusableElement;
-    /** Optional content rendered below the dialog body. */
+    /** Optional apply/clear/add-new controls after the list. */
     footer?: React.ReactNode;
 }) => import("react/jsx-runtime").JSX.Element;

package/dist/src/internal/components/OptionsPanel.d.ts

@@ -3,24 +3,40 @@ import { CSSProperties } from 'react';
 import { CheckState } from '../../types';
 export type OptionsPanelHandle = {
     scrollToTop: () => void;
+    /** Scrolls the row at `index` into view. `<= 0` shows a leading group header. */
     scrollToIndex: (index: number) => void;
 };
 export type OptionsPanelProps = {
+    /** When false, option rows stay unmounted inside the menu scroller. */
     isOpen: boolean;
+    /** Flattened option, pinned/group, and bulk-action rows. */
     items: SelectItem[];
+    /** Downshift getter for the menu scroller. */
     getMenuProps: GetMenuPropsFn;
+    /** Downshift getter for each option row. */
     getItemProps: GetItemPropsFn;
+    /** Host highlight index into `items`. */
     highlightedIndex: number;
+    /** Selection indicator shown on each row. */
     getCheckedState: (item: SelectItem) => CheckState;
+    /** Leading checkbox vs trailing selected checkmark. */
     selectionType: "single" | "multiple";
+    /** When true, shows the load-more control. */
     hasMore: boolean;
+    /** Fetches the next page of options. */
     onLoadMore: () => void;
+    /** Replaces the list with a spinner while the current page loads. */
     loading: boolean;
+    /** Spinner in the load-more slot. */
     loadingMore: boolean;
+    /** Skips automatic next-page fetch; the Load more button remains. */
     disableAutoLoadMore?: boolean;
+    /** Disables every row, in addition to per-item `disabled`. */
     disabled?: boolean;
     className?: string;
     style?: CSSProperties;
+    /** Pinned and group ranges over `items`. */
     sectionsMeta?: SectionMeta[];
 };
+/** Non-virtualized option list scroller. */
 export declare const OptionsPanel: import('react').ForwardRefExoticComponent<OptionsPanelProps & import('react').RefAttributes<OptionsPanelHandle>>;

package/dist/src/internal/components/OptionsPopover/OptionsPopover.d.ts

@@ -2,27 +2,22 @@ import { ReactNode, RefObject } from 'react';
 export type OptionsPopoverProps = {
     id: string;
     children: ReactNode;
+    /** Anchor used for positioning and click-outside exclusion. */
     referenceElement: RefObject<HTMLElement>;
+    /** Calls `showPopover` when true and `hidePopover` when false. */
     open: boolean;
     /**
-     * Fired when the popover should close (click-outside, focus-out, or
-     * Escape). On Escape, the popover restores focus to `referenceElement`
-     * before invoking this callback; for other paths focus has already moved
-     * elsewhere intentionally.
+     * Click-outside, focus-out, and Escape. Escape restores focus to
+     * `referenceElement` first; other paths leave focus where it already moved.
      */
     onClose: () => void;
-    /** Controls the popover width strategy.
-     * - `"reference"` — match the reference element's width
-     * - `number` — fixed width in px
-     * - `string` — any CSS width value (e.g. `"20rem"`)
-     * - `undefined` (default) — intrinsic sizing (`max-content`)
-     */
-    width?: "reference" | number | string;
     /**
-     * Optional content rendered as a full-bleed footer region inside the popover
-     * shell, separated from the body by a top border. The popover suppresses its
-     * own bottom padding so the footer can hug the popover's lower edge.
+     * `"reference"` matches the anchor, a number is CSS pixels, a string is a
+     * CSS width. Omitted uses intrinsic `max-content` sizing.
      */
+    width?: "reference" | number | string;
+    /** Region below the scrollable body, separated by a top border. */
     footer?: ReactNode;
 };
+/** Anchored popover shell for option lists. */
 export declare const OptionsPopover: (props: OptionsPopoverProps) => import("react/jsx-runtime").JSX.Element;

package/dist/src/internal/components/Popover/Popover.d.ts

@@ -3,108 +3,77 @@ import { Placement } from '@floating-ui/react';
 import { PopoverTrigger } from './PopoverTrigger';
 import { DisableCloseOnEscapeOrClickProps } from '../../../types';
 import { OpenCloseTransitionStateEffects } from '../../../internal/hooks';
-/** ARIA role of the beta Popover popup. */
+/** Popup roles supported by the internal popover interaction model. */
 export type PopoverRole = "dialog" | "listbox" | "tree" | "grid";
 /**
- * Sub-options for `placement="auto"`. Constrains which sides `autoPlacement()`
- * may choose from. Ignored when a specific placement is set.
+ * Placement options used only when `placement="auto"`.
  */
 export type PopoverAutoPlacementConfig = {
-    /** Limits which sides autoPlacement() considers. Defaults to all sides. */
+    /** Restricts automatic positioning to these placements. Defaults to all placements. */
     allowedPlacements?: Placement[];
 };
 /**
- * Sub-options for a specific placement (e.g. `"bottom"`). Overrides the default
- * opposite-side fallback sequence used by `flip()`. Ignored when `placement="auto"`.
+ * Placement options used only with a specific preferred placement.
  */
 export type PopoverFlipPlacementConfig = {
-    /** Explicit fallback sequence for flip(). Overrides the default opposite-side fallback. */
+    /** Overrides the default opposite-side fallback sequence. */
     fallbackPlacements?: Placement[];
 };
 type PopoverPropsBase = {
-    /** Content to render inside the popover tree. */
+    /** Compound trigger and content rendered under shared popover state. */
     children?: ReactNode;
-    /** Controlled open state. */
+    /** Controls visibility when supplied. */
     open?: boolean;
-    /** Initial open state for uncontrolled mode. @default false */
+    /** Initial visibility in uncontrolled mode. Defaults to `false`. */
     defaultOpen?: boolean;
-    /** Fires when the popover closes for any non-hover reason. */
+    /** Called when a non-hover interaction requests closure, but not when `open` changes externally. */
     onClose?: () => void;
-    /** Fires when the user clicks outside the popover. Not fired when disableCloseOnClickOutside is set. */
+    /** Called before an outside press closes the popover. */
     onClickOutside?: (e: globalThis.MouseEvent) => void;
-    /** Whether to show the arrow/caret indicator. @default false */
+    /** Shows a caret aligned to the resolved placement. Defaults to `false`. */
     enableCaret?: boolean;
-    /** Whether to remove default padding from the content area. @default false */
+    /** Removes the content area's default padding. Defaults to `false`. */
     noPadding?: boolean;
-    /** Whether the popover width should match the trigger element width. @default false */
+    /** Sets the content width to the measured trigger width. Defaults to `false`. */
     matchReferenceWidth?: boolean;
-    /** Whether the popover should have a fixed width of 40dvw. @default false */
+    /** Uses the fixed viewport-relative width unless `matchReferenceWidth` is set. Defaults to `false`. */
     fixedWidth?: boolean;
-    /** Fills available viewport height between the trigger and viewport edge. @default false */
+    /** Fills the remaining viewport height on the resolved side. Defaults to `false`. */
     fillAvailableHeight?: boolean;
-    /** Maximum height of the popover content. */
+    /** With `fitScreen`, becomes the content height while available space becomes its cap. */
     maxHeight?: number | string;
-    /** Constrains the popover to available viewport height. @default false */
+    /** Constrains content to the available viewport height. Defaults to `false`. */
     fitScreen?: boolean;
-    /** Minimum height of the popover content. @default "2.875rem" */
+    /** Minimum used when a constrained-height mode is active. Defaults to the component minimum. */
     minHeight?: number | string;
 } & DisableCloseOnEscapeOrClickProps & OpenCloseTransitionStateEffects;
 /**
- * Role-specific props for `role="dialog"` (default).
- *
- * Only dialog popovers use `FloatingFocusManager` — focus moves into the content
- * on open. The `modal`, `openOnHover`, and `delay` props are only meaningful
- * in this context.
+ * Dialog popovers manage focus and may use modal or read-only hover behavior.
  */
 type DialogRoleProps = {
     /**
-     * The ARIA role of the popup. Drives `aria-haspopup` on the trigger and
-     * `role` on the content via Floating UI's `useRole`.
-     *
-     * @default "dialog"
+     * Gives the popup dialog semantics. Defaults to `"dialog"`.
      */
     role?: "dialog";
-    /** Traps focus until closed (modal) or closes on Tab-out (non-modal). @default false */
+    /** Traps focus when modal; otherwise Tab-out closes the popover. Defaults to `false`. */
     modal?: boolean;
     /**
-     * Whether the popover opens on hover instead of click. @default false
-     *
-     * @remarks
-     * Hover-triggered popovers should contain only readable text — no interactive
-     * elements (buttons, links, inputs). The content is intentionally removed from
-     * the tab order so Tab moves cleanly between page elements. Interactive content
-     * inside a hover-triggered popover is unreachable by keyboard users. Use a
-     * click-triggered popover (default) when the content includes interactive elements.
+     * Opens on hover and focus instead of click. Hover content is removed from the
+     * tab order, so use this only for read-only content. Defaults to `false`.
      */
     openOnHover?: boolean;
-    /** Delay in ms before opening on hover. @default 100 */
+    /** Delay in milliseconds before hover opens the popover. Defaults to `100`. */
     delay?: number;
 };
 /**
- * Role-specific props for combobox popup roles (`listbox`, `tree`, `grid`).
- *
- * These roles follow the ARIA combobox pattern — focus stays on the trigger and
- * the inner component (e.g. `Listbox`) owns the role and keyboard navigation.
- * `FloatingFocusManager` is disabled. `modal`, `openOnHover`, and `delay` are
- * not applicable and are excluded at the type level.
- *
- * @remarks
- * Floating UI adds `role="combobox"` to the trigger element for these roles.
- * The `combobox` ARIA role only accepts names from `aria-label` or
- * `aria-labelledby` — visible text content is not used. Always provide an
- * explicit `aria-label` on `Popover.Button` or your custom trigger.
- *
- * @example
- * // ✅ Correct — explicit aria-label required for non-dialog roles
- * <Popover role="listbox">
- *   <Popover.Button aria-label="Select an option">Open</Popover.Button>
- *   <Popover.Content>
- *     <Listbox>...</Listbox>
- *   </Popover.Content>
- * </Popover>
+ * Combobox-style popovers leave focus, role, and keyboard navigation to the
+ * inner listbox, tree, or grid.
  */
 type NonDialogRoleProps = {
-    /** The ARIA role of the popup. */
+    /**
+     * Selects popup semantics owned by the inner widget. The trigger becomes a
+     * combobox and requires `aria-label` or `aria-labelledby`; visible text is ignored.
+     */
     role: Exclude<PopoverRole, "dialog">;
     modal?: never;
     openOnHover?: never;
@@ -112,158 +81,54 @@ type NonDialogRoleProps = {
 };
 type WithAutoPlacement = {
     /**
-     * Uses `autoPlacement()` — picks the side with the most space. Pass
-     * a specific placement (e.g. `"bottom"`) to express a preferred side
-     * with `flip()` fallback instead.
+     * Picks the placement with the most available space when explicitly set to `"auto"`.
+     * Omitting the prop uses `"bottom"` with opposite-side fallback.
      */
     placement?: "auto";
-    /** Sub-options for `autoPlacement()`. */
+    /** Restricts automatic placement choices. */
     placementConfig?: PopoverAutoPlacementConfig;
 };
 type WithSpecificPlacement = {
     /**
-     * Preferred placement relative to the trigger. Floating UI's `flip()`
-     * middleware will adapt to the opposite side if there is not enough space.
-     * Pass `"auto"` to let Floating UI pick the best side automatically.
-     *
-     * @default "bottom"
+     * Preferred trigger-relative placement, with opposite-side fallback.
      */
     placement: Placement;
-    /** Sub-options for `flip()`. */
+    /** Overrides the fallback placement sequence. */
     placementConfig?: PopoverFlipPlacementConfig;
 };
 export type PopoverDialogRoleProps = (PopoverPropsBase & DialogRoleProps & WithAutoPlacement) | (PopoverPropsBase & DialogRoleProps & WithSpecificPlacement);
 export type PopoverNonDialogRoleProps = (PopoverPropsBase & NonDialogRoleProps & WithAutoPlacement) | (PopoverPropsBase & NonDialogRoleProps & WithSpecificPlacement);
 /**
- * Props for the beta Popover component.
- *
- * Two independent discriminated unions are combined:
- * - **Role**: `role="dialog"` (default) enables `FloatingFocusManager` and accepts `modal`,
- *   `openOnHover`, and `delay`. Non-dialog roles (`listbox`, `tree`, `grid`) disable
- *   focus management — the inner component owns focus and keyboard navigation.
- * - **Placement**: `placement="auto"` uses `autoPlacement()` and accepts
- *   `placementConfig.allowedPlacements`. Specific placements use `flip()` and accept
- *   `placementConfig.fallbackPlacements`.
+ * Combines role-specific focus behavior with automatic or preferred placement.
+ * Dialogs accept modal and hover options; composite-widget roles leave focus to
+ * their inner widget.
  *
  * @extends DisableCloseOnEscapeOrClickProps
  * @extends OpenCloseTransitionStateEffects
  */
 export type PopoverProps = PopoverDialogRoleProps | PopoverNonDialogRoleProps;
 /**
- * Beta Popover component for displaying floating content relative to a trigger element.
- *
- * Built on three layers:
- * - HTML Popover API (`popover="manual"`) for top-layer rendering without z-index management
- * - Floating UI (`@floating-ui/react`) for JavaScript-based positioning
- * - Floating UI interaction hooks for correct ARIA attributes and keyboard behavior
- *
- * Features:
- * - Correct ARIA linkage: `aria-controls`, `aria-haspopup` with role string, `aria-expanded`
- * - `FloatingFocusManager` for both modal (focus trapped) and non-modal (Tab-out closes)
- * - `safePolygon()` hover zone replaces CSS `::before` hover bridge
- * - `role` prop drives both `aria-haspopup` on trigger and `role` on content
- * - Controlled and uncontrolled modes via `open` / `defaultOpen`
- * - Imperative handle exposing `openPopover` and `closePopover`
- * - Animation lifecycle callbacks via `onOpenAnimationStart` etc.
- *
- * @example
- * <Popover>
- *   <Popover.Button>Open</Popover.Button>
- *   <Popover.Content>
- *     <p>Popover content</p>
- *     <Popover.Close>Close</Popover.Close>
- *   </Popover.Content>
- * </Popover>
- *
- * @example
- * <Popover modal>
- *   <Popover.Trigger>
- *     {(props) => <Button {...props}>Open form</Button>}
- *   </Popover.Trigger>
- *   <Popover.Content>
- *     <TextField label="Name" />
- *     <Popover.Close>Done</Popover.Close>
- *   </Popover.Content>
- * </Popover>
- *
- * @example
- * <Popover openOnHover role="dialog">
- *   <Popover.Button>Hover me</Popover.Button>
- *   <Popover.Content>Hover content</Popover.Content>
- * </Popover>
+ * Positions top-layer content relative to a trigger. Dialog popovers manage
+ * focus; listbox, tree, and grid popovers defer focus to their inner widget.
  */
 export declare const Popover: import('react').ForwardRefExoticComponent<PopoverProps & import('react').RefAttributes<unknown>> & {
     /**
-     * PopoverTrigger component for creating custom trigger elements.
-     *
-     * Features:
-     * - Render prop pattern for full control over the trigger element
-     * - ARIA attributes and event handlers injected via getReferenceProps
+     * Render-prop trigger for wiring a custom element to the popover.
      *
      * @example
      * <Popover.Trigger>
-     *   {(props) => (
-     *     <Button {...props}>
-     *       Click to open popover
-     *     </Button>
-     *   )}
+     *   {(props) => <Button {...props}>Open</Button>}
      * </Popover.Trigger>
      */
     Trigger: typeof PopoverTrigger;
-    /**
-     * PopoverContent component for the main popover content area.
-     *
-     * Features:
-     * - HTML Popover API top-layer rendering (popover="manual")
-     * - Floating UI positioning via refs.setFloating and floatingStyles
-     * - FloatingFocusManager for focus trapping (modal) or Tab-out closing (non-modal)
-     * - Arrow/caret indicator with position computed from middlewareData.arrow
-     * - Scroll position reset when the popover opens
-     * - Optional scrollerRef for external scroll access
-     *
-     * @example
-     * <Popover.Content>
-     *   <p>Popover content</p>
-     *   <Popover.Close>Close</Popover.Close>
-     * </Popover.Content>
-     */
+    /** Positioned top-layer container whose focus behavior follows the popover role. */
     Content: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "popover"> & {
         scrollerRef?: import('react').RefObject<HTMLDivElement>;
         hideWhileClosed?: boolean;
     } & import('react').RefAttributes<HTMLDivElement>>;
-    /**
-     * PopoverClose component for closing the popover.
-     *
-     * Features:
-     * - Supports all Button component props and styling
-     * - Closes the popover on click via closePopover
-     * - Automatic tracking ID generation for analytics
-     *
-     * @example
-     * <Popover.Close>Close</Popover.Close>
-     *
-     * @example
-     * <Popover.Close appearance="secondary" size="small">
-     *   Cancel
-     * </Popover.Close>
-     */
+    /** Button that closes the enclosing popover before running its click handler. */
     Close: import('react').ForwardRefExoticComponent<import('./PopoverClose').PopoverCloseProps & import('react').RefAttributes<HTMLButtonElement>>;
-    /**
-     * PopoverButton component for creating button-style triggers.
-     *
-     * Features:
-     * - Button styling and behavior with all Button props
-     * - ARIA attributes and event handlers injected via getReferenceProps
-     * - Automatic tracking ID generation for analytics
-     *
-     * @example
-     * <Popover.Button>Click to open</Popover.Button>
-     *
-     * @example
-     * <Popover.Button appearance="primary" size="large" icon={InfoIcon}>
-     *   Information
-     * </Popover.Button>
-     */
+    /** Anvil Button wired as the popover trigger. */
     Button: import('react').ForwardRefExoticComponent<import('./PopoverButton').PopoverButtonProps & import('react').RefAttributes<HTMLButtonElement>>;
 };
 export {};

package/dist/src/internal/components/Popover/PopoverButton.d.ts

@@ -1,24 +1,4 @@
 import { ButtonProps } from '../../../components/Button';
 import { DataTrackingId } from '../../../types';
-/**
- * Props for the PopoverButton component.
- * @extends ButtonProps
- */
 export type PopoverButtonProps = ButtonProps & DataTrackingId;
-/**
- * PopoverButton component for creating button-style triggers.
- *
- * Features:
- * - Button styling and behavior with all Button props
- * - ARIA attributes and event handlers injected via getReferenceProps
- * - Automatic tracking ID generation for analytics
- *
- * @example
- * <Popover.Button>Click to open</Popover.Button>
- *
- * @example
- * <Popover.Button appearance="primary" size="large" icon={InfoIcon}>
- *   Information
- * </Popover.Button>
- */
 export declare const PopoverButton: import('react').ForwardRefExoticComponent<PopoverButtonProps & import('react').RefAttributes<HTMLButtonElement>>;

package/dist/src/internal/components/Popover/PopoverClose.d.ts

@@ -1,24 +1,4 @@
 import { ButtonProps } from '../../../components/Button';
 import { DataTrackingId } from '../../../types';
-/**
- * Props for the PopoverClose component.
- * @extends ButtonProps
- */
 export type PopoverCloseProps = ButtonProps & DataTrackingId;
-/**
- * PopoverClose component for closing the popover.
- *
- * Features:
- * - Supports all Button component props and styling
- * - Closes the popover on click via closePopover
- * - Automatic tracking ID generation for analytics
- *
- * @example
- * <Popover.Close>Close</Popover.Close>
- *
- * @example
- * <Popover.Close appearance="secondary" size="small">
- *   Cancel
- * </Popover.Close>
- */
 export declare const PopoverClose: import('react').ForwardRefExoticComponent<PopoverCloseProps & import('react').RefAttributes<HTMLButtonElement>>;

package/dist/src/internal/components/Popover/PopoverContent.d.ts

@@ -1,34 +1,13 @@
 import { ComponentPropsWithoutRef, HTMLAttributes, RefObject } from 'react';
-/**
- * Props for the PopoverContent component.
- * @extends ComponentPropsWithoutRef<"div">
- */
 export type PopoverContentProps = Omit<ComponentPropsWithoutRef<"div">, "popover"> & {
-    /** Reference to the scrollable content area. */
+    /** Receives the inner scrolling element rather than the positioned wrapper. */
     scrollerRef?: RefObject<HTMLDivElement>;
-    /** Whether to unmount children from the DOM while the popover is closed. Useful for performance when the content is expensive to render. */
+    /** Unmounts children while closed but keeps the top-layer wrapper mounted. Defaults to `false`. */
     hideWhileClosed?: boolean;
 };
-/**
- * PopoverContent component for the main popover content area.
- *
- * Features:
- * - HTML Popover API top-layer rendering (popover="manual")
- * - Floating UI positioning via refs.setFloating and floatingStyles
- * - FloatingFocusManager for focus trapping (modal) or Tab-out closing (non-modal)
- * - Arrow/caret indicator with position computed from middlewareData.arrow
- * - Scroll position reset when the popover opens
- * - Optional scrollerRef for external scroll access
- *
- * @example
- * <Popover.Content>
- *   <p>Popover content</p>
- *   <Popover.Close>Close</Popover.Close>
- * </Popover.Content>
- */
 export declare const PopoverContent: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "popover"> & {
-    /** Reference to the scrollable content area. */
+    /** Receives the inner scrolling element rather than the positioned wrapper. */
     scrollerRef?: RefObject<HTMLDivElement>;
-    /** Whether to unmount children from the DOM while the popover is closed. Useful for performance when the content is expensive to render. */
+    /** Unmounts children while closed but keeps the top-layer wrapper mounted. Defaults to `false`. */
     hideWhileClosed?: boolean;
 } & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/internal/components/Popover/PopoverTrigger.d.ts

@@ -1,5 +1,4 @@
 import { AriaAttributes, ReactElement, MouseEvent, KeyboardEvent, FocusEvent } from 'react';
-/** Props passed to the PopoverTrigger render function. */
 type PopoverTriggerChildrenProps = {
     ref: (node: Element | null) => void;
     id: string;
@@ -14,31 +13,10 @@ type PopoverTriggerChildrenProps = {
     onFocus?: (e: FocusEvent) => void;
     onBlur?: (e: FocusEvent) => void;
 };
-/**
- * Props for the PopoverTrigger component.
- */
 export type PopoverTriggerProps = {
-    /**
-     * Render function that receives trigger props and returns a React element.
-     */
+    /** Spread these ref, ARIA, and interaction props onto the custom trigger element. */
     children: (props: PopoverTriggerChildrenProps) => ReactElement;
 };
-/**
- * PopoverTrigger component for creating custom trigger elements.
- *
- * Features:
- * - Render prop pattern for full control over the trigger element
- * - ARIA attributes and event handlers injected via getReferenceProps
- *
- * @example
- * <Popover.Trigger>
- *   {(props) => (
- *     <Button {...props}>
- *       Click to open popover
- *     </Button>
- *   )}
- * </Popover.Trigger>
- */
 export declare function PopoverTrigger(props: PopoverTriggerProps): ReactElement<any, string | import('react').JSXElementConstructor<any>>;
 export declare namespace PopoverTrigger {
     var displayName: string;

package/dist/src/internal/components/Popover/internal/PopoverContext.d.ts

@@ -2,50 +2,29 @@ import { CSSProperties, RefObject, HTMLProps } from 'react';
 import { FloatingContext, MiddlewareData, Placement } from '@floating-ui/react';
 import { PopoverRole } from '../Popover';
 export type PopoverContextProps = {
-    /** Context object from useFloating; required by FloatingFocusManager and interaction hooks. */
     floatingContext: FloatingContext;
-    /** Callback refs from useFloating; setReference for the trigger, setFloating for the content. */
     refs: {
         setReference: (node: Element | null) => void;
         setFloating: (node: HTMLElement | null) => void;
     };
-    /** Inline positioning styles from useFloating; applied to the content element. */
     floatingStyles: CSSProperties;
-    /** Middleware output from useFloating; used for arrow positioning via middlewareData.arrow. */
     middlewareData: MiddlewareData;
-    /** Merged prop getter for the trigger; spreads ARIA attributes and event handlers. */
     getReferenceProps: (userProps?: HTMLProps<Element>) => Record<string, unknown>;
-    /** Merged prop getter for the content; spreads ARIA attributes and event handlers. */
     getFloatingProps: (userProps?: HTMLProps<HTMLElement>) => Record<string, unknown>;
-    /** Auto-generated id for the trigger element; used as the default aria-labelledby on content. */
     triggerId: string;
-    /** Current open/closed state. */
     openState: boolean;
-    /** Opens the popover. */
     openPopover: () => void;
-    /** Closes the popover. Fires onClose unless opened via hover. */
     closePopover: () => void;
-    /** Whether the open state is externally controlled. */
     controlled: boolean;
-    /** Resolved placement after flip/shift middleware; may differ from the placement prop. */
     actualPlacement: Placement;
-    /** Ref attached to the arrow span element inside PopoverContent. */
     arrowRef: RefObject<HTMLSpanElement>;
-    /** Whether the most recent close was keyboard-driven (e.g. Escape); drives the focus ring on the returned-to trigger. */
     closedViaKeyboardRef: RefObject<boolean>;
-    /** Whether the most recent close was FloatingFocusManager's non-modal Tab-out guard (reported via a FocusEvent); tells the focus-return effect to reclaim focus even though the browser's native Tab has already moved it past the trigger. */
     closedViaTabOutRef: RefObject<boolean>;
-    /** Clears closedViaKeyboardRef/closedViaTabOutRef. Call once the focus-return effect has reacted to a close event, so a later unrelated re-run of that effect (while still closed) doesn't reuse a stale close-reason signal. */
     clearCloseReasonRefs: () => void;
-    /** Whether the popover traps focus (modal) or closes on Tab-out (non-modal). Only applies when role is "dialog". */
     modal?: boolean;
-    /** Whether the popover opens on hover/focus instead of click. Only applies when role is "dialog". */
     openOnHover: boolean;
-    /** Whether to remove default padding from the content area. */
     noPadding?: boolean;
-    /** Whether to show the arrow/caret indicator. */
     enableCaret?: boolean;
-    /** The ARIA role of the popup. Drives FloatingFocusManager and ARIA attribute behavior. */
     role: PopoverRole;
 };
 export declare const PopoverContext: import('react').Context<PopoverContextProps | null>;

package/dist/src/internal/components/Popover/internal/usePopoverContext.d.ts

@@ -1,6 +1,4 @@
 /**
- * Returns the PopoverContext for use within Popover compound components.
- * @returns The current PopoverContextProps value.
- * @throws Error if called outside a Popover component.
+ * Reads the enclosing popover state and rejects use outside the compound root.
  */
 export declare function usePopoverContext(): import('./PopoverContext').PopoverContextProps;

package/dist/src/internal/components/SelectOption.d.ts

@@ -2,12 +2,20 @@ import { SelectItem, GetItemPropsFn } from '../types/selectFieldInternalTypes';
 import { CheckState } from '../../types';
 export type SelectOptionProps = {
     item: SelectItem;
+    /** Position passed to the host's item-prop getter. */
     index: number;
+    /** Whether the host currently highlights this row. */
     highlighted: boolean;
+    /** Applies disabled row styling. */
     disabled: boolean;
+    /** Supplies the host listbox's interaction and accessibility props. */
     getItemProps: GetItemPropsFn;
+    /** Chooses a leading checkbox or trailing selected checkmark. */
     selectionType: "single" | "multiple";
+    /** Selection state shown by the row indicator. */
     checked: CheckState;
+    /** Adds separation styling to sticky bulk-action rows after scrolling. */
     isListScrolled?: boolean;
 };
+/** Renders a select item with its content and selection indicator. */
 export declare const SelectOption: ({ item, index, highlighted, disabled, getItemProps, selectionType, checked, isListScrolled, }: SelectOptionProps) => import("react/jsx-runtime").JSX.Element;