@servicetitan/anvil2 3.14.1 → 3.15.0

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

@@ -3,103 +3,51 @@ import { FieldLabelProps } from '../FieldLabel';
 import { HelperProps } from '../../internal/components';
 import { LayoutUtilProps } from '../../types';
 /**
- * Props for the ProgressBar component
- * @extends Omit<ComponentPropsWithoutRef<"progress">, "value">
- * @extends LayoutUtilProps
+ * Named via visible `label`, or `aria-label` / `aria-labelledby` when there is
+ * no visible label. Determinate requires `value`; omit it when `indeterminate`.
  */
 export type ProgressBarProps = Omit<ComponentPropsWithoutRef<"progress">, "value"> & LayoutUtilProps & {
     /**
-     * Error state for the field. Pass `true` to indicate error styling without a message.
-     * Pass a string, string[], or ReactElement (deprecated) for error messages.
-     * @default false
+     * `true` is error styling with no message. A string or string[] is shown
+     * under the bar. A React element is deprecated.
      */
     error?: boolean | string | ReactElement | string[];
     /**
-     * @deprecated No longer used. Error messages always use `aria-live="assertive"`.
+     * @deprecated Unused. Error messages always use `aria-live="assertive"`.
      */
     errorAriaLive?: HelperProps["errorAriaLive"];
-    /**
-     * Warning message(s) to display. Supports a single string or an array of strings.
-     */
+    /** Warning copy under the bar. A string[] renders as multiple messages. */
     warning?: string | string[];
-    /**
-     * Description text to display below the progress bar
-     */
+    /** Supporting copy under the bar, below any error or warning. */
     description?: HelperProps["description"];
 } & ({
-    /**
-     * Label text for the progress bar
-     */
+    /** Visible {@link FieldLabel} content. Enables the success/error icons. */
     label: FieldLabelProps["children"];
-    /**
-     * Additional props for the label component
-     */
+    /** Forwarded to {@link FieldLabel} except `children`, `id`, and `required`. */
     labelProps?: Omit<FieldLabelProps, "children" | "id" | "required">;
 } | {
     label?: never;
     labelProps?: never;
-    /**
-     * Accessible label for the progress bar (alternative to label)
-     */
+    /** Accessible name when there is no visible `label`. */
     ["aria-label"]: Exclude<AriaAttributes["aria-label"], undefined>;
 } | {
     label?: never;
     labelProps?: never;
-    /**
-     * ID of element that labels the progress bar (alternative to label)
-     */
+    /** ID of the element that names the bar when there is no visible `label`. */
     ["aria-labelledby"]: Exclude<AriaAttributes["aria-labelledby"], undefined>;
 }) & ({
-    /**
-     * Current progress value (0-100 or 0-max)
-     */
+    /** Current progress, from 0 to `max`. Required unless `indeterminate`. */
     value: `${number}` | number;
-    /**
-     * Whether the progress bar is in indeterminate state
-     * @default false
-     */
+    /** Must stay unset or `false` when `value` is provided. */
     indeterminate?: false;
 } | {
     value?: never;
-    /**
-     * Whether the progress bar is in indeterminate state
-     */
+    /** Animated bar with no current value. */
     indeterminate: true;
 });
 /**
- * ProgressBar component for displaying progress indicators.
- *
- * Features:
- * - Supports both determinate and indeterminate progress states
- * - Optional label with customizable label props
- * - Error state with error message display
- * - Success state with check icon when value equals max
- * - Description text support
- * - Accessibility support with proper ARIA attributes
- * - Layout utility props for positioning and spacing
- * - Flexible labeling options (label, aria-label, aria-labelledby)
- * - Error and success visual indicators
- *
- * @example
- * <ProgressBar
- *   label="Upload Progress"
- *   value={75}
- *   max={100}
- *   description="Uploading files..."
- * />
- *
- * @example
- * <ProgressBar
- *   label="Processing"
- *   indeterminate
- *   description="Please wait..."
- * />
- *
- * @example
- * <ProgressBar
- *   aria-label="Download progress"
- *   value={50}
- *   error="Download failed"
- * />
+ * Determinate or indeterminate progress indicator with optional field helper
+ * text. With a visible `label`, reaching `max` shows a success icon unless
+ * `error` is set.
  */
 export declare const ProgressBar: import('react').ForwardRefExoticComponent<ProgressBarProps & import('react').RefAttributes<HTMLDivElement>>;

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

