@servicetitan/anvil2 3.14.0 → 3.15.0

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

@@ -2,53 +2,26 @@ import { ComponentPropsWithoutRef, ReactElement } from 'react';
 import { LayoutUtilProps } from '../../types';
 import { BreadcrumbsLinkProps } from './BreadcrumbsLink';
 /**
- * Props for the Breadcrumbs component
  * @extends ComponentPropsWithoutRef<"nav">
  * @extends LayoutUtilProps
  */
 export type BreadcrumbsProps = ComponentPropsWithoutRef<"nav"> & LayoutUtilProps & {
     /**
-     * Breadcrumb links to display. The last child will be rendered as non-clickable text.
+     * Ordered trail whose final child renders as current-page text instead of
+     * a link.
      */
     children: ReactElement<BreadcrumbsLinkProps> | ReactElement<BreadcrumbsLinkProps>[];
 };
 /**
- * Breadcrumbs component for displaying navigation hierarchy.
- *
- * Features:
- * - Displays a series of navigation links with chevron separators
- * - Automatically renders the last item as non-clickable text
- * - Includes proper ARIA labeling for accessibility
- * - Supports layout utilities for positioning and spacing
- * - Uses chevron icons as visual separators between links
- * - Responsive design with flexbox layout
- *
- * @example
- * <Breadcrumbs>
- *   <Breadcrumbs.Link href="/home">Home</Breadcrumbs.Link>
- *   <Breadcrumbs.Link href="/products">Products</Breadcrumbs.Link>
- *   <Breadcrumbs.Link href="/electronics">Electronics</Breadcrumbs.Link>
- * </Breadcrumbs>
+ * Navigation trail that renders its final item as the current page.
  */
 export declare const Breadcrumbs: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').HTMLAttributes<HTMLElement>, HTMLElement>, "ref"> & LayoutUtilProps & {
     /**
-     * Breadcrumb links to display. The last child will be rendered as non-clickable text.
+     * Ordered trail whose final child renders as current-page text instead of
+     * a link.
      */
     children: ReactElement<BreadcrumbsLinkProps> | ReactElement<BreadcrumbsLinkProps>[];
 } & import('react').RefAttributes<HTMLElement>> & {
-    /**
-     * BreadcrumbsLink component for individual breadcrumb navigation items.
-     *
-     * Features:
-     * - Renders as a clickable link with secondary appearance
-     * - Supports all standard anchor element props
-     * - Includes layout utilities for positioning and spacing
-     * - Uses small text size for consistent styling
-     * - Fully accessible with proper focus management
-     * - Automatically applies secondary link styling
-     *
-     * @example
-     * <Breadcrumbs.Link href="/dashboard">Dashboard</Breadcrumbs.Link>
-     */
+    /** Link for a navigable step before the current page. */
     Link: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, "ref"> & LayoutUtilProps & import('react').RefAttributes<HTMLAnchorElement>>;
 };

package/dist/src/components/Breadcrumbs/BreadcrumbsLink.d.ts

@@ -1,23 +1,9 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { LayoutUtilProps } from '../../types';
 /**
- * Props for the BreadcrumbsLink component
  * @extends ComponentPropsWithoutRef<"a">
  * @extends LayoutUtilProps
  */
 export type BreadcrumbsLinkProps = ComponentPropsWithoutRef<"a"> & LayoutUtilProps;
-/**
- * BreadcrumbsLink component for individual breadcrumb navigation items.
- *
- * Features:
- * - Renders as a clickable link with secondary appearance
- * - Supports all standard anchor element props
- * - Includes layout utilities for positioning and spacing
- * - Uses small text size for consistent styling
- * - Fully accessible with proper focus management
- * - Automatically applies secondary link styling
- *
- * @example
- * <BreadcrumbsLink href="/dashboard">Dashboard</BreadcrumbsLink>
- */
+/** Link for a navigable step before the current page. */
 export declare const BreadcrumbsLink: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, "ref"> & LayoutUtilProps & import('react').RefAttributes<HTMLAnchorElement>>;

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

