@servicetitan/anvil2 3.14.1 → 3.15.1

package/dist/src/components/Page/PageSidebar.d.ts

@@ -1,57 +1,24 @@
 import { ComponentPropsWithoutRef } from 'react';
 /**
- * Props for the PageSidebar component
  * @extends ComponentPropsWithoutRef<"div">
  */
 export type PageSidebarProps = ComponentPropsWithoutRef<"div"> & {
-    /**
-     * Key for storing sidebar collapsed state in localStorage
-     * @default "sidebar-collapsed"
-     */
+    /** Persists desktop collapsed state under this localStorage key. Defaults to `"sidebar-collapsed"`. */
     localStorageKey?: string;
-    /**
-     * Custom tracking ID for analytics
-     */
+    /** Overrides the generated tracking ID on the desktop toggle button. */
     ["data-tracking-id"]?: string;
-    /**
-     * Title to display in the adaptive trigger button
-     */
+    /** Smaller-page trigger text. Defaults to `"Menu"`. */
     currentPageTitle?: string;
 };
 /**
- * PageSidebar component for creating collapsible navigation sidebars.
- *
- * Features:
- * - Collapsible sidebar with localStorage persistence
- * - Responsive design with adaptive popover on mobile
- * - Automatic tracking ID generation for analytics
- * - Keyboard navigation and accessibility support
- * - Toggle button with tooltip
- * - Context provider for sidebar state
- * - Mobile-friendly popover navigation
- *
- * @example
- * <Page.Sidebar currentPageTitle="Navigation">
- *   <Page.SidebarHeader>
- *     <Text variant="headline" el="h2">Sidebar Title</Text>
- *   </Page.SidebarHeader>
- *   <SideNav>
- *     <SideNavLink pathname="/">Home</SideNavLink>
- *   </SideNav>
- * </Page.Sidebar>
+ * Collapsible desktop sidebar with persisted state. On smaller pages it
+ * becomes a popover whose trigger shows `currentPageTitle`.
  */
 export declare const PageSidebar: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
-    /**
-     * Key for storing sidebar collapsed state in localStorage
-     * @default "sidebar-collapsed"
-     */
+    /** Persists desktop collapsed state under this localStorage key. Defaults to `"sidebar-collapsed"`. */
     localStorageKey?: string;
-    /**
-     * Custom tracking ID for analytics
-     */
+    /** Overrides the generated tracking ID on the desktop toggle button. */
     "data-tracking-id"?: string;
-    /**
-     * Title to display in the adaptive trigger button
-     */
+    /** Smaller-page trigger text. Defaults to `"Menu"`. */
     currentPageTitle?: string;
 } & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/components/Page/PageSidebarHeader.d.ts

@@ -1,23 +1,5 @@
 import { ComponentPropsWithoutRef } from 'react';
-/**
- * Props for the PageSidebarHeader component
- * @extends ComponentPropsWithoutRef<"div">
- */
+/** @extends ComponentPropsWithoutRef<"div"> */
 export type PageSidebarHeaderProps = ComponentPropsWithoutRef<"div">;
-/**
- * PageSidebarHeader component for creating header sections within sidebars.
- *
- * Features:
- * - Container for sidebar header content
- * - Automatic visibility handling based on sidebar collapsed state
- * - Supports all standard div props
- * - Context-aware styling
- *
- * @example
- * <Page.SidebarHeader>
- *   <Text variant="headline" el="h2" size="medium">
- *     Sidebar Title
- *   </Text>
- * </Page.SidebarHeader>
- */
+/** Sidebar heading region hidden from accessibility when the sidebar collapses. */
 export declare const PageSidebarHeader: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/components/Page/pageBreakpoint.d.ts

@@ -1,26 +1,13 @@
 /**
- * The Page's `lg` breakpoint width in px — the boundary between the stacked
- * "mobile" layout (sidebar collapses to a popover trigger, panel becomes a
- * dialog, virtual scrollbar hidden) and the desktop layout. Parsed once from the
- * design token; falls back to `0` if the token is unavailable.
- *
- * Single source of truth for every width-driven layout decision in Page
- * (`PageSidebar`, `PagePanel`, `PageContent`) so they can never drift apart.
+ * Shared Page boundary between the adaptive and desktop layouts. Parsing once
+ * keeps Sidebar, Panel, and Content decisions aligned.
  */
 export declare const PAGE_LG_BREAKPOINT: number;
