@servicetitan/anvil2 3.14.0 → 3.15.0

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

@@ -1,82 +1,32 @@
 import { ComponentPropsWithoutRef, MouseEvent } from 'react';
 import { DataTrackingId, LayoutUtilProps } from '../../types';
 /**
- * Props for the OverflowText component
- * @extends ComponentPropsWithoutRef<"div">
- * @extends LayoutUtilProps
+ * `expandable` is a union: omit or `false` clamps without a control;
+ * `true` adds expand/collapse when the clamp clips.
  */
 export type OverflowTextProps = ComponentPropsWithoutRef<"div"> & LayoutUtilProps & {
     /**
-     * Number of rows to display before truncation
-     * @default 1
+     * Line clamp. `"unlimited"` does not clamp. Defaults to `1`.
      */
     rows?: number | "unlimited";
 } & ({
-    /**
-     * Whether the text is expandable
-     * @default false
-     */
+    /** No expand control. Defaults to `false`. */
     expandable?: false;
-    /**
-     * Text for expand button (not used when expandable is false)
-     */
     expandText?: never;
-    /**
-     * Text for collapse button (not used when expandable is false)
-     */
     collapseText?: never;
-    /**
-     * Callback for expand event (not used when expandable is false)
-     */
     onExpand?: never;
-    /**
-     * Callback for collapse event (not used when expandable is false)
-     */
     onCollapse?: never;
 } | {
-    /**
-     * Whether the text is expandable
-     */
+    /** Shows expand/collapse when the clamp clips. */
     expandable: true;
-    /**
-     * Text to display on the expand button
-     * @default "Show more..."
-     */
+    /** Expand control label. Defaults to `"Show more..."`. */
     expandText?: string;
-    /**
-     * Text to display on the collapse button
-     * @default "Show less..."
-     */
+    /** Collapse control label. Defaults to `"Show less..."`. */
     collapseText?: string;
-    /**
-     * Callback fired when content is expanded
-     */
+    /** Fires when the control expands the text. */
     onExpand?: (e: MouseEvent<HTMLButtonElement>) => void;
-    /**
-     * Callback fired when content is collapsed
-     */
+    /** Fires when the control collapses the text. */
     onCollapse?: (e: MouseEvent<HTMLButtonElement>) => void;
 }) & DataTrackingId;
-/**
- * OverflowText component for text content with line truncation and expansion.
- *
- * Features:
- * - Configurable line limit with row-based truncation
- * - Expandable content with custom expand/collapse text
- * - Automatic height calculation and overflow detection
- * - Keyboard navigation support for focusable elements
- * - Resize observer for dynamic content changes
- * - Accessibility features with proper focus management
- * - Support for unlimited rows or specific row limits
- * - Callback support for expand/collapse events
- * - Layout utility props support
- *
- * @example
- * <OverflowText rows={3} expandable>
- *   <Text>
- *     This is a long text that will be truncated to 3 rows
- *     and can be expanded to show the full content.
- *   </Text>
- * </OverflowText>
- */
+/** Line-clamped text. `expandable` adds a control when content exceeds `rows`. */
 export declare const OverflowText: import('react').ForwardRefExoticComponent<OverflowTextProps & import('react').RefAttributes<HTMLDivElement>>;

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

@@ -1,29 +1,12 @@
 import { OverflowProps } from './Overflow';
 import { OverflowText, OverflowTextProps } from './OverflowText';
 /**
- * Overflow component for handling content that exceeds container boundaries.
- *
- * Features:
- * - Supports both horizontal and vertical overflow
- * - Automatic shadow indicators for scrollable content
- * - Truncation with expand/collapse functionality
- * - Keyboard navigation support for focusable elements
- * - Automatic height and width management
- * - Layout utility props support
- * - Resize observer for dynamic content changes
- * - Accessibility features with proper focus management
- * - Scroll event handling with shadow updates
- *
- * @example
- * <Overflow direction="column" height={400} gap="4">
- *   {items.map((item, i) => (
- *     <Card key={i} style={{ width: "100%", minHeight: 100 }}>
- *       {item.content}
- *     </Card>
- *   ))}
- * </Overflow>
+ * Scrollable container with edge shadows. Optional `truncate` adds
+ * expand/collapse (column only). `ref` is the outer wrapper; `contentRef` is
+ * the scroller.
  */
 export declare const Overflow: import('react').ForwardRefExoticComponent<OverflowProps & import('react').RefAttributes<HTMLDivElement>> & {
+    /** Line-clamped text with optional expand/collapse. */
     Text: import('react').ForwardRefExoticComponent<OverflowTextProps & import('react').RefAttributes<HTMLDivElement>>;
 };
 export default Overflow;

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