@@ -4,40 +4,36 @@ import { IconProps } from '../Icon';
 import { AiIconName } from './internal';
 export type { AiIconName };
 /**
- * Props for the Button component
+ * Labeled buttons accept leading or trailing icons; icon-only buttons accept a
+ * single icon and require an accessible name.
+ *
  * @extends Omit<ComponentPropsWithoutRef<"button">, "children">
  * @extends LayoutUtilProps
  * @extends DataTrackingId
  */
 export type ButtonProps = Omit<ComponentPropsWithoutRef<"button">, "children"> & LayoutUtilProps & DataTrackingId & {
     /**
-     * When `true` or an icon name, shows an AI indicator. With button text, any leading
-     * `icon` (plain Svg or `icon.before`) is not shown—the AI icon is used instead.
-     * On an icon-only button, `icon` is not shown—the AI icon is used instead.
-     * Icon-only usage must include an accessible name (for example `aria-label`).
-     * In development, a console warning is logged when `icon` is overridden.
+     * Renders an AI indicator as leading or icon-only content. `true` and
+     * `"mark"` use the animated mark; other names use static icons. Trailing
+     * icons remain visible.
      */
     aiMark?: boolean | AiIconName;
-    /**
-     * The visual variant of the button.
-     * @default secondary
-     */
+    /** Visual emphasis. Defaults to `secondary`. */
     appearance?: ButtonAppearance;
-    /**
-     * The size of the button.
-     * @default medium
-     */
+    /** Controls the button and icon dimensions. Defaults to `medium`. */
     size?: Extract<Size, "xsmall" | "small" | "medium" | "large">;
-    /**
-     * The loading state of the button.
-     * If true, it will show infinite state of the loading.
-     * @default false
-     */
+    /** Replaces the leading content with a spinner and disables the button. */
     loading?: boolean;
 } & ({
+    /** Visible button content. Omit it for an icon-only button. */
     children?: ComponentPropsWithoutRef<"button">["children"];
     /**
-     * The icons of the button.
+     * A bare icon renders before the content; use the object form to choose its
+     * position.
+     *
+     * @example
+     * icon={SaveIcon}
+     * icon={{ after: ArrowIcon }}
      */
     icon?: IconProps["svg"] | {
         after: IconProps["svg"];
@@ -45,30 +41,12 @@ export type ButtonProps = Omit<ComponentPropsWithoutRef<"button">, "children"> &
         before: IconProps["svg"];
     };
 } | {
+    /** Use an accessible name instead of label children. */
     children?: never;
-    /**
-     * The icon of the icon only button.
-     */
+    /** The icon-only button's visible content. Pair it with an accessible name. */
     icon?: IconProps["svg"];
 });
 /**
- * Button component for triggering actions and user interactions.
- *
- * Features:
- * - Multiple visual appearances (primary, secondary, ghost, danger variants)
- * - Four size options (xsmall, small, medium, large)
- * - Loading state with spinner animation
- * - Icon support (before, after, or icon-only)
- * - Optional AI mark / named AI icons via `aiMark`
- * - Full accessibility support with ARIA attributes
- * - Supports layout utilities for positioning and spacing
- * - Automatic disabled state when loading
- * - Flexible content with text and/or icons
- * - Automatic tracking ID generation for analytics
- *
- * @example
- * <Button appearance="primary" size="medium" onClick={() => console.log('clicked')}>
- *   Click Me
- * </Button>
+ * Action control for labeled or icon-only content.
  */
 export declare const Button: import('react').ForwardRefExoticComponent<ButtonProps & import('react').RefAttributes<HTMLButtonElement>>;

package/dist/src/components/Button/internal/buttonAiMarkUtils.d.ts

@@ -1,14 +1,11 @@
 import { IconProps } from '../../Icon';
 /**
- * AI icon names for `Button` `aiMark`. `"mark"` (or boolean `true`) uses the animated AI mark;
- * other values use static AI icons.
+ * Named AI indicators accepted by `Button`. `"mark"` uses the animated mark;
+ * the remaining names render static icons.
  */
 export type AiIconName = "chat" | "edit" | "form" | "mark" | "mic" | "search";
 export declare const AI_ICON_MAP: Record<Exclude<AiIconName, "mark">, IconProps["svg"]>;
 export type ButtonAiMarkSize = "xsmall" | "small" | "medium" | "large";
-/**
- * Icon-only AI icon container size (px). Medium/large match custom icon-only parity.
- */
 export declare const ICON_ONLY_AI_SIZE_PX: Record<ButtonAiMarkSize, number>;
 export declare function iconHasLeadingSlot(icon: IconProps["svg"] | {
     before: IconProps["svg"];

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

@@ -1,41 +1,18 @@
 import { ComponentPropsWithoutRef } from 'react';
 import { DataTrackingId, LayoutUtilProps } from '../../types';
 /**
- * Props for the ButtonCompound component
  * @extends LayoutUtilProps
  * @extends ComponentPropsWithoutRef<"button">
  */
 export type ButtonCompoundProps = LayoutUtilProps & ComponentPropsWithoutRef<"button"> & {
-    /**
-     * The shape of the compound button.
-     * @default rounded
-     */
+    /** Controls the container silhouette. Defaults to `rounded`. */
     shape?: "pill" | "circular" | "rounded";
-} /**
- * Data tracking id
- */ & DataTrackingId;
+} & DataTrackingId;
 /**
- * ButtonCompound component for creating compound button layouts.
- *
- * Features:
- * - Three shape options (pill, circular, rounded)
- * - Transparent background for compound layouts
- * - Supports layout utilities for positioning and spacing
- * - Full accessibility support with proper ARIA attributes
- * - Flexible content support
- * - Consistent styling with other button components
- * - Hover and active state management
- * - Automatic tracking ID generation for analytics
- *
- * @example
- * <ButtonCompound shape="circular">
- *   <Avatar name="John Doe" />
- * </ButtonCompound>
+ * Button-shaped container for compound content such as an avatar or custom
+ * control.
  */
 export declare const ButtonCompound: import('react').ForwardRefExoticComponent<LayoutUtilProps & Omit<import('react').DetailedHTMLProps<import('react').ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref"> & {
-    /**
-     * The shape of the compound button.
-     * @default rounded
-     */
+    /** Controls the container silhouette. Defaults to `rounded`. */
     shape?: "pill" | "circular" | "rounded";
 } & DataTrackingId & import('react').RefAttributes<HTMLButtonElement>>;

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

@@ -2,92 +2,56 @@ import { ComponentPropsWithoutRef } from 'react';
 import { DataTrackingId, ButtonAppearance, LayoutUtilProps, Size } from '../../types';
 import { IconProps } from '../Icon';
 /**
- * Props for the ButtonLink component
  * @extends LayoutUtilProps
  * @extends ComponentPropsWithoutRef<"a">
  */
 export type ButtonLinkProps = LayoutUtilProps & ComponentPropsWithoutRef<"a"> & {
-    /**
-     * The disabled state of the button link.
-     * @default false
-     */
+    /** Prevents navigation and removes the link from the tab order. */
     disabled?: boolean;
-    /**
-     * The visual variant of the button link.
-     * @default secondary
-     */
+    /** Visual emphasis. Defaults to `secondary`. */
     appearance?: ButtonAppearance;
-    /**
-     * The size of the button link.
-     * @default medium
-     */
+    /** Controls the link and icon dimensions. Defaults to `medium`. */
     size?: Extract<Size, "xsmall" | "small" | "medium" | "large">;
     /**
-     * The icons of the button link.
+     * A bare icon renders before the content; use the object form to choose its
+     * position.
+     *
+     * @example
+     * icon={ArrowIcon}
+     * icon={{ after: ArrowIcon }}
      */
     icon?: IconProps["svg"] | {
         after: IconProps["svg"];
     } | {
         before: IconProps["svg"];
     };
-    /**
-     * The loading state of the button link.
-     * If true, it will show infinite state of the loading.
-     * @default false
-     */
+    /** Shows a leading spinner and prevents navigation. */
     loading?: boolean;
-} /**
- * Data tracking id
- */ & DataTrackingId;
+} & DataTrackingId;
 /**
- * ButtonLink component for creating clickable links that look like buttons.
- *
- * Features:
- * - Multiple visual appearances (primary, secondary, ghost, danger variants)
- * - Four size options (xsmall, small, medium, large)
- * - Loading state with spinner animation
- * - Icon support (before, after, or icon-only)
- * - Full accessibility support with proper ARIA attributes
- * - Supports layout utilities for positioning and spacing
- * - Keyboard navigation support (Space and Enter keys)
- * - Automatic disabled state when loading
- * - Prevents navigation when disabled or loading
- * - Flexible content with text and/or icons
- * - Automatic tracking ID generation for analytics
- *
- * @example
- * <ButtonLink href="/dashboard" appearance="primary" size="medium">
- *   Go to Dashboard
- * </ButtonLink>
+ * Anchor navigation with button styling. Disabled and loading links suppress
+ * navigation and are removed from the tab order.
  */
 export declare const ButtonLink: import('react').ForwardRefExoticComponent<LayoutUtilProps & Omit<import('react').DetailedHTMLProps<import('react').AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, "ref"> & {
-    /**
-     * The disabled state of the button link.
-     * @default false
-     */
+    /** Prevents navigation and removes the link from the tab order. */
     disabled?: boolean;
-    /**
-     * The visual variant of the button link.
-     * @default secondary
-     */
+    /** Visual emphasis. Defaults to `secondary`. */
     appearance?: ButtonAppearance;
-    /**
-     * The size of the button link.
-     * @default medium
-     */
+    /** Controls the link and icon dimensions. Defaults to `medium`. */
     size?: Extract<Size, "xsmall" | "small" | "medium" | "large">;
     /**
-     * The icons of the button link.
+     * A bare icon renders before the content; use the object form to choose its
+     * position.
+     *
+     * @example
+     * icon={ArrowIcon}
+     * icon={{ after: ArrowIcon }}
      */
     icon?: IconProps["svg"] | {
         after: IconProps["svg"];
     } | {
         before: IconProps["svg"];
     };
-    /**
-     * The loading state of the button link.
-     * If true, it will show infinite state of the loading.
-     * @default false
-     */
+    /** Shows a leading spinner and prevents navigation. */
     loading?: boolean;
 } & DataTrackingId & import('react').RefAttributes<HTMLAnchorElement>>;

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

@@ -1,74 +1,37 @@
 import { KeyboardEvent, MouseEvent } from 'react';
 import { DataTrackingId } from '../../types';
 import { ButtonProps } from '../Button/Button';
+/** State passed to {@link ButtonToggleProps.onChange}. */
 export type ButtonToggleState = {
+    /** The next pressed state. */
     pressed: boolean;
+    /** The button value supplied by the consumer. */
     value?: string;
 };
 /**
- * Props for the ButtonToggle component
  * @extends Omit<ButtonProps, "appearance" | "loading">
  */
 export type ButtonToggleProps = Omit<ButtonProps, "appearance" | "loading"> & {
-    /**
-     * The default pressed(selected) state of the toggle button.
-     * @default false
-     */
+    /** Initial pressed state when `checked` is not provided. Defaults to `false`. */
     defaultChecked?: boolean;
-    /**
-     * The controlled pressed(selected) state of the toggle button.
-     */
+    /** Controls the pressed state. Controlled clicks do not call `onChange`. */
     checked?: boolean;
-    /**
-     * The value of the toggle button.
-     */
+    /** Included in the state passed to `onChange`. */
     value?: string;
-    /**
-     * Callback for when pressed(selected) changes.
-     */
+    /** Called with the next state after an uncontrolled click. */
     onChange?: (e: MouseEvent<HTMLButtonElement> | KeyboardEvent<HTMLButtonElement>, state: ButtonToggleState) => void;
-} /**
- * Data tracking id
- */ & DataTrackingId;
+} & DataTrackingId;
 /**
- * ButtonToggle component for creating toggleable button states.
- *
- * Features:
- * - Supports both controlled and uncontrolled state management
- * - Toggle state with pressed/selected visual feedback
- * - Full accessibility support with aria-pressed attribute
- * - Callback support for state changes
- * - Supports layout utilities for positioning and spacing
- * - Inherits all button features except appearance and loading
- * - Flexible content with text and/or icons
- * - Keyboard interaction support
- * - Value association for form-like behavior
- * - Automatic tracking ID generation for analytics
- *
- * @example
- * <ButtonToggle
- *   defaultChecked={false}
- *   onChange={(e, state) => console.log('Toggle state:', state.pressed)}
- * >
- *   Toggle Me
- * </ButtonToggle>
+ * Button that exposes its pressed state through `aria-pressed`. Use
+ * `defaultChecked` for uncontrolled state or `checked` for controlled state.
  */
 export declare const ButtonToggle: import('react').ForwardRefExoticComponent<Omit<ButtonProps, "appearance" | "loading"> & {
-    /**
-     * The default pressed(selected) state of the toggle button.
-     * @default false
-     */
+    /** Initial pressed state when `checked` is not provided. Defaults to `false`. */
     defaultChecked?: boolean;
-    /**
-     * The controlled pressed(selected) state of the toggle button.
-     */
+    /** Controls the pressed state. Controlled clicks do not call `onChange`. */
     checked?: boolean;
-    /**
-     * The value of the toggle button.
-     */
+    /** Included in the state passed to `onChange`. */
     value?: string;
-    /**
-     * Callback for when pressed(selected) changes.
-     */
+    /** Called with the next state after an uncontrolled click. */
     onChange?: (e: MouseEvent<HTMLButtonElement> | KeyboardEvent<HTMLButtonElement>, state: ButtonToggleState) => void;
 } & DataTrackingId & import('react').RefAttributes<HTMLButtonElement>>;