@servicetitan/anvil2 3.14.1 → 3.15.0

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

@@ -2,27 +2,21 @@ import { KeyboardEvent, ReactElement, RefObject } from 'react';
 import { DataAttributes } from '../../types';
 import { SelectFieldCacheOptions, SelectFieldEagerLoader, SelectFieldGroupByValue, SelectFieldGroupLazyLoader, SelectFieldGroupedOption, SelectFieldOffsetLazyLoader, SelectFieldOption, SelectFieldOptionContent, SelectFieldPageLazyLoader, SelectFieldPinnedOptions, SelectFieldSearchProps } from '../SelectField/types';
 import { AddNewItemProps } from '../../internal/types/addNewItemTypes';
-/**
- * Rich content configuration for a SelectMenu 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 SelectMenuOptionContent = SelectFieldOptionContent;
+/** Alias of {@link SelectFieldOption}. */
 export type SelectMenuOption = SelectFieldOption;
+/** Alias of {@link SelectFieldGroupByValue}. */
 export type SelectMenuGroupByValue = SelectFieldGroupByValue;
+/** Alias of {@link SelectFieldGroupedOption}. */
 export type SelectMenuGroupedOption = SelectFieldGroupedOption;
-/**
- * Configuration options for the SelectMenu 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 SelectFieldCacheOptions}. */
 export type SelectMenuCacheOptions = SelectFieldCacheOptions;
-/**
- * Imperative handle for the SelectMenu 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 SelectMenu}. */
 export type SelectMenuHandle = {
+    /** Drops cached `loadOptions` results without fetching. */
     clearCache: () => void;
+    /** Drops the cache and fetches options again. */
     invalidate: () => void;
 };
 export type SelectMenuEagerLoader = SelectFieldEagerLoader;
@@ -30,20 +24,21 @@ export type SelectMenuPageLazyLoader = SelectFieldPageLazyLoader;
 export type SelectMenuOffsetLazyLoader = SelectFieldOffsetLazyLoader;
 export type SelectMenuGroupLazyLoader = SelectFieldGroupLazyLoader;
 export type SelectMenuPinnedOptions = SelectFieldPinnedOptions;