-/**
- * Whether the given page width should use the mobile layout (below `lg`).
- * Used by `PageSidebar`/`PagePanel` to swap to their popover/dialog forms.
- */
+/** Whether the page width uses the adaptive Sidebar and Panel forms. */
 export declare const isPageMobileWidth: (pageWidth: number | undefined) => boolean;
 /**
- * Whether the virtual scrollbar should render (desktop, `lg` and above).
- *
- * Gating the sized virtual-scroll spacer on this — rather than rendering it
- * unconditionally — is what prevents the `Page.Content` feedback loop: during
- * SSR/hydration `pageWidth` is `0` and the Page stylesheet has not yet pulled
- * the spacer out of flow, so an always-rendered spacer would round-trip through
- * the `document.scrollHeight` the ResizeObserver measures ("Maximum update depth
- * exceeded"). Below `lg` the spacer is never rendered, so it can never feed back.
+ * Whether Page.Content can render its virtual-scroll spacer. Requires a
+ * nonzero parsed breakpoint and a measured desktop width; otherwise the
+ * spacer could enter SSR/adaptive flow and feed back into observed height.
  */
 export declare const showsPageVirtualScroll: (pageWidth: number | undefined) => boolean;

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

@@ -1,60 +1,73 @@
 import { DataAttributes, DataTrackingId } from '../../types';
 import { PaginationProps as BasePaginationProps } from './internal/Pagination';
 /**
- * Props for the Pagination component
- * @property {number} page - The current page number
- * @property {number} itemsPerPage - Number of items displayed per page
- * @property {number[]} [itemsPerPageOptions] - Available options for items per page selection
- * @property {number} [totalItemCount] - Total number of items across all pages
- * @property {boolean} [showCount] - Whether to display the item count information
- * @property {(page: number) => void} [onPageChange] - Callback when page changes
- * @property {(itemsPerPage: number) => void} [onItemsPerPageChange] - Callback when items per page changes
- * @property {string} [itemsPerPageLabel] - Custom label displayed before the items-per-page selector. Defaults to "Rows per page"
  * @extends Omit<BasePaginationProps, "children">
  * @extends DataTrackingId
  * @extends DataAttributes
  */
 export type PaginationProps = Omit<BasePaginationProps, "children"> & DataTrackingId & DataAttributes & {
+    /**
+     * 1-based selected page. When it is not among the current page buttons
+     * and there is at least one page, `onPageChange(1)` runs after paint.
+     */
     page: number;
+    /** Page size used for total pages and the item-range text. */
     itemsPerPage: number;
+    /**
+     * When set, shows the rows-per-page menu. Hidden below the small
+     * breakpoint.
+     */
     itemsPerPageOptions?: number[];
+    /**
+     * Item total across pages. Omit to leave Next unbounded. `0` is an
+     * empty set.
+     */
     totalItemCount?: number;
+    /**
+     * Shows the visible item-range text when `totalItemCount` is set.
+     * Hidden below the small breakpoint. The live region still announces
+     * page and range.
+     */
     showCount?: boolean;
+    /** Called with the new 1-based page. */
     onPageChange?: (page: number) => void;
+    /** Called with the newly selected page size. */
     onItemsPerPageChange?: (itemsPerPage: number) => void;
+    /** Label before the page-size menu. Defaults to `"Rows per page"`. */
     itemsPerPageLabel?: string;
 };
 /**
- * Pagination component: page navigation controls — next, previous, and page numbers — for moving through a long, paged set of results. Includes automatic page array generation.
- *
- * Features:
- * - Automatic page array generation with overflow handling
- * - Supports items per page selection with customizable options
- * - Displays item count information with screen reader support
- * - Handles edge cases like invalid page numbers
- * - Includes previous/next navigation buttons
- * - Supports overflow menus for large page ranges
- * - Fully accessible with proper ARIA attributes
- * - Automatic tracking ID generation for analytics
- *
- * @example
- * <Pagination
- *   page={1}
- *   itemsPerPage={10}
- *   totalItemCount={100}
- *   itemsPerPageOptions={[10, 20, 50]}
- *   showCount={true}
- *   onPageChange={(page) => console.log('Page changed to:', page)}
- *   onItemsPerPageChange={(itemsPerPage) => console.log('Items per page:', itemsPerPage)}
- * />
+ * Paged navigation for a result set. Owns page-list generation, overflow,
+ * and the live region; List/Item/menus are internal chrome.
  */
 export declare const Pagination: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref">, "children"> & DataTrackingId & DataAttributes & {