@@ -1,123 +1,22 @@
 import { ComponentPropsWithoutRef } from 'react';
 /**
- * Props for the Page component
  * @extends ComponentPropsWithoutRef<"div">
  */
 export type PageProps = ComponentPropsWithoutRef<"div">;
 /**
- * Page component for creating full-page layouts with navigation and content areas.
- *
- * Features:
- * - Container for complete page layouts
- * - Supports sidebar navigation with collapsible state
- * - Header with breadcrumbs, chips, and action buttons
- * - Main content area with virtual scrolling
- * - Optional slide-out panels with responsive dialog fallback
- * - Footer with layout utilities
- * - Responsive design with mobile adaptations
- * - Accessibility support with proper landmarks
- * - Automatic tracking ID generation for analytics
- * - Local storage persistence for sidebar state
- *
- * @example
- * <Page>
- *   <Page.Sidebar currentPageTitle="Navigation">
- *     <Page.SidebarHeader>
- *       <Text variant="headline" el="h2">Navigation</Text>
- *     </Page.SidebarHeader>
- *     <SideNav>
- *       <SideNavLink pathname="/">Home</SideNavLink>
- *     </SideNav>
- *   </Page.Sidebar>
- *   <Page.Header
- *     title="Page Title"
- *     breadcrumbs={[{ href: "/", children: "Home" }]}
- *     actions={{ primary: { label: "Save", onClick: handleSave } }}
- *   />
- *   <Page.Content>
- *     <Text>Main content</Text>
- *   </Page.Content>
- *   <Page.Panel open={isPanelOpen} size="medium">
- *     <Text>Panel content</Text>
- *   </Page.Panel>
- *   <Page.Footer>
- *     <Text>Footer content</Text>
- *   </Page.Footer>
- * </Page>
+ * Full-page shell with optional Sidebar, Header, Content, Panel, and Footer
+ * regions. Content and Footer portal into the shell's main and footer slots.
  */
 export declare const Page: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & import('react').RefAttributes<HTMLDivElement>> & {
-    /**
-     * 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 that becomes a popover on smaller pages. */
     Sidebar: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
         localStorageKey?: string;
         "data-tracking-id"?: string;
         currentPageTitle?: string;
     } & import('react').RefAttributes<HTMLDivElement>>;
-    /**
-     * 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 collapsed. */
     SidebarHeader: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & import('react').RefAttributes<HTMLDivElement>>;
-    /**
-     * PageHeader component for creating page headers with navigation and actions.
-     *
-     * Features:
-     * - Page title with semantic heading
-     * - Breadcrumb navigation support
-     * - Status chips display
-     * - Primary and secondary action buttons
-     * - Preference action button/link
-     * - Responsive layout with fluid grid
-     * - Accessibility support with proper ARIA labels
-     * - Flexible layout configuration
-     * - Description content support
-     *
-     * @example
-     * <Page.Header
-     *   title="Page Title"
-     *   breadcrumbs={[
-     *     { href: "/", children: "Home" },
-     *     { children: "Current Page" }
-     *   ]}
-     *   chips={[{ label: "Status" }]}
-     *   actions={{
-     *     primary: { label: "Save", onClick: handleSave },
-     *     secondary: [{ label: "Cancel", onClick: handleCancel }]
-     *   }}
-     * />
-     */
+    /** Page heading, breadcrumbs, status, description, and actions. */
     Header: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref">, "title"> & {
         title: string | {
             text: string;
@@ -151,42 +50,9 @@ export declare const Page: import('react').ForwardRefExoticComponent<Omit<import
         });
         layout?: import('..').LayoutProps;
     } & import('react').RefAttributes<HTMLHeadElement>>;