+/**
+ * Search-field control and debounce. Alias of {@link SelectFieldSearchProps}.
+ * SelectMenu defaults `debounceMs` to `200`.
+ */
 export type SelectMenuSearchProps = SelectFieldSearchProps;
 /**
- * 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 SelectMenu} merge into this bag.
  */
 export type SelectMenuTriggerProps = {
+    /** 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;
@@ -52,94 +47,85 @@ export type SelectMenuTriggerProps = {
 } & DataAttributes;
 type SelectMenuCommonProps = {
     /**
-     * The id of the 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: SelectMenuTriggerProps) => 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, selecting an option, or toggling the trigger. Focus is restored to the trigger.
+     * Called when the menu closes from Escape, selecting an option, or toggling
+     * the trigger. Focus is restored to the trigger.
      */
     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 option. Must be controlled state.
+     * Controlled selected option. Pass `null` for no selection.
      */
     value: SelectMenuOption | null;
     /**
-     * Callback fired when the selected option changes.
-     * @param option - The newly selected option, or null if cleared.
+     * Called with the option the user chose. Footer Clear does not go through
+     * this.
      */
     onSelectedOptionChange: (option: SelectMenuOption | null) => 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.
+     * Sections rendered above the loaded list (favorites, recents, and similar).
      */
     pinned?: SelectMenuPinnedOptions;
     /**
-     * Configuration for caching loadOptions results.
-     * Caching is enabled by default. Set `{ enabled: false }` to disable.
+     * Caches `loadOptions` results. Enabled by default; `{ enabled: false }`
+     * disables.
      */
     cache?: SelectMenuCacheOptions;
     /**
-     * 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.
-     * Enable for large option sets to improve performance.
-     * @default false
+     * Windowed option rendering for large lists. Defaults to `false`.
      */
     virtualize?: boolean;
     /**
-     * Whether to disable the search input inside the menu.
-     * When true, the menu shows only the list without a search field.
-     * @default false
+     * Hides the in-menu search field. Defaults to `false`.
      */
     disableSearch?: boolean;
     /**
-     * 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;
     /**
-     * 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.
+     * `label` defaults to `"Clear"`. `disabled` leaves the button inert.
      */
     clear?: {
         onClick: () => void;
@@ -149,12 +135,12 @@ type SelectMenuCommonProps = {
 } & SelectMenuSearchProps & AddNewItemProps & DataAttributes;
 type SelectMenuGroupingProps = {
     /**
-     * Function to convert a group value to a display label.
-     * Only used when options have a `group` property.
+     * Turns an option `group` value into a section heading. Unused when options
+     * have no `group`.
      */
     groupToString?: (groupValue: SelectMenuGroupByValue) => string;
     /**
-     * Custom comparator function to sort groups.
+     * Orders groups. Unused when options have no `group`.
      */
     groupSorter?: (a: SelectMenuGroupByValue, b: SelectMenuGroupByValue) => number;
 };
@@ -162,29 +148,44 @@ type SelectMenuNonGroupingProps = {
     groupToString?: never;
     groupSorter?: never;
 };
+/** Page-number lazy loading. Grouping props are not allowed. */
 export type SelectMenuPropsLazyPage = SelectMenuCommonProps & {
     lazy: "page";
+    /** Page size for each `loadOptions` call. Defaults to `20`. */
     lazyOptions?: {
         pageSize?: number;
     };
+    /** Called with search, page number, and page size. */
     loadOptions: SelectMenuPageLazyLoader;
 } & SelectMenuNonGroupingProps;
+/** Offset lazy loading. Grouping props are not allowed. */
 export type SelectMenuPropsLazyOffset = SelectMenuCommonProps & {
     lazy: "offset";
+    /** Batch size for each `loadOptions` call. Defaults to `20`. */
     lazyOptions?: {
         limit?: number;
     };
+    /** Called with search, offset, and limit. */
     loadOptions: SelectMenuOffsetLazyLoader;
 } & SelectMenuNonGroupingProps;
+/** Group-key lazy loading. Grouping helpers apply. */
 export type SelectMenuPropsLazyGroup = SelectMenuCommonProps & {
     lazy: "group";
     lazyOptions?: object;
+    /** Called with search and the previous group key (`null` on the first page). */
     loadOptions: SelectMenuGroupLazyLoader;
 } & SelectMenuGroupingProps;
+/** Eager `loadOptions`. Grouping helpers apply. */
 export type SelectMenuPropsEager = SelectMenuCommonProps & {
+    /** Omit or `false`. Defaults to `false`. */
     lazy?: false;
+    /** Called with the current search string. */
     loadOptions: SelectMenuEagerLoader;
 } & SelectMenuGroupingProps;
 export type SelectMenuPropsLazy = SelectMenuPropsLazyPage | SelectMenuPropsLazyOffset | SelectMenuPropsLazyGroup;
+/**
+ * Single-select menu. Discriminated by `lazy`: omit or `false` for eager
+ * `loadOptions`; `"page"` / `"offset"` / `"group"` for lazy loaders.
+ */
 export type SelectMenuProps = SelectMenuPropsLazy | SelectMenuPropsEager;
 export {};

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

@@ -5,40 +5,48 @@ import { DataTrackingId, DistributiveOmit } from '../../types';
 import { FieldLabelProps } from '../FieldLabel';
 import { IconProps } from '../Icon';
 import { SelectTriggerBaseProps } from './internal/SelectTriggerBase';
+/**
+ * Discriminated by `multiple`. Omit it and pass `selectedItem`; set
+ * `multiple` and pass `selectedItems`. `itemToString` and `itemToKey`
+ * default to Combobox's item helpers.
+ */
 export type SelectTriggerProps<Item> = DistributiveOmit<SelectTriggerBaseProps<Item>, "prefix" | "selectedItem" | "selectedItems" | "onChange"> & Pick<FieldLabelProps, "required" | "moreInfo"> & Pick<UseDownshiftComboboxProps<Item>, "itemToString" | "itemToKey"> & DataTrackingId & {
+    /**
+     * Content before the value. A string is text; `{ icon }` / `{ avatar }`
+     * render those components. Avatar size follows the trigger (`small` or
+     * `medium`).
+     */
     prefix?: string | {
         icon: DistributiveOmit<IconProps, "size">;
     } | {
         avatar: DistributiveOmit<AvatarProps, "size">;
     };
 } & ({
+    /** Omit for single selection. */
     multiple?: never;
+    /** Called with the next item, or `null` when the selection is cleared. */
     onChange?: Dispatch<SetStateAction<Item | null>> | ((arg: Item | null) => void);
+    /** Shown in the value area. Use `null` for an empty field. */
     selectedItem: UseDownshiftComboboxProps<Item>["selectedItem"];
     selectedItems?: never;
 } | {
+    /** Switches the trigger to chip-based multi-select. */
     multiple: true;
+    /** Called with the next items. Clearing the field passes `[]`. */
     onChange?: Dispatch<SetStateAction<Item[] | null>> | ((arg: Item[] | null) => void);
     selectedItem?: never;
+    /** Shown as chips. Use an empty array for an empty field. */
     selectedItems: UseDownshiftMultipleSelectionProps<Item>["selectedItems"];
 });
 /**
- * SelectTrigger component — a field-styled button for opening a custom
- * select-like menu (e.g. paired with `Combobox.Content` or a custom
- * popover), for building select components that need a trigger different
- * from `SelectMenu`'s built-in one.
- *
- * Features:
- * - Single (`selectedItem`) or multiple (`selectedItems`) selection display
- * - Optional prefix as text, an icon, or an avatar
- * - Label, hint, description, error, and required-field messaging
- * - Full accessibility support via `FieldLabel`
+ * Field-styled button that opens a custom select-like menu. Pair with a
+ * popover or similar; use `SelectMenu` when its built-in trigger is enough.
  *
  * @example
  * <SelectTrigger
  *   label="Assignee"
  *   selectedItem={selected}
- *   itemToString={(item) => item?.name ?? ""}
+ *   prefix={{ avatar: { name: "Ada" } }}
  * />
  */
 export declare const SelectTrigger: <Item = any>(props: SelectTriggerProps<Item>) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/SelectTrigger/internal/SelectTriggerBase.d.ts

@@ -12,28 +12,44 @@ type PartialChipProps = Partial<Omit<ChipProps, "icon" | "avatar">> & DataAttrib
 });
 export type SelectTriggerBaseProps<Item = unknown> = DistributiveOmit<TextFieldProps, "showCounter" | "prefix"> & {
     /**
-     * Should be a positive integer.
+     * Caps visible selected chips to this many rows and collapses the rest
+     * into a +N chip. Omit to show every chip. Must be a positive integer.
      */
     maxRows?: number;
-    /** Allows Combobox/Select to display custom-colored Chips */
+    /** Extra Chip props per selected item; merged after `chipProps`. */
     selectedItemProps?: (item: Item, index: number) => PartialChipProps;
 } & {
+    /** Chip and single-value labels. Defaults to Combobox's `defaultItemToString`. */
     itemToString?: (item: Item) => string;
+    /** Called when a chip's close control is activated. */
     removeSelectedItem?: (item: Item) => void;
+    /**
+     * Hides the clear control. Also hidden when `disabled` or `readOnly`.
+     * Defaults to `false`.
+     */
     disableClearSelection?: boolean;
     selectedItem: Item | null;
     selectedItems: Item[];
+    /** Combobox typed query shown in the input. */
     inputValue?: string;
+    /** Floating-ui reference element for the composed menu. */
     referenceRef?: MutableRefObject<HTMLDivElement | null>;
 } & {
+    /**
+     * `select` renders a button-like value area; `combobox` renders a text
+     * input. Defaults to `select`.
+     */
     variant?: "select" | "combobox";
+    /** Fired after the clear control stops the wrapper click. */
     onClearButtonClick?: MouseEventHandler<HTMLButtonElement>;
     labelProps?: Partial<FieldLabelProps>;
     inputWrapperProps?: ComponentPropsWithoutRef<"div">;
     toggleButtonProps?: ComponentPropsWithoutRef<"button"> & DataAttributes;
     clearButtonProps?: ComponentPropsWithoutRef<"button"> & DataAttributes;
+    /** Extra Chip props per selected item; merged before `selectedItemProps`. */
     chipProps?: (item: Item, index: number) => PartialChipProps;
     inputProps?: ComponentPropsWithoutRef<"input" | "div"> & DataAttributes;
+    /** Hides the trailing chevron. Defaults to `false`. */
     disableToggleButton?: boolean;
 } & {
     prefix?: string | ReactNode;

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

@@ -1,82 +1,33 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { LayoutUtilProps, DataTrackingId } from '../../types';
 /**
- * Props for the SideNav component
  * @extends ComponentPropsWithoutRef<"nav">
  * @extends LayoutUtilProps
+ * @extends DataTrackingId
  */
 export type SideNavProps = ComponentPropsWithoutRef<"nav"> & LayoutUtilProps & DataTrackingId;
 /**
- * SideNav component for creating hierarchical navigation menus.
- *
- * Features:
- * - Hierarchical navigation structure with links, groups, and collapsible sections
- * - Keyboard navigation support with arrow keys and focus management
- * - Active state tracking for current page/section
- * - Accessible with proper ARIA roles and labels
- * - Automatic link recalculation for dynamic content
- * - Context provider for child components
- * - Layout utility props for positioning and spacing
+ * Hierarchical page nav. Arrow keys move among enabled links and collapsible
+ * headers.
  *
  * @example
  * <SideNav>
- *   <SideNav.Group label="Getting Started">
+ *   <SideNav.Group label="Start">
  *     <SideNav.Link id="intro" href="/intro" active>
- *       Introduction
- *     </SideNav.Link>
- *     <SideNav.Link id="installation" href="/installation">
- *       Installation
+ *       Intro
  *     </SideNav.Link>
  *   </SideNav.Group>
- *   <SideNav.Collapsible label="Components">
- *     <SideNav.Link id="button" href="/components/button">
+ *   <SideNav.Collapsible label="More">
+ *     <SideNav.Link id="button" pathname="/button">
  *       Button
  *     </SideNav.Link>
- *     <SideNav.Link id="input" href="/components/input">
- *       Input
- *     </SideNav.Link>
  *   </SideNav.Collapsible>
  * </SideNav>
  */
 export declare const SideNav: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & LayoutUtilProps & DataTrackingId & import('react').RefAttributes<HTMLElement>> & {
-    /**
-     * SideNavLink component for individual navigation links.
-     *
-     * Features:
-     * - Individual navigation links with active state support
-     * - Keyboard navigation integration with arrow keys
-     * - Focus management and tabindex handling
-     * - Accessible with proper ARIA attributes
-     * - Click and keyboard event handling
-     * - Disabled state support
-     *
-     * @example
-     * <SideNav.Link id="intro" href="/intro" active>
-     *   Introduction
-     * </SideNav.Link>
-     */
+    /** Page or in-app route item. */
     Link: import('react').ForwardRefExoticComponent<import('./SideNavLink').SideNavLinkProps & import('react').RefAttributes<HTMLLIElement>>;
-    /**
-     * SideNavCollapsible component for expandable navigation sections.
-     *
-     * Features:
-     * - Expandable/collapsible navigation sections
-     * - Controlled and uncontrolled expansion states
-     * - Keyboard navigation with arrow keys for expansion
-     * - Automatic expansion when child links are active
-     * - Accessible with proper ARIA expanded states
-     * - Visual indicators for active children
-     *
-     * @example
-     * <SideNav.Collapsible label="Components">
-     *   <SideNav.Link id="button" href="/components/button">
-     *     Button
-     *   </SideNav.Link>
-     *   <SideNav.Link id="input" href="/components/input">
-     *     Input
-     *   </SideNav.Link>
-     * </SideNav.Collapsible>
-     */
+    /** Expandable section. */
     Collapsible: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>, "ref">, "onClick"> & {
         label: string;
         onClick?: ComponentPropsWithoutRef<"button">["onClick"];
@@ -84,25 +35,7 @@ export declare const SideNav: import('react').ForwardRefExoticComponent<Omit<imp
         defaultExpanded?: boolean;
         expanded?: boolean;
     } & import('react').RefAttributes<HTMLLIElement>>;
-    /**
-     * SideNavGroup component for grouping related navigation links.
-     *
-     * Features:
-     * - Groups related navigation links with labels
-     * - Accessible with proper ARIA labeling
-     * - Semantic grouping for screen readers
-     * - Consistent styling and spacing
-     *
-     * @example
-     * <SideNav.Group label="Getting Started">
-     *   <SideNav.Link id="intro" href="/intro">
-     *     Introduction
-     *   </SideNav.Link>
-     *   <SideNav.Link id="installation" href="/installation">
-     *     Installation
-     *   </SideNav.Link>
-     * </SideNav.Group>
-     */
+    /** Labeled cluster of links. */
     Group: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>, "ref"> & {
         label: string;
     } & import('react').RefAttributes<HTMLLIElement>>;

package/dist/src/components/SideNav/SideNavCollapsible.d.ts

@@ -1,73 +1,38 @@
 import { ComponentPropsWithoutRef } from 'react';
 /**
- * Props for the SideNavCollapsible component
  * @extends Omit<ComponentPropsWithoutRef<"li">, "onClick">
  */
 export type SideNavCollapsibleProps = Omit<ComponentPropsWithoutRef<"li">, "onClick"> & {
-    /**
-     * The label text displayed for the collapsible section
-     */
+    /** Header text on the expand/collapse button. */
     label: string;
-    /**
-     * Function called when the collapsible button is clicked
-     */
+    /** Runs after the header click handler. */
     onClick?: ComponentPropsWithoutRef<"button">["onClick"];
-    /**
-     * Function called when a key is pressed on the collapsible button
-     */
+    /** Runs after the header keydown handler. */
     onKeyDown?: ComponentPropsWithoutRef<"button">["onKeyDown"];
     /**
-     * Initial expansion state for uncontrolled usage
-     * @default false
+     * Uncontrolled start. Defaults to `false`. Also used for the first render
+     * when `expanded` is controlled.
      */
     defaultExpanded?: boolean;
-    /**
-     * Controlled expansion state
-     */
+    /** After mount, this value wins over `defaultExpanded`. */
     expanded?: boolean;
 };
 /**
- * SideNavCollapsible component for expandable navigation sections within a SideNav.
- *
- * Features:
- * - Expandable/collapsible navigation sections
- * - Controlled and uncontrolled expansion states
- * - Keyboard navigation with arrow keys for expansion
- * - Automatic expansion when child links are active
- * - Accessible with proper ARIA expanded states
- * - Visual indicators for active children
- * - Integration with SideNav keyboard navigation
- *
- * @example
- * <SideNav.Collapsible label="Components">
- *   <SideNav.Link id="button" href="/components/button">
- *     Button
- *   </SideNav.Link>
- *   <SideNav.Link id="input" href="/components/input">
- *     Input
- *   </SideNav.Link>
- * </SideNav.Collapsible>
+ * Expandable section. On first paint, opens if a child link `id` is in the
+ * active set. Collapsed with an active child shows an indicator.
  */
 export declare const SideNavCollapsible: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>, "ref">, "onClick"> & {
-    /**
-     * The label text displayed for the collapsible section
-     */
+    /** Header text on the expand/collapse button. */
     label: string;
-    /**
-     * Function called when the collapsible button is clicked
-     */
+    /** Runs after the header click handler. */
     onClick?: ComponentPropsWithoutRef<"button">["onClick"];
-    /**
-     * Function called when a key is pressed on the collapsible button
-     */
+    /** Runs after the header keydown handler. */
     onKeyDown?: ComponentPropsWithoutRef<"button">["onKeyDown"];
     /**
-     * Initial expansion state for uncontrolled usage
-     * @default false
+     * Uncontrolled start. Defaults to `false`. Also used for the first render
+     * when `expanded` is controlled.
      */
     defaultExpanded?: boolean;
-    /**
-     * Controlled expansion state
-     */
+    /** After mount, this value wins over `defaultExpanded`. */
     expanded?: boolean;
 } & import('react').RefAttributes<HTMLLIElement>>;

package/dist/src/components/SideNav/SideNavContext.d.ts

@@ -1,26 +1,8 @@
-/**
- * Context props for the SideNav component
- */
 export type SideNavContextProps = {
-    /**
-     * List of navigable elements in the side navigation
-     */
     links: NodeListOf<Element> | undefined;
-    /**
-     * Function to recalculate the list of navigable links
-     */
     reCalculateLinks: () => void;
-    /**
-     * Set of currently active link IDs
-     */
     activeIds: Set<string>;
-    /**
-     * Function to add an ID to the active set
-     */
     addActiveId: (id: string) => void;
-    /**
-     * Function to remove an ID from the active set
-     */
     removeActiveId: (id: string) => void;
 };
 export declare const SideNavContext: import('react').Context<SideNavContextProps | null>;

package/dist/src/components/SideNav/SideNavGroup.d.ts

@@ -1,37 +1,12 @@
 import { ComponentPropsWithoutRef } from 'react';
 /**
- * Props for the SideNavGroup component
  * @extends ComponentPropsWithoutRef<"li">
  */
 export type SideNavGroupProps = ComponentPropsWithoutRef<"li"> & {
-    /**
-     * The label text displayed for the navigation group
-     */
+    /** Visible heading; labels the nested list. */
     label: string;
 };
-/**
- * SideNavGroup component for grouping related navigation links within a SideNav.
- *
- * Features:
- * - Groups related navigation links with labels
- * - Accessible with proper ARIA labeling
- * - Semantic grouping for screen readers
- * - Consistent styling and spacing
- * - Unique ID generation for accessibility
- *
- * @example
- * <SideNav.Group label="Getting Started">
- *   <SideNav.Link id="intro" href="/intro">
- *     Introduction
- *   </SideNav.Link>
- *   <SideNav.Link id="installation" href="/installation">
- *     Installation
- *   </SideNav.Link>
- * </SideNav.Group>
- */
 export declare const SideNavGroup: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>, "ref"> & {
-    /**
-     * The label text displayed for the navigation group
-     */
+    /** Visible heading; labels the nested list. */
     label: string;
 } & import('react').RefAttributes<HTMLLIElement>>;