@servicetitan/anvil2 3.14.1 → 3.15.1

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

@@ -1,46 +1,19 @@
 import { SideNavLinkProps as CoreSideNavLinkProps } from './internal/SideNavLink';
-/**
- * Props for SideNavLink with routing support
- * @property {string} [href] - URL for the link (used when pathname is not provided)
- * @property {string} pathname - Pathname for client-side routing
- * @property {string} [search] - Optional search parameters for the URL
- * @property {boolean} [active] - When true, marks the link as the current active page
- * @property {boolean} [disabled] - When true, disables the link and prevents interaction
- * @extends CoreSideNavLinkProps
- */
 type SideNavLinkWithRoutingProps = CoreSideNavLinkProps & {
     /**
-     * Pathname for client-side routing
+     * Selects the in-app routing branch. `href` becomes `pathname` + `search`,
+     * click `pushState`s, and `active` is `pathname ===` the provider location
+     * (the `active` prop is ignored).
      */
     pathname: string;
-    /**
-     * Optional search parameters for the URL
-     */
+    /** Appended to `pathname` for `href` and `pushState`. */
     search?: string;
 };
-export type SideNavLinkProps = CoreSideNavLinkProps | SideNavLinkWithRoutingProps;
 /**
- * SideNavLink component for individual navigation links within a SideNav.
- *
- * 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
- * - Automatic active state tracking through context
- * - Client-side routing support with pathname prop
- * - Automatic tracking ID generation for analytics
- *
- * @example
- * <SideNav.Link id="intro" href="/intro" active>
- *   Introduction
- * </SideNav.Link>
- *
- * <SideNav.Link id="intro" pathname="/intro" active>
- *   Introduction (with routing)
- * </SideNav.Link>
+ * `href` is a normal link. Pass `pathname` (optional `search`) for in-app
+ * `history.pushState` routing; that branch derives `active` from location
+ * and ignores a passed `active`.
  */
+export type SideNavLinkProps = CoreSideNavLinkProps | SideNavLinkWithRoutingProps;
 export declare const SideNavLink: import('react').ForwardRefExoticComponent<SideNavLinkProps & import('react').RefAttributes<HTMLLIElement>>;
 export {};

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

@@ -1,20 +1,8 @@
-/**
- * Interface for the side navigation context
- */
 interface ISideNavContext {
-    /**
-     * Current location pathname for routing
-     */
     location: string;
-    /**
-     * Function to update the current location
-     */
     setLocation: (location: string) => void;
 }
 export declare const SideNavContext: React.Context<ISideNavContext>;
-/**
- * Custom hook for accessing the SideNav context.
- * @returns The SideNav context with location and setLocation
- */
+/** Reads the routing location SideNavProvider stores for `pathname` links. */
 export declare const useSideNavContext: () => ISideNavContext;
 export {};

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

@@ -1,74 +1,38 @@
 import { ComponentPropsWithoutRef, KeyboardEvent, MouseEvent } from 'react';
 /**
- * Props for the SideNavLink component
  * @extends Omit<ComponentPropsWithoutRef<"a">, "id" | "onClick" | "onKeyDown" | "onKeyUp">
  */
 export type SideNavLinkProps = Omit<ComponentPropsWithoutRef<"a">, "id" | "onClick" | "onKeyDown" | "onKeyUp"> & {
-    /**
-     * Unique identifier for the navigation link
-     */
+    /** DOM `id` of the `<a>`. Also the key in the nav active set when `active`. */
     id: string;
     /**
-     * When true, marks the link as the current active page
+     * Current page. Sets `aria-current="page"` and puts this link in the
+     * roving tab sequence.
      */
     active?: boolean;
-    /**
-     * When true, disables the link and prevents interaction
-     */
+    /** Blocks navigation and Space/Enter activation. Defaults to `false`. */
     disabled?: boolean;
-    /**
-     * Function called when the link is clicked
-     */
+    /** Runs after the roving tabindex update. Receives this link's `id`. */
     onClick?: (e: MouseEvent<HTMLAnchorElement>, id: SideNavLinkProps["id"]) => void;
-    /**
-     * Function called when a key is pressed down on the link
-     */
+    /** Runs after the keydown handler. Receives this link's `id`. */
     onKeyDown?: (e: KeyboardEvent<HTMLAnchorElement>, id: SideNavLinkProps["id"]) => void;
-    /**
-     * Function called when a key is released on the link
-     */
+    /** Receives this link's `id`. Space/Enter synthesize a click when `onClick` is set. */
     onKeyUp?: (e: KeyboardEvent<HTMLAnchorElement>, id: SideNavLinkProps["id"]) => void;
 };
-/**
- * SideNavLink component for individual navigation links within a SideNav.
- *
- * 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
- * - Automatic active state tracking through context
- *
- * @example
- * <SideNav.Link id="intro" href="/intro" active>
- *   Introduction
- * </SideNav.Link>
- */
 export declare const SideNavLink: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, "ref">, "id" | "onKeyDown" | "onKeyUp" | "onClick"> & {
-    /**
-     * Unique identifier for the navigation link
-     */
+    /** DOM `id` of the `<a>`. Also the key in the nav active set when `active`. */
     id: string;
     /**
-     * When true, marks the link as the current active page
+     * Current page. Sets `aria-current="page"` and puts this link in the
+     * roving tab sequence.
      */
     active?: boolean;
-    /**
-     * When true, disables the link and prevents interaction
-     */
+    /** Blocks navigation and Space/Enter activation. Defaults to `false`. */
     disabled?: boolean;
-    /**
-     * Function called when the link is clicked
-     */
+    /** Runs after the roving tabindex update. Receives this link's `id`. */
     onClick?: (e: MouseEvent<HTMLAnchorElement>, id: SideNavLinkProps["id"]) => void;
-    /**
-     * Function called when a key is pressed down on the link
-     */
+    /** Runs after the keydown handler. Receives this link's `id`. */
     onKeyDown?: (e: KeyboardEvent<HTMLAnchorElement>, id: SideNavLinkProps["id"]) => void;
-    /**
-     * Function called when a key is released on the link
-     */
+    /** Receives this link's `id`. Space/Enter synthesize a click when `onClick` is set. */
     onKeyUp?: (e: KeyboardEvent<HTMLAnchorElement>, id: SideNavLinkProps["id"]) => void;
 } & import('react').RefAttributes<HTMLLIElement>>;

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

@@ -1,19 +1,3 @@
 import { PropsWithChildren } from 'react';
-/**
- * SideNavProvider component for managing routing state in SideNav components.
- *
- * Features:
- * - Provides routing context for SideNav components
- * - Manages current location state
- * - Enables client-side routing without page reloads
- * - Integrates with browser history API
- * - Context provider for child components
- *
- * @example
- * <SideNavProvider>
- *   <SideNav>
- *     <SideNav.Link pathname="/intro">Introduction</SideNav.Link>
- *   </SideNav>
- * </SideNavProvider>
- */
+/** Holds `location` for `pathname` links. SideNav already wraps itself in this. */
 export declare const SideNavProvider: ({ children }: PropsWithChildren) => import("react/jsx-runtime").JSX.Element;

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

@@ -1,16 +1,4 @@
 import { KeyboardEvent, RefObject } from 'react';
 import { SideNavContextProps } from '../SideNavContext';
-/**
- * Handles keyboard navigation for SideNav components using arrow keys.
- *
- * This function manages focus movement between navigable elements in a SideNav,
- * providing circular navigation (wrapping from last to first and vice versa).
- * It updates tabindex attributes to maintain proper focus management and
- * prevents default browser behavior for arrow key navigation.
- *
- * @param e - The keyboard event that triggered the navigation
- * @param links - NodeList of all navigable elements in the SideNav
- * @param current - Ref object pointing to the currently focused element
- * @returns void
- */
+/** ArrowUp/ArrowDown move roving tabindex and focus, wrapping at the ends. */
 export declare const sideNavKeyboardNavigation: (e: KeyboardEvent<HTMLAnchorElement | HTMLButtonElement>, links: SideNavContextProps["links"], current: RefObject<HTMLAnchorElement | HTMLButtonElement>) => void;

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

@@ -1,6 +1,5 @@
 /**
- * Custom hook for accessing the SideNav context.
- * @returns The SideNav context with links, activeIds, and utility functions
- * @throws Error if used outside of a SideNav component
+ * Reads SideNav keyboard and active-id context.
+ * @throws When called outside a SideNav.
  */
 export declare const useSideNav: () => import('./SideNavContext').SideNavContextProps;

package/dist/src/components/Skeleton/SkeletonCircle.d.ts

@@ -1,49 +1,15 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { LayoutUtilProps } from '../../types';
-/**
- * Props for the SkeletonCircle component
- * @extends Omit<ComponentPropsWithoutRef<"div">, "children">
- * @extends Omit<LayoutUtilProps, "flex" | "flexBasis" | "flexGrow" | "flexShrink">
- */
 export type SkeletonCircleProps = Omit<ComponentPropsWithoutRef<"div">, "children"> & Omit<LayoutUtilProps, "flex" | "flexBasis" | "flexGrow" | "flexShrink"> & {
-    /**
-     * The diameter of the circular skeleton in CSS units.
-     * @default 32px
-     */
+    /** Circle size as a CSS length. Omit for the styled default. */
     diameter?: string;
-    /**
-     * Enables the AI visual style with blue gradient colors.
-     */
+    /** Applies the AI shimmer treatment. */
     ai?: boolean;
 };
-/**
- * SkeletonCircle component for displaying circular loading placeholders.
- *
- * Features:
- * - Circular skeleton placeholder with customizable diameter
- * - Animated pulsing effect for loading indication
- * - Accessible with proper ARIA attributes
- * - Layout utility props for positioning and spacing
- * - Customizable styling through className and style props
- * - Progress bar role for screen readers
- *
- * @example
- * <Skeleton.Circle diameter="40px" />
- *
- * <Skeleton.Circle
- *   diameter="60px"
- *   className="custom-skeleton"
- *   aria-label="Loading avatar"
- * />
- */
+/** Circular loading placeholder. */
 export declare const SkeletonCircle: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "children"> & Omit<LayoutUtilProps, "flex" | "flexGrow" | "flexShrink" | "flexBasis"> & {
-    /**
-     * The diameter of the circular skeleton in CSS units.
-     * @default 32px
-     */
+    /** Circle size as a CSS length. Omit for the styled default. */
     diameter?: string;
-    /**
-     * Enables the AI visual style with blue gradient colors.
-     */
+    /** Applies the AI shimmer treatment. */
     ai?: boolean;
 } & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/components/Skeleton/SkeletonPill.d.ts

@@ -1,49 +1,15 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { LayoutUtilProps } from '../../types';
-/**
- * Props for the SkeletonPill component
- * @extends Omit<ComponentPropsWithoutRef<"div">, "children">
- * @extends Omit<LayoutUtilProps, "flex" | "flexBasis" | "flexGrow" | "flexShrink">
- */
 export type SkeletonPillProps = Omit<ComponentPropsWithoutRef<"div">, "children"> & Omit<LayoutUtilProps, "flex" | "flexBasis" | "flexGrow" | "flexShrink"> & {
-    /**
-     * The width of the pill skeleton in CSS units.
-     */
+    /** CSS length for the pill width. */
     width?: string;
-    /**
-     * Enables the AI visual style with blue gradient colors.
-     */
+    /** Applies the AI shimmer treatment. */
     ai?: boolean;
 };
-/**
- * SkeletonPill component for displaying pill-shaped loading placeholders.
- *
- * Features:
- * - Pill-shaped skeleton placeholder with customizable width
- * - Animated pulsing effect for loading indication
- * - Accessible with proper ARIA attributes
- * - Layout utility props for positioning and spacing
- * - Customizable styling through className and style props
- * - Progress bar role for screen readers
- * - Large border radius for pill appearance
- * - Fixed height for consistent styling
- *
- * @example
- * <Skeleton.Pill width="120px" />
- *
- * <Skeleton.Pill
- *   width="8rem"
- *   className="custom-skeleton"
- *   aria-label="Loading tag"
- * />
- */
+/** Capsule-shaped loading placeholder. */
 export declare const SkeletonPill: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "children"> & Omit<LayoutUtilProps, "flex" | "flexGrow" | "flexShrink" | "flexBasis"> & {
-    /**
-     * The width of the pill skeleton in CSS units.
-     */
+    /** CSS length for the pill width. */
     width?: string;
-    /**
-     * Enables the AI visual style with blue gradient colors.
-     */
+    /** Applies the AI shimmer treatment. */
     ai?: boolean;
 } & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/components/Skeleton/SkeletonRectangle.d.ts

@@ -1,50 +1,15 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { LayoutUtilProps } from '../../types';
-/**
- * Props for the SkeletonRectangle component
- * @extends Omit<ComponentPropsWithoutRef<"div">, "children">
- * @extends Omit<LayoutUtilProps, "flex" | "flexBasis" | "flexGrow" | "flexShrink">
- */
 export type SkeletonRectangleProps = Omit<ComponentPropsWithoutRef<"div">, "children"> & Omit<LayoutUtilProps, "flex" | "flexBasis" | "flexGrow" | "flexShrink"> & {
-    /**
-     * The height of the rectangular skeleton in CSS units.
-     * @default 56px
-     */
+    /** Block height as a CSS length. Omit for the styled default. */
     height?: string;
-    /**
-     * Enables the AI visual style with blue gradient colors.
-     */
+    /** Applies the AI shimmer treatment. */
     ai?: boolean;
 };
-/**
- * SkeletonRectangle component for displaying rectangular loading placeholders.
- *
- * Features:
- * - Rectangular skeleton placeholder with customizable height
- * - Animated pulsing effect for loading indication
- * - Accessible with proper ARIA attributes
- * - Layout utility props for positioning and spacing
- * - Customizable styling through className and style props
- * - Progress bar role for screen readers
- * - Medium border radius for consistent styling
- *
- * @example
- * <Skeleton.Rectangle height="100px" />
- *
- * <Skeleton.Rectangle
- *   height="2rem"
- *   className="custom-skeleton"
- *   aria-label="Loading image"
- * />
- */
+/** Rectangular loading placeholder. */
 export declare const SkeletonRectangle: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "children"> & Omit<LayoutUtilProps, "flex" | "flexGrow" | "flexShrink" | "flexBasis"> & {
-    /**
-     * The height of the rectangular skeleton in CSS units.
-     * @default 56px
-     */
+    /** Block height as a CSS length. Omit for the styled default. */
     height?: string;
-    /**
-     * Enables the AI visual style with blue gradient colors.
-     */
+    /** Applies the AI shimmer treatment. */
     ai?: boolean;
 } & import('react').RefAttributes<HTMLDivElement>>;

package/dist/src/components/Skeleton/SkeletonText.d.ts

@@ -1,57 +1,20 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { LayoutUtilProps } from '../../types';
 /**
- * Props for the SkeletonText component
- * @extends Omit<ComponentPropsWithoutRef<"div">, "children">
- * @extends Omit<LayoutUtilProps, "flex" | "flexBasis" | "flexGrow" | "flexShrink">
+ * `rows` is only valid on the body variant. Headline always renders one line.
  */
 export type SkeletonTextProps = Omit<ComponentPropsWithoutRef<"div">, "children"> & Omit<LayoutUtilProps, "flex" | "flexBasis" | "flexGrow" | "flexShrink"> & {
-    /**
-     * Enables the AI visual style with blue gradient colors.
-     */
+    /** Applies the AI shimmer treatment. */
     ai?: boolean;
 } & ({
-    /**
-     * Text variant for body text skeleton.
-     * @default body
-     */
+    /** Body copy placeholder; default when `variant` is omitted. */
     variant?: "body";
-    /**
-     * Number of text lines to display.
-     * @default 1
-     */
+    /** Number of body lines. Defaults to `1`. */
     rows?: number;
 } | {
-    /**
-     * Text variant for headline text skeleton.
-     */
+    /** Headline-sized placeholder (single line). */
     variant?: "headline";
-    /**
-     * Rows prop is not available for headline variant.
-     */
     rows?: never;
 });
-/**
- * SkeletonText component for displaying text loading placeholders.
- *
- * Features:
- * - Text skeleton placeholder with body and headline variants
- * - Configurable number of rows for body variant
- * - Animated pulsing effect for loading indication
- * - Accessible with proper ARIA attributes
- * - Layout utility props for positioning and spacing
- * - Customizable styling through className and style props
- * - Progress bar role for screen readers
- * - Different line heights for body vs headline variants
- * - Last line shorter for body variant to simulate natural text
- *
- * @example
- * <Skeleton.Text variant="body" rows={3} />
- *
- * <Skeleton.Text
- *   variant="headline"
- *   className="custom-skeleton"
- *   aria-label="Loading title"
- * />
- */
+/** Text-shaped loading placeholder. */
 export declare const SkeletonText: import('react').ForwardRefExoticComponent<SkeletonTextProps & import('react').RefAttributes<HTMLDivElement>>;

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

@@ -2,6 +2,11 @@ export * from './SkeletonCircle';
 export * from './SkeletonPill';
 export * from './SkeletonRectangle';
 export * from './SkeletonText';
+/**
+ * Compound loading placeholders. Use {@link SkeletonCircle}, {@link SkeletonPill},
+ * {@link SkeletonRectangle}, and {@link SkeletonText} as `Skeleton.Circle`,
+ * `Skeleton.Pill`, `Skeleton.Rectangle`, and `Skeleton.Text`.
+ */
 export declare const Skeleton: {
     Circle: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref">, "children"> & Omit<import('..').LayoutUtilProps, "flex" | "flexGrow" | "flexShrink" | "flexBasis"> & {
         diameter?: string;

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

@@ -1,45 +1,16 @@
 import { ComponentPropsWithoutRef } from 'react';
-/**
- * Props for the Spinner component
- * @extends ComponentPropsWithoutRef<"span">
- */
 export type SpinnerProps = ComponentPropsWithoutRef<"span"> & {
-    /**
-     * When true, the spinner inherits the current text color instead of using the default primary background color
-     */
+    /** Uses the surrounding text color instead of the default spinner color. */
     inherit?: boolean;
-    /**
-     * The size of the spinner.
-     * @default medium
-     */
+    /** Indicator scale. Defaults to `medium`. */
     size?: "small" | "medium" | "large";
 };
 /**
- * A loading spinner component that displays an animated circular indicator.
- *
- * The Spinner component provides a visual indication that content is loading or processing.
- * It renders as a circular animation that continuously rotates to show activity.
- *
- * Features:
- * - Animated circular loading indicator
- * - Configurable color inheritance
- * - Accessible with proper ARIA attributes
- * - Customizable styling through className and style props
- * - Forwarded ref support
- *
- * @example
- * <Spinner />
- *
- * <Spinner inherit />
+ * Animated circular status indicator for loading or processing activity.
  */
 export declare const Spinner: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, "ref"> & {
-    /**
-     * When true, the spinner inherits the current text color instead of using the default primary background color
-     */
+    /** Uses the surrounding text color instead of the default spinner color. */
     inherit?: boolean;
-    /**
-     * The size of the spinner.
-     * @default medium
-     */
+    /** Indicator scale. Defaults to `medium`. */
     size?: "small" | "medium" | "large";
 } & import('react').RefAttributes<HTMLSpanElement>>;

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

@@ -1,17 +1,6 @@
 import { ComponentPropsWithoutRef } from 'react';
 /**
- * Screen reader only component for providing accessible content that is visually hidden.
- *
- * Features:
- * - Visually hidden content that remains accessible to screen readers
- * - Preserves all standard span element functionality and attributes
- * - Maintains proper semantic structure
- * - Essential for accessibility compliance
- *
- * @example
- * <div>
- *   <span aria-hidden="true">$100</span>
- *   <SrOnly>One hundred dollars</SrOnly>
- * </div>
+ * Visually hides span content while keeping it available to assistive
+ * technologies.
  */
 export declare const SrOnly: (props: ComponentPropsWithoutRef<"span">) => import("react/jsx-runtime").JSX.Element;