-    /**
-     * PageContent component for the main content area of a page.
-     *
-     * Features:
-     * - Renders as a section element inside Page's main landmark
-     * - Virtual scrolling support for long content
-     * - Automatic scroll synchronization
-     * - Responsive design
-     * - Portals into Page's content wrapper via context
-     * - Scroll position management
-     *
-     * @example
-     * <Page.Content>
-     *   <Text>Main page content goes here</Text>
-     *   <Button>Action Button</Button>
-     * </Page.Content>
-     */
+    /** Section portaled into Page's main landmark. */
     Content: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & import('react').RefAttributes<HTMLElement>>;
-    /**
-     * PagePanel component for creating slide-out panels or dialogs.
-     *
-     * Features:
-     * - Responsive design with dialog fallback on mobile
-     * - Multiple size variants (small, medium, large)
-     * - Optional padding control
-     * - Persistent or controlled open state
-     * - Automatic mobile dialog conversion
-     * - Keyboard navigation and accessibility support
-     * - Smooth animations and transitions
-     *
-     * @example
-     * <Page.Panel open={isOpen} size="medium">
-     *   <Text variant="headline" el="h3">Panel Content</Text>
-     *   <Button onClick={() => setIsOpen(false)}>Close</Button>
-     * </Page.Panel>
-     */
+    /** Omit `open` for a persistent panel; a controlled panel becomes a Dialog on smaller pages. */
     Panel: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
         open?: boolean;
         size?: "small" | "medium" | "large";
@@ -194,20 +60,6 @@ export declare const Page: import('react').ForwardRefExoticComponent<Omit<import
         defaultDrillDownIndex?: import('../DrillDown/internal/DrillDownContext').DrillDownContextProps["index"];
         onDrillDownContextChange?: (context: import('../DrillDown/internal/DrillDownContext').DrillDownContextProps) => void;
     } & import('react').RefAttributes<HTMLDivElement>>;
-    /**
-     * PageFooter component for creating page footers with layout utilities.
-     *
-     * Features:
-     * - Semantic footer element
-     * - Layout utility props support
-     * - Responsive design
-     * - Accessibility support with proper footer landmark
-     * - Flexible content positioning
-     *
-     * @example
-     * <Page.Footer>
-     *   <Text>Footer content with layout utilities</Text>
-     * </Page.Footer>
-     */
+    /** Footer portaled into Page's footer slot. */
     Footer: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & import('..').LayoutUtilProps & import('react').RefAttributes<HTMLDivElement>>;
 };

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

@@ -1,24 +1,9 @@
 import { ComponentPropsWithoutRef } from 'react';
-/**
- * Props for the PageContent component
- * @extends ComponentPropsWithoutRef<"section">
- */
+/** @extends ComponentPropsWithoutRef<"section"> */
 export type PageContentProps = ComponentPropsWithoutRef<"section">;
 /**
- * PageContent component for the main content area of a page.
- *
- * Features:
- * - Renders as a section element inside Page's main landmark
- * - Virtual scrolling support for long content
- * - Automatic scroll synchronization
- * - Responsive design
- * - Portals into Page's content wrapper via context
- * - Scroll position management
- *
- * @example
- * <Page.Content>
- *   <Text>Main page content goes here</Text>
- *   <Button>Action Button</Button>
- * </Page.Content>
+ * Main content section with a desktop virtual scrollbar synchronized to the
+ * document. It renders in place outside Page, waits for Page's main slot, then
+ * portals into that landmark.
  */
 export declare const PageContent: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & import('react').RefAttributes<HTMLElement>>;

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

@@ -1,6 +1,15 @@
 export declare const PageContext: import('react').Context<PageContextProps>;
 export type PageContextProps = {
+    /** Observed width of the Page root; undefined outside Page. */
     pageWidth?: number;
+    /**
+     * Main portal target. Undefined outside Page renders Content in place; null
+     * inside Page renders nothing until the slot mounts.
+     */
     contentWrapper?: HTMLElement | null;
+    /**
+     * Footer portal target. Undefined outside Page renders Footer in place; null
+     * inside Page renders nothing until the slot mounts.
+     */
     footerSlot?: HTMLElement | null;
 };

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

@@ -1,25 +1,12 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { LayoutUtilProps } from '../../types';
 /**
- * Props for the PageFooter component
  * @extends ComponentPropsWithoutRef<"div">
  * @extends LayoutUtilProps
  */
 export type PageFooterProps = ComponentPropsWithoutRef<"div"> & LayoutUtilProps;
 /**
- * PageFooter component for creating page footers with layout utilities.
- *
- * Features:
- * - Semantic footer element
- * - Layout utility props support
- * - Responsive design
- * - Accessibility support with proper footer landmark
- * - Flexible content positioning
- * - Portals into Page's footer slot via context
- *
- * @example
- * <Page.Footer>
- *   <Text>Footer content with layout utilities</Text>
- * </Page.Footer>
+ * Footer landmark. It renders in place outside Page, waits for Page's footer
+ * slot, then portals into it.
  */
 export declare const PageFooter: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & LayoutUtilProps & import('react').RefAttributes<HTMLDivElement>>;

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

@@ -1,13 +1,8 @@
 import { ButtonProps, ButtonLinkProps, BreadcrumbsLinkProps, ChipProps } from '../';
 import { ComponentPropsWithoutRef, ReactNode } from 'react';
 import { LayoutProps } from '../Layout';
-/**
- * Props for page header action buttons
- */
 type PageHeaderActionProps = Omit<ButtonProps, "appearance"> & {
-    /**
-     * Label text for the action button
-     */
+    /** Visible button text, or menu-item text when nested under `items`. */
     label: string;
 };
 /**
@@ -17,14 +12,9 @@ type PageHeaderActionProps = Omit<ButtonProps, "appearance"> & {
  * Anvil does not support.
  */
 type PageHeaderMenuActionProps = Omit<PageHeaderActionProps, "onClick"> & {
-    /**
-     * Actions listed in the menu this button opens
-     */
+    /** Replaces a direct click handler with a menu opened by the primary button. */
     items: PageHeaderActionProps[];
 };
-/**
- * Props for page header actions configuration
- */
 type PageHeaderActionsProps = {
     /**
      * Primary action button. Pass `items` instead of `onClick` to render a
@@ -32,125 +22,88 @@ type PageHeaderActionsProps = {
      */
     primary?: PageHeaderActionProps | PageHeaderMenuActionProps;
     /**
-     * Array of secondary action buttons
+     * Secondary buttons. Three or more, or two alongside a primary action,
+     * collapse into a More actions menu.
      */
     secondary?: PageHeaderActionProps[];
 };
-/**
- * Base props for preference actions
- */
 type BasePreferenceProps = {
-    /**
-     * Accessible label for the preference action
-     */
+    /** Names the icon-only control and supplies its tooltip text. */
     "aria-label": string;
 };
-/**
- * Props for preference button actions
- */
 type PreferenceButtonProps = Omit<ButtonProps, "aria-label" | "icon" | "appearance" | "size" | "className"> & BasePreferenceProps;
-/**
- * Props for preference link actions
- */
 type PreferenceLinkProps = Omit<ButtonLinkProps, "aria-label" | "icon" | "appearance" | "size" | "className"> & BasePreferenceProps;
 type PageHeaderTitleConfig = {
+    /** Rendered in the page's `h1` and used to initialize the edit field. */
     text: string;
+    /**
+     * Makes the title editable. Return `false` to keep the editor open after
+     * submit or confirmation.
+     */
     onChange?: (title: string) => void | boolean;
+    /** Accessible name and tooltip for entering edit mode. Defaults to `"Edit title"`. */
     editButtonLabel?: string;
+    /** Accessible name for the title field. Defaults to `"Page title"`. */
     editFieldLabel?: string;
+    /** Accessible name and tooltip for confirmation. Defaults to `"Update title"`. */
     confirmButtonLabel?: string;
+    /** Accessible name and tooltip for cancellation. Defaults to `"Cancel"`. */
     cancelButtonLabel?: string;
 };
 type PageHeaderTitle = PageHeaderTitleConfig["text"] | PageHeaderTitleConfig;
-/**
- * Props for the PageHeader component
- * @extends ComponentPropsWithoutRef<"header">
- */
+/** @extends Omit<ComponentPropsWithoutRef<"header">, "title"> */
 export type PageHeaderProps = Omit<ComponentPropsWithoutRef<"header">, "title"> & {
     /**
-     * Main title of the page
+     * Page `h1`. A string is read-only; the object form enables inline editing
+     * when it includes `onChange`.
      */
     title: PageHeaderTitle;
-    /**
-     * Breadcrumb navigation links
-     */
+    /** Rendered before the title as `Breadcrumbs.Link` items. */
     breadcrumbs?: BreadcrumbsLinkProps[];
-    /**
-     * Status chips to display
-     */
+    /** Status chips rendered below the title. */
     chips?: ChipProps[];
-    /**
-     * Description text or content below the title
-     */
+    /** Full-width content below the title and actions. */
     description?: ReactNode;
     /**
-     * Primary and secondary action buttons
+     * Primary and secondary controls. Secondary actions overflow into More
+     * actions at three items, or two alongside a primary; primary `items` make
+     * that button a menu.
      */
     actions?: PageHeaderActionsProps;
-    /**
-     * Preference action button or link
-     */
+    /** Settings-icon action. An `href` renders a link; otherwise it is a button. */
     preferenceAction?: PreferenceButtonProps | PreferenceLinkProps;
     /**
-     * Layout configuration for the header
+     * Header {@link LayoutProps}. When unset, the header uses the default fixed
+     * 1280px layout. Match the `fluid` and `variant` of the `Layout` inside
+     * `Page.Content`.
      */
     layout?: LayoutProps;
 };
-/**
- * PageHeader component for creating page headers with navigation and actions.
- *
- * Features:
- * - Page title with semantic heading
- * - Breadcrumb navigation support
- * - Status chips display
- * - Primary and secondary action buttons
- * - Preference action button/link
- * - Responsive layout with fluid grid
- * - Accessibility support with proper ARIA labels
- * - Flexible layout configuration
- * - Description content support
- *
- * @example
- * <Page.Header
- *   title="Page Title"
- *   breadcrumbs={[
- *     { href: "/", children: "Home" },
- *     { children: "Current Page" }
- *   ]}
- *   chips={[{ label: "Status" }]}
- *   actions={{
- *     primary: { label: "Save", onClick: handleSave },
- *     secondary: [{ label: "Cancel", onClick: handleCancel }]
- *   }}
- * />
- */
+/** Page heading with optional breadcrumbs, status, description, and actions. */
 export declare const PageHeader: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref">, "title"> & {
     /**
-     * Main title of the page
+     * Page `h1`. A string is read-only; the object form enables inline editing
+     * when it includes `onChange`.
      */
     title: PageHeaderTitle;
-    /**
-     * Breadcrumb navigation links
-     */
+    /** Rendered before the title as `Breadcrumbs.Link` items. */
     breadcrumbs?: BreadcrumbsLinkProps[];
-    /**
-     * Status chips to display
-     */
+    /** Status chips rendered below the title. */
     chips?: ChipProps[];
-    /**
-     * Description text or content below the title
-     */
+    /** Full-width content below the title and actions. */
     description?: ReactNode;
     /**
-     * Primary and secondary action buttons
+     * Primary and secondary controls. Secondary actions overflow into More
+     * actions at three items, or two alongside a primary; primary `items` make
+     * that button a menu.
      */
     actions?: PageHeaderActionsProps;
-    /**
-     * Preference action button or link
-     */
+    /** Settings-icon action. An `href` renders a link; otherwise it is a button. */
     preferenceAction?: PreferenceButtonProps | PreferenceLinkProps;
     /**
-     * Layout configuration for the header
+     * Header {@link LayoutProps}. When unset, the header uses the default fixed
+     * 1280px layout. Match the `fluid` and `variant` of the `Layout` inside
+     * `Page.Content`.
      */
     layout?: LayoutProps;
 } & import('react').RefAttributes<HTMLHeadElement>>;