@servicetitan/anvil2 3.7.0 → 3.8.0

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

@@ -1,6 +1,6 @@
 export { Drawer as default, Drawer, type DrawerProps } from './Drawer';
 export { type DrawerCancelButtonProps } from './DrawerCancelButton';
 export { type DrawerFooterProps } from './DrawerFooter';
-export { type DrawerHeaderProps } from './DrawerHeader';
+export { type DrawerHeaderAction, type DrawerHeaderProps, } from './DrawerHeader';
 export { type DrawerContentProps } from './DrawerContent';
 export type { LayoutUtilProps } from '../../types';

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

@@ -12,7 +12,7 @@ export type DrillDownProps = PassThroughPropsWithRef<"div"> & {
     onClose?: () => void;
 };
 /**
- * Multi-step navigation component for Dialog, Drawer, and Page.Panel.
+ * Multi-step, hierarchical drill-down navigation component for Dialog, Drawer, and Page.Panel — lets users drill down by selecting a category to go deeper into nested subcategories or screens, and navigate back up.
  *
  * Manages sequential navigation between related content screens within overlay components.
  * Each DrillDown represents a single screen identified by its index. Navigate between screens

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

@@ -33,7 +33,7 @@ export type GridProps = ComponentPropsWithoutRef<"div"> & {
     xxl?: GridSpecificProps;
 };
 /**
- * Grid component for creating CSS Grid layouts with responsive design.
+ * Grid component for creating responsive multi-column CSS Grid layouts that arrange content or tiles into evenly spaced columns and rows which reflow across breakpoints.
  *
  * Features:
  * - CSS Grid layout with full control over grid properties

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

@@ -104,7 +104,7 @@ declare namespace ListboxInner {
     var displayName: string;
 }
 /**
- * Listbox component for selecting one or more items from a list
+ * Listbox component for selecting one or more items from a keyboard-navigable, scrollable list of options
  *
  * Features:
  * - Supports single and multiple selection modes

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

@@ -14,7 +14,7 @@ export type MenuProps = Omit<ButtonProps, "icon"> & MenuCommonProps & {
     icon?: IconProps["svg"];
 } & DataTrackingId;
 /**
- * Menu component for displaying dropdown menus with navigation and actions.
+ * Menu component for displaying a dropdown or popout list of action items opened from a trigger button such as an overflow, kebab (three dots), or actions button — an actions or context menu, not a form-value selector.
  *
  * Features:
  * - Supports both controlled and uncontrolled modes

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

@@ -1,6 +1,6 @@
 import { MultiSelectFieldHandle, MultiSelectFieldProps } from './types';
 /**
- * MultiSelectField component for selecting multiple options from a searchable dropdown.
+ * MultiSelectField component: a form field for selecting multiple options at once from a searchable dropdown, showing the chosen values as tags or chips.
  *
  * Features:
  * - Multiple selection with chip display

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

@@ -24,7 +24,7 @@ export type PaginationProps = Omit<BasePaginationProps, "children"> & DataTracki
     itemsPerPageLabel?: string;
 };
 /**
- * Pagination component for navigating through paginated content with automatic page array generation.
+ * 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

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

@@ -17,7 +17,7 @@ import { DataTrackingId } from '../../types';
  */
 export type RadioProps = Omit<CoreRadioProps, "hideRadio"> & DataTrackingId;
 /**
- * Radio component for single selection from a group of options.
+ * 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

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

@@ -13,7 +13,7 @@ export type SearchFieldProps = DistributiveOmit<CoreSearchFieldProps, "size"> &
     size?: Extract<CoreSearchFieldProps["size"], "small" | "medium" | "large">;
 };
 /**
- * SearchField component for text input with search functionality.
+ * 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

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

@@ -56,7 +56,7 @@ type UncontrolledSegmentedControlProps = BaseSegmentedControlProps & {
  */
 export type SegmentedControlProps = ControlledSegmentedControlProps | UncontrolledSegmentedControlProps;
 /**
- * SegmentedControl component for selecting one option from a group of related choices.
+ * SegmentedControl component for selecting one option from a group of related choices — a horizontal set of segmented buttons, a segmented toggle or view switcher, for switching between a few mutually exclusive views or options such as list versus map.
  *
  * Features:
  * - Supports both controlled and uncontrolled modes

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

@@ -30,7 +30,7 @@ export type TabProps = Omit<ComponentPropsWithoutRef<"div">, "onAnimationStart"
     fill?: boolean;
 };
 /**
- * Tab component for organizing content into multiple sections with navigation.
+ * Tab component: a tabbed navigation control for switching between panels, sections, or views using a horizontal row of tabs.
  *
  * Features:
  * - Keyboard navigation support (arrow keys, Enter, Space)

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

@@ -58,7 +58,7 @@ export type TextareaProps = Omit<ComponentPropsWithoutRef<"textarea">, "onChange
     warning?: string | string[];
 };
 /**
- * Textarea component for multi-line text input with advanced features.
+ * Textarea component for multi-line free-form text input — a text area box for writing longer text such as paragraphs, comments, notes, messages, or descriptions.
  *
  * Features:
  * - Character counter with maxLength validation

package/dist/src/internal/types/bulkActionTypes.d.ts

@@ -13,6 +13,12 @@ import { SelectFieldOption } from '../../components/SelectField/types';
  * check-state behavior the `*Sync` variants provide.
  */
 export type BulkActionCheckState = boolean | CheckState | ((current: SelectFieldOption[]) => boolean | CheckState);
+/**
+ * Label for a "Select All" / "Select Filtered" row. A function form is
+ * resolved against the live selection (the confirmation draft when
+ * confirmation is enabled, otherwise the committed value).
+ */
+export type BulkActionLabel = string | ((current: SelectFieldOption[]) => string);
 /**
  * Configuration for the "Select All" / "Select Filtered" rows in a
  * MultiSelectMenu or MultiSelectField.
@@ -34,12 +40,12 @@ export type BulkActionCheckState = boolean | CheckState | ((current: SelectField
  * selection, so the row's checkbox can reflect how much of the set is selected.
  */
 export type BulkActionConfig = {
-    label?: string;
+    label?: BulkActionLabel;
     checkState: BulkActionCheckState;
     onClick: () => void;
     compute?: never;
 } | {
-    label?: string;
+    label?: BulkActionLabel;
     checkState: BulkActionCheckState;
     compute: (current: SelectFieldOption[]) => SelectFieldOption[] | Promise<SelectFieldOption[]>;
     onClick?: never;
@@ -62,3 +68,7 @@ export type ResolvedBulkAction = {
  * a `CheckState` is passed through, defaulting to `"indeterminate"`.
  */
 export declare function resolveBulkActionCheckState(checkState: BulkActionCheckState, current: SelectFieldOption[]): CheckState;
+/**
+ * Resolves a `BulkActionLabel` into a display string.
+ */
+export declare function resolveBulkActionLabel(label: BulkActionLabel | undefined, current: SelectFieldOption[], fallback?: string): string;