+    /**
+     * 1-based selected page. When it is not among the current page buttons
+     * and there is at least one page, `onPageChange(1)` runs after paint.
+     */
     page: number;
+    /** Page size used for total pages and the item-range text. */
     itemsPerPage: number;
+    /**
+     * When set, shows the rows-per-page menu. Hidden below the small
+     * breakpoint.
+     */
     itemsPerPageOptions?: number[];
+    /**
+     * Item total across pages. Omit to leave Next unbounded. `0` is an
+     * empty set.
+     */
     totalItemCount?: number;
+    /**
+     * Shows the visible item-range text when `totalItemCount` is set.
+     * Hidden below the small breakpoint. The live region still announces
+     * page and range.
+     */
     showCount?: boolean;
+    /** Called with the new 1-based page. */
     onPageChange?: (page: number) => void;
+    /** Called with the newly selected page size. */
     onItemsPerPageChange?: (itemsPerPage: number) => void;
+    /** Label before the page-size menu. Defaults to `"Rows per page"`. */
     itemsPerPageLabel?: string;
 } & import('react').RefAttributes<HTMLDivElement>>;

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

@@ -1,32 +1,11 @@
 import { ComponentPropsWithoutRef } from 'react';
 /**
- * Props for the Pagination component
  * @extends ComponentPropsWithoutRef<"nav">
  */
 export type PaginationProps = ComponentPropsWithoutRef<"nav">;