@@ -1,92 +1,13 @@
 import { RadioProps as CoreRadioProps } from './internal/Radio';
 import { DataTrackingId } from '../../types';
 /**
- * Props for the Radio component
- * @property {boolean} [checked] - Controlled state
- * @property {boolean} [defaultChecked] - Uncontrolled state
- * @property {Function} [onChange] - Callback when radio is changed
- * @property {ReactElement | string} [label] - Label for Radio
- * @property {boolean} [error] - Error state for the radio
- * @property {object} [icons] - Icon overrides for checked and unchecked states
- * @property {string} [description] - Description text to display below the radio
- * @property {string} [aria-label] - Accessible label for the radio
- * @property {string} [aria-labelledby] - ID of element that labels the radio
- * @property {string} [name] - Name attribute for the radio
- * @property {string} [data-tracking-id] - Custom tracking ID for analytics
+ * @extends Omit<CoreRadioProps, "hideRadio">
  * @extends DataTrackingId
  */
 export type RadioProps = Omit<CoreRadioProps, "hideRadio"> & DataTrackingId;
-/**
- * Radio component: a radio button group for choosing exactly one option from a mutually exclusive set of choices.
- *
- * Features:
- * - Supports both controlled and uncontrolled modes
- * - Customizable icons for checked and unchecked states
- * - Error state with visual indicators
- * - Description text support
- * - Accessibility support with proper ARIA attributes
- * - Layout utility props for positioning and spacing
- * - Flexible labeling options
- * - Group support via Radio.Group
- * - Automatic tracking ID generation for analytics
- *
- * @example
- * <Radio
- *   label="Option 1"
- *   value="option1"
- *   checked={selectedValue === "option1"}
- *   onChange={(e, state) => setSelectedValue(state?.value)}
- * />
- *
- * @example
- * <Radio
- *   label="Custom styled option"
- *   value="custom"
- *   icons={{
- *     checked: CustomCheckedIcon,
- *     unchecked: CustomUncheckedIcon
- *   }}
- *   description="This option has custom styling"
- * />
- *
- * @example
- * <Radio.Group legend="Choose your preference" required>
- *   <Radio label="Option A" value="a" />
- *   <Radio label="Option B" value="b" />
- *   <Radio label="Option C" value="c" />
- * </Radio.Group>
- */
+/** Radio input for selecting one option within a named set. */
 export declare const Radio: import('react').ForwardRefExoticComponent<Omit<CoreRadioProps, "hideRadio"> & DataTrackingId & import('react').RefAttributes<HTMLInputElement>> & {
-    /**
-     * RadioGroup component for grouping related radio options.
-     *
-     * Features:
-     * - Groups multiple radio options together
-     * - Legend support for group labeling
-     * - Required field indication
-     * - Accessibility support with proper fieldset semantics
-     * - Layout utility props for positioning and spacing
-     * - Focus and blur event handling
-     * - More info support for additional context
-     * - Automatic alignment based on flex direction
-     *
-     * @example
-     * <RadioGroup legend="Choose your preference" required>
-     *   <Radio label="Option A" value="a" />
-     *   <Radio label="Option B" value="b" />
-     *   <Radio label="Option C" value="c" />
-     * </RadioGroup>
-     *
-     * @example
-     * <RadioGroup
-     *   legend="Horizontal layout"
-     *   flexDirection="row"
-     *   gap="4"
-     * >
-     *   <Radio label="Yes" value="yes" />
-     *   <Radio label="No" value="no" />
-     * </RadioGroup>
-     */
+    /** Groups related radios under a shared legend and error state. */
     Group: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').FieldsetHTMLAttributes<HTMLFieldSetElement>, HTMLFieldSetElement>, "ref"> & import('..').LayoutUtilProps & Omit<import('../../internal').FieldLabelProps, "labelProps"> & {
         required?: boolean;
         legend: string | import('react').ReactElement;

package/dist/src/components/Radio/RadioGroup.d.ts

@@ -4,122 +4,70 @@ import { FieldLabelProps as FieldLabelElementProps } from '../FieldLabel';
 import { FieldLabelProps as InternalFieldLabelProps } from '../../internal/types';
 import { HelperProps } from '../../internal/components';
 /**
- * Props for the RadioGroup component
  * @extends ComponentPropsWithoutRef<"fieldset">
  * @extends LayoutUtilProps
  * @extends Omit<InternalFieldLabelProps, "labelProps">
  */
 export type RadioGroupProps = ComponentPropsWithoutRef<"fieldset"> & LayoutUtilProps & Omit<InternalFieldLabelProps, "labelProps"> & {
-    /**
-     * Required flag for label
-     * @remarks This does not enforce error when nothing is selected
-     */
+    /** Shows the required indicator but does not validate selection. */
     required?: boolean;
     /**
      * Legend for the fieldset.
-     * Passing `ReactNode` is deprecated — use a plain string with inline markdown instead.
+     * Passing a React element is deprecated; use a string with inline markdown.
      */
     legend: string | ReactElement;
-    /**
-     * Additional props for the legend `FieldLabel` (for example `aiMark`, `className`).
-     */
+    /** Props for the visible {@link FieldLabel}, except its root element. */
     legendProps?: Omit<FieldLabelElementProps, "el">;
     /**
-     * When `true`, hides the visual label row. The sr-only `<legend>` always remains for AT.
-     * @default false
+     * Hides the visual label row while preserving the fieldset legend for
+     * assistive technology. Defaults to `false`.
      */
     hideLabel?: boolean;
     /**
-     * Error state for the field. Pass `true` to indicate error styling without a message.
-     * Pass a string, string[], or ReactElement (deprecated) for error messages.
+     * Error styling for every child. A message value also renders below the
+     * group; React elements are deprecated.
      */
     error?: boolean | string | ReactElement | string[];
     /**
      * @deprecated No longer used. Error messages always use `aria-live="assertive"`.
      */
     errorAriaLive?: HelperProps["errorAriaLive"];
-    /**
-     * Warning message(s) to display. Supports a single string or an array of strings.
-     */
+    /** Warning copy rendered below the group. */
     warning?: string | string[];
-    /**
-     * Description text to display below the field.
-     */
+    /** Secondary copy rendered below the group. */
     description?: HelperProps["description"];
-    /**
-     * Hint text to display below the field.
-     */
+    /** Always-visible hint rendered below the group. */
     hint?: HelperProps["hint"];
 };
-/**
- * RadioGroup component for grouping related radio options.
- *
- * Features:
- * - Groups multiple radio options together
- * - Legend support for group labeling
- * - Required field indication
- * - Accessibility support with proper fieldset semantics
- * - Layout utility props for positioning and spacing
- * - Focus and blur event handling
- * - More info support for additional context
- * - Automatic alignment based on flex direction
- *
- * @example
- * <RadioGroup legend="Choose your preference" required>
- *   <Radio label="Option A" value="a" />
- *   <Radio label="Option B" value="b" />
- *   <Radio label="Option C" value="c" />
- * </RadioGroup>
- *
- * @example
- * <RadioGroup
- *   legend="Horizontal layout"
- *   flexDirection="row"
- *   gap="4"
- * >
- *   <Radio label="Yes" value="yes" />
- *   <Radio label="No" value="no" />
- * </RadioGroup>
- */
+/** Fieldset that labels related radio inputs and shares its error state. */
 export declare const RadioGroup: import('react').ForwardRefExoticComponent<Omit<import('react').DetailedHTMLProps<import('react').FieldsetHTMLAttributes<HTMLFieldSetElement>, HTMLFieldSetElement>, "ref"> & LayoutUtilProps & Omit<InternalFieldLabelProps, "labelProps"> & {
-    /**
-     * Required flag for label
-     * @remarks This does not enforce error when nothing is selected
-     */
+    /** Shows the required indicator but does not validate selection. */
     required?: boolean;
     /**
      * Legend for the fieldset.
-     * Passing `ReactNode` is deprecated — use a plain string with inline markdown instead.
+     * Passing a React element is deprecated; use a string with inline markdown.
      */
     legend: string | ReactElement;
-    /**
-     * Additional props for the legend `FieldLabel` (for example `aiMark`, `className`).
-     */
+    /** Props for the visible {@link FieldLabel}, except its root element. */
     legendProps?: Omit<FieldLabelElementProps, "el">;
     /**
-     * When `true`, hides the visual label row. The sr-only `<legend>` always remains for AT.
-     * @default false
+     * Hides the visual label row while preserving the fieldset legend for
+     * assistive technology. Defaults to `false`.
      */
     hideLabel?: boolean;
     /**
-     * Error state for the field. Pass `true` to indicate error styling without a message.
-     * Pass a string, string[], or ReactElement (deprecated) for error messages.
+     * Error styling for every child. A message value also renders below the
+     * group; React elements are deprecated.
      */
     error?: boolean | string | ReactElement | string[];
     /**
      * @deprecated No longer used. Error messages always use `aria-live="assertive"`.
      */
     errorAriaLive?: HelperProps["errorAriaLive"];
-    /**
-     * Warning message(s) to display. Supports a single string or an array of strings.
-     */
+    /** Warning copy rendered below the group. */
     warning?: string | string[];
-    /**
-     * Description text to display below the field.
-     */
+    /** Secondary copy rendered below the group. */
     description?: HelperProps["description"];
-    /**
-     * Hint text to display below the field.
-     */
+    /** Always-visible hint rendered below the group. */
     hint?: HelperProps["hint"];
 } & import('react').RefAttributes<HTMLFieldSetElement>>;

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

@@ -3,151 +3,56 @@ import { LayoutUtilProps, Svg } from '../../../types';
 import { HelperProps } from '../../../internal/components';
 import { RadioState } from '../types';
 /**
- * Props for the Radio component
  * @extends Omit<ComponentPropsWithoutRef<"input">, "onChange">
  * @extends LayoutUtilProps
  */
 export type RadioProps = Omit<ComponentPropsWithoutRef<"input">, "onChange"> & LayoutUtilProps & {
-    /**
-     * Controlled state
-     * @default false
-     */
+    /** Controlled selected state. Omit to use `defaultChecked`. */
     checked?: boolean;
-    /**
-     * Uncontrolled state
-     * @default false
-     */
+    /** Initial selected state when uncontrolled. Defaults to `false`. */
     defaultChecked?: boolean;
-    /**
-     * Callback when radio is changed
-     */
+    /** Called with the input event and resulting selected state. */
     onChange?: (e: ChangeEvent<HTMLInputElement>, state?: RadioState) => void;
-    /**
-     * Label for Radio
-     * @remarks This should either be a string or have text content inside for accessibility
-     */
+    /** Visible label content. Use `aria-label` when omitting it. */
     label?: ReactElement | string;
-    /**
-     * Error state for the radio
-     * @default false
-     */
+    /** Applies error styling; inherited group errors also apply. */
     error?: boolean;
-    /**
-     * Icon overrides for checked and unchecked states
-     */
+    /** Replaces the icons for individual radio states. */
     icons?: {
-        /**
-         * Icon to display when radio is checked
-         */
+        /** Replaces the selected-state icon. */
         checked?: Svg;
-        /**
-         * Icon to display when radio is unchecked
-         */
+        /** Replaces the unselected-state icon. */
         unchecked?: Svg;
     };
-    /**
-     * Description text to display below the radio
-     */
+    /** Secondary copy rendered below the label. */
     description?: HelperProps["description"];
-    /**
-     * When true, hides the radio for visual users
-     * @default false
-     */
+    /** Visually hides the radio while retaining its focusable input. */
     hideRadio?: boolean;
-    /**
-     * Additional className applied to the label wrapper span
-     */
+    /** Class names for the span wrapping the visible label, not the root. */
     labelWrapperClassName?: string;
 };
-/**
- * Radio component for single selection from a group of options.
- *
- * Features:
- * - Supports both controlled and uncontrolled modes
- * - Customizable icons for checked and unchecked states
- * - Error state with visual indicators
- * - Description text support
- * - Accessibility support with proper ARIA attributes
- * - Layout utility props for positioning and spacing
- * - Optional radio hiding for visual users
- * - Flexible labeling options
- * - Group support via Radio.Group
- *
- * @example
- * <Radio
- *   label="Option 1"
- *   value="option1"
- *   checked={selectedValue === "option1"}
- *   onChange={(e, state) => setSelectedValue(state?.value)}
- * />
- *
- * @example
- * <Radio
- *   label="Custom styled option"
- *   value="custom"
- *   icons={{
- *     checked: CustomCheckedIcon,
- *     unchecked: CustomUncheckedIcon
- *   }}
- *   description="This option has custom styling"
- * />
- *
- * @example
- * <Radio.Group legend="Choose your preference" required>
- *   <Radio label="Option A" value="a" />
- *   <Radio label="Option B" value="b" />
- *   <Radio label="Option C" value="c" />
- * </Radio.Group>
- */
 export declare const Radio: import('react').ForwardRefExoticComponent<Omit<Omit<import('react').DetailedHTMLProps<import('react').InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "ref">, "onChange"> & LayoutUtilProps & {
-    /**
-     * Controlled state
-     * @default false
-     */
+    /** Controlled selected state. Omit to use `defaultChecked`. */
     checked?: boolean;
-    /**
-     * Uncontrolled state
-     * @default false
-     */
+    /** Initial selected state when uncontrolled. Defaults to `false`. */
     defaultChecked?: boolean;
-    /**
-     * Callback when radio is changed
-     */
+    /** Called with the input event and resulting selected state. */
     onChange?: (e: ChangeEvent<HTMLInputElement>, state?: RadioState) => void;
-    /**
-     * Label for Radio
-     * @remarks This should either be a string or have text content inside for accessibility
-     */
+    /** Visible label content. Use `aria-label` when omitting it. */
     label?: ReactElement | string;
-    /**
-     * Error state for the radio
-     * @default false
-     */
+    /** Applies error styling; inherited group errors also apply. */
     error?: boolean;
-    /**
-     * Icon overrides for checked and unchecked states
-     */
+    /** Replaces the icons for individual radio states. */
     icons?: {
-        /**
-         * Icon to display when radio is checked
-         */
+        /** Replaces the selected-state icon. */
         checked?: Svg;
-        /**
-         * Icon to display when radio is unchecked
-         */
+        /** Replaces the unselected-state icon. */
         unchecked?: Svg;
     };
-    /**
-     * Description text to display below the radio
-     */
+    /** Secondary copy rendered below the label. */
     description?: HelperProps["description"];
-    /**
-     * When true, hides the radio for visual users
-     * @default false
-     */
+    /** Visually hides the radio while retaining its focusable input. */
     hideRadio?: boolean;
-    /**
-     * Additional className applied to the label wrapper span
-     */
+    /** Class names for the span wrapping the visible label, not the root. */
     labelWrapperClassName?: string;
 } & import('react').RefAttributes<HTMLInputElement>>;

package/dist/src/components/Radio/internal/RadioGroupContext.d.ts

@@ -1,19 +1,7 @@
-/**
- * Context value for RadioGroup
- * @property {boolean} hasError - Whether the group has an error state
- */
 export type RadioGroupContextValue = {
-    /**
-     * Whether the radio group has an error state
-     */
+    /** Whether the parent group has an error. */
     hasError: boolean;
 };
-/**
- * Context for sharing state between RadioGroup and child Radio components
- */
 export declare const RadioGroupContext: import('react').Context<RadioGroupContextValue | undefined>;
-/**
- * Hook to access RadioGroup context from child Radio components
- * @returns RadioGroupContextValue if inside a RadioGroup, undefined otherwise
- */
+/** Returns the nearest radio group state, if present. */
 export declare const useRadioGroupContext: () => RadioGroupContextValue | undefined;

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

@@ -1,13 +1,6 @@
-/**
- * State object returned by the onChange callback
- */
 export type RadioState = {
-    /**
-     * Whether the radio is checked
-     */
+    /** Selected state after the event. */
     checked: boolean;
-    /**
-     * The value of the radio
-     */
+    /** Value from the radio input. */
     value?: string | number | readonly string[];
 };

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

@@ -1,55 +1,17 @@
 import { SearchFieldProps as CoreSearchFieldProps } from './internal/SearchField';
 import { DistributiveOmit } from '../../types';
 /**
- * Props for the SearchField component
- * @extends Omit<ComponentPropsWithoutRef<"input">, "size" | "prefix" | "required" | "children">
- * @extends LayoutUtilProps
+ * @extends DistributiveOmit<CoreSearchFieldProps, "size">
  */
 export type SearchFieldProps = DistributiveOmit<CoreSearchFieldProps, "size"> & {
-    /**
-     * Size of the search field
-     * @default "medium"
-     */
+    /** Field height. Defaults to `medium`. */
     size?: Extract<CoreSearchFieldProps["size"], "small" | "medium" | "large">;
 };
 /**
- * SearchField component: a text input with a search or magnifying-glass affordance for filtering or searching results by typing a query.
- *
- * Features:
- * - Search icon prefix for visual clarity
- * - Clear button that appears when input has value
- * - Arrow key navigation between input and clear button (Right arrow to clear button, Left arrow back to input)
- * - Clear button activated with Enter/Space keys
- * - Focus returns to input after clearing
- * - Multiple size variants (small, medium, large)
- * - Controlled and uncontrolled modes
- * - Disabled and read-only states
- * - Accessibility support with proper ARIA attributes
- * - Layout utility props for positioning and spacing
- * - Automatic value detection for clear button visibility
- * - Search-specific input type and autocomplete settings
- * - Screen reader support with placeholder announcements
- * - Automatic tracking ID generation for analytics
- *
- * @example
- * <SearchField
- *   placeholder="Search users..."
- *   onChange={(e) => setSearchTerm(e.target.value)}
- *   onClear={() => setSearchTerm("")}
- * />
- *
- * @example
- * <SearchField
- *   size="large"
- *   value={searchValue}
- *   onChange={(e) => setSearchValue(e.target.value)}
- *   disabled={isLoading}
- * />
+ * Search input with a leading search icon and a clear control while non-empty.
+ * Pressing ArrowRight at the end of the query moves focus to the clear control.
  */
 export declare const SearchField: import('react').ForwardRefExoticComponent<Omit<CoreSearchFieldProps, "size"> & {
-    /**
-     * Size of the search field
-     * @default "medium"
-     */
+    /** Field height. Defaults to `medium`. */
     size?: Extract<CoreSearchFieldProps["size"], "small" | "medium" | "large">;
 } & import('react').RefAttributes<HTMLInputElement>>;