-/**
- * Pagination component for navigating through paginated content.
- *
- * Features:
- * - Provides navigation controls for paginated data
- * - Supports compound components for flexible pagination layouts
- * - Includes list, items, overflow menu, items per page menu, and total count
- * - Accessible navigation with proper ARIA roles
- * - Customizable styling and layout
- *
- * @example
- * <Pagination>
- *   <Pagination.List>
- *     <Pagination.Item>1</Pagination.Item>
- *     <Pagination.Item>2</Pagination.Item>
- *     <Pagination.OverflowMenu />
- *     <Pagination.Item>10</Pagination.Item>
- *   </Pagination.List>
- *   <Pagination.ItemsPerPageMenu />
- *   <Pagination.TotalCount />
- * </Pagination>
- */
+/** Chrome host for the public Pagination wrapper's list and menus. */
 export declare const Pagination: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & import('react').RefAttributes<HTMLElement>> & {
+    /** Prev/next chrome around numbered page children. */
     List: import('react').ForwardRefExoticComponent<{
         page: number;
         totalPages: number;
@@ -35,11 +14,13 @@ export declare const Pagination: import('react').ForwardRefExoticComponent<Omit<
         children: React.ReactNode;
         className?: string;
     } & import('react').RefAttributes<HTMLUListElement>>;
+    /** Numbered page control. */
     Item: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>, "ref"> & {
         page: number;
         isActive?: boolean;
         onClick?: () => void;
     } & import('react').RefAttributes<HTMLLIElement>>;
+    /** Ellipsis menu for a contiguous hidden page range. */
     OverflowMenu: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>, "ref"> & {
         startPage: number;
         endPage: number;
@@ -47,7 +28,9 @@ export declare const Pagination: import('react').ForwardRefExoticComponent<Omit<
         currentPage: number;
         onItemClick: (page: number) => void;
     } & import('react').RefAttributes<HTMLLIElement>>;
+    /** Page-size selector. */
     ItemsPerPageMenu: import('react').ForwardRefExoticComponent<import('./PaginationItemsPerPageMenu').PaginationItemsPerPageMenuProps & import('react').RefAttributes<HTMLDivElement>>;
+    /** Visible item-range text. Decorative; the live region is on the wrapper. */
     TotalCount: ({ itemRangeText, className, }: {
         itemRangeText: string;
         className?: string;

package/dist/src/components/Pagination/internal/PaginationItem.d.ts

@@ -1,52 +1,19 @@
 import { ComponentPropsWithoutRef } from 'react';
 /**
- * Props for the PaginationItem component
  * @extends ComponentPropsWithoutRef<"li">
  */
 export type PaginationItemProps = ComponentPropsWithoutRef<"li"> & {
-    /**
-     * The page number to display.
-     */
+    /** 1-based page this control represents. */
     page: number;
-    /**
-     * Whether this page item is currently active/selected.
-     * @default false
-     */
+    /** Marks this control as the current page. Defaults to `false`. */
     isActive?: boolean;
-    /**
-     * Callback function called when the page item is clicked.
-     */
     onClick?: () => void;
 };
-/**
- * PaginationItem component for displaying individual page numbers in pagination.
- *
- * Features:
- * - Displays page number as a toggle button
- * - Supports active state styling
- * - Fully accessible with proper ARIA attributes
- * - Integrates with pagination navigation system
- * - Consistent styling with design system
- *
- * @example
- * <PaginationItem
- *   page={3}
- *   isActive={true}
- *   onClick={() => console.log('Page 3 clicked')}
- * />
- */
+/** Numbered page control. */
 export declare const PaginationItem: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>, "ref"> & {
-    /**
-     * The page number to display.
-     */
+    /** 1-based page this control represents. */
     page: number;
-    /**
-     * Whether this page item is currently active/selected.
-     * @default false
-     */
+    /** Marks this control as the current page. Defaults to `false`. */
     isActive?: boolean;
-    /**
-     * Callback function called when the page item is clicked.
-     */
     onClick?: () => void;
 } & import('react').RefAttributes<HTMLLIElement>>;

package/dist/src/components/Pagination/internal/PaginationItemsPerPageMenu.d.ts

@@ -1,42 +1,12 @@
-/**
- * Props for the PaginationItemsPerPageMenu component
- */
 export type PaginationItemsPerPageMenuProps = {
-    /**
-     * The currently selected number of items per page.
-     */
+    /** Current page size shown on the trigger. */
     itemsPerPage: number;
-    /**
-     * Array of available options for items per page.
-     */
+    /** Menu options; selecting one calls `onItemsPerPageChange`. */
     itemsPerPageOptions: number[];
-    /**
-     * Callback function called when the items per page selection changes.
-     * @param itemsPerPage The new number of items per page
-     */
+    /** Called with the newly selected page size. */
     onItemsPerPageChange: (itemsPerPage: number) => void;
-    /**
-     * Custom label displayed before the items-per-page selector.
-     * @default "Rows per page"
-     */
+    /** Label before the trigger. Defaults to `"Rows per page"`. */
     itemsPerPageLabel?: string;
 };
-/**
- * PaginationItemsPerPageMenu component for selecting the number of items per page.
- *
- * Features:
- * - Displays current items per page selection
- * - Provides dropdown menu with available options
- * - Integrates with pagination system
- * - Shows "Rows per page" label for clarity
- * - Fully accessible with proper ARIA attributes
- * - Consistent styling with design system
- *
- * @example
- * <PaginationItemsPerPageMenu
- *   itemsPerPage={10}
- *   itemsPerPageOptions={[5, 10, 25, 50]}
- *   onItemsPerPageChange={(itemsPerPage) => console.log('Items per page:', itemsPerPage)}
- * />
- */
+/** Page-size selector used by the public Pagination wrapper. */
 export declare const PaginationItemsPerPageMenu: import('react').ForwardRefExoticComponent<PaginationItemsPerPageMenuProps & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/components/Pagination/internal/PaginationOverflowMenu.d.ts

@@ -1,72 +1,32 @@
 import { ComponentPropsWithoutRef } from 'react';
 /**
- * Props for the PaginationOverflowMenu component
  * @extends ComponentPropsWithoutRef<"li">
  */
 export type PaginationOverflowMenuProps = ComponentPropsWithoutRef<"li"> & {
-    /**
-     * The starting page number for the overflow range.
-     */
+    /** First page in this collapsed range, inclusive. */
     startPage: number;
-    /**
-     * The ending page number for the overflow range.
-     */
+    /** Last page in this collapsed range, inclusive. */
     endPage: number;
-    /**
-     * The number of pages in the overflow range.
-     */
+    /** Inclusive page count; drives the virtualized scroller height. */
     length: number;
-    /**
-     * The current active page in the parent pagination.
-     */
+    /** Selected page on the parent; used as the menu's initial focus. */
     currentPage: number;
-    /**
-     * Callback function called when a page in the overflow menu is selected.
-     * @param page The selected page number
-     */
+    /** Called with the chosen page from the overflow list. */
     onItemClick: (page: number) => void;
 };
 /**
- * PaginationOverflowMenu component for displaying overflow pages in pagination.
- *
- * Features:
- * - Displays ellipsis menu for large page ranges
- * - Renders the page items as a virtualized window — only the slice visible
- *   in the scroller is in the DOM at any time, keeping pagination cheap
- *   even when the overflow spans tens of thousands of pages
- * - Integrates with pagination navigation system
- * - Fully accessible with proper ARIA labels
- * - Consistent styling with design system
- *
- * @example
- * <PaginationOverflowMenu
- *   startPage={4}
- *   endPage={8}
- *   length={5}
- *   currentPage={4}
- *   onItemClick={(page) => console.log('Page selected:', page)}
- * />
+ * Ellipsis menu for a collapsed page range. Only the visible scroller slice
+ * is in the DOM, so long ranges stay cheap.
  */
 export declare const PaginationOverflowMenu: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>, "ref"> & {
-    /**
-     * The starting page number for the overflow range.
-     */
+    /** First page in this collapsed range, inclusive. */
     startPage: number;
-    /**
-     * The ending page number for the overflow range.
-     */
+    /** Last page in this collapsed range, inclusive. */
     endPage: number;
-    /**
-     * The number of pages in the overflow range.
-     */
+    /** Inclusive page count; drives the virtualized scroller height. */
     length: number;
-    /**
-     * The current active page in the parent pagination.
-     */
+    /** Selected page on the parent; used as the menu's initial focus. */
     currentPage: number;
-    /**
-     * Callback function called when a page in the overflow menu is selected.
-     * @param page The selected page number
-     */
+    /** Called with the chosen page from the overflow list. */
     onItemClick: (page: number) => void;
 } & import('react').RefAttributes<HTMLLIElement>>;

package/dist/src/components/Pagination/internal/usePaginationArray.d.ts

@@ -8,26 +8,11 @@ export type PageArrayItem = {
     length: number;
 };
 /**
- * Custom hook for managing pagination array state and generation.
+ * Visible page slots for the current page. Reuses the previous list when the
+ * new page is already shown; regenerates when the page jumps across or into
+ * an overflow range.
  *
- * Features:
- * - Automatically generates pagination array based on current page and total pages
- * - Avoids unnecessary regeneration if the current page is already visible
- * - Updates array when page or total pages change and the visible set must change
- * - Handles jumps to first/last page with overflow between current and target
- * - Provides stable reference for the current pagination array
- *
- * @param page The currently selected page
- * @param totalPages Total number of pages
- * @param maxArrayLength Maximum length of the pagination array (including overflows)
- * @returns The current pagination array
- *
- * @example
- * const pageArray = usePaginationArray({
- *   page: 5,
- *   totalPages: 10,
- *   maxArrayLength: 7
- * });
+ * `maxArrayLength` counts page buttons and overflow slots. Defaults to `7`.
  */
 export declare const usePaginationArray: ({ page, totalPages, maxArrayLength, }: {
     page: number;

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

@@ -1,28 +1,17 @@
 /**
  * `data-anv-part` names for Pagination's interactive sub-elements.
  *
- * Scope a query by the consumer's `data-cy` on the Pagination root
- * (`[data-cy="x"] [data-anv-part="next-page-button"]`).
- *
- * Repeated parts use secondary discriminators:
- * - page buttons / overflow options: `data-page`
- * - items-per-page options: `data-items-per-page`
- *
- * Overflow and items-per-page menus render in the browser top layer — target
- * `option` parts by attribute (or after opening the matching trigger), not as
- * descendants of the Pagination root.
+ * Repeated parts use `data-page` (page buttons / overflow options) or
+ * `data-items-per-page`. Overflow and items-per-page menus render in the
+ * top layer — target `option` by attribute, not as descendants of the root.
  */
 export declare const PARTS: {
     /** Shared role for menu options (overflow pages + items-per-page). */
     readonly option: "option";
-    /** Previous-page control. */
     readonly prevPageButton: "prev-page-button";
-    /** Next-page control. */
     readonly nextPageButton: "next-page-button";
     /** Numbered page control. Narrow with `data-page`. */
     readonly pageButton: "page-button";
-    /** Ellipsis control that opens the overflow page menu. */
     readonly overflowTrigger: "overflow-trigger";
-    /** Control that opens the items-per-page menu. */
     readonly itemsPerPageTrigger: "items-per-page-trigger";
 };