@servicetitan/anvil2 3.14.0 → 3.15.0

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

@@ -1,26 +1,6 @@
 import { SelectFieldHandle, SelectFieldProps } from './types';
 import { ForwardedRef, ReactNode } from 'react';
-/**
- * SelectField component for selecting a single option from a searchable dropdown.
- *
- * Features:
- * - Async option loading with caching, lazy pagination (page, offset, group), and debounced search
- * - Supports pinned option sections (static or dynamically loaded)
- * - Grouped options with custom sort and label functions
- * - Combobox mode (searchable) and select mode (non-searchable) via disableSearch
- * - Dialog and popover display modes with auto-detection based on viewport
- * - Imperative handle for cache management (clearCache, invalidate)
- * - Optional "Add new item" affordance below the option list with consumer-owned dialog
- * - Supports layout utilities for positioning and spacing
- *
- * @example
- * <SelectField
- *   label="Technician"
- *   value={selected}
- *   onSelectedOptionChange={setSelected}
- *   loadOptions={async (search) => fetchTechnicians(search)}
- * />
- */
+/** Single-select field. Searchable combobox unless `disableSearch`. Selection is controlled. */
 export declare const SelectField: <TID extends string | number = string | number>(propsWithLayout: SelectFieldProps<TID> & {
     ref?: ForwardedRef<SelectFieldHandle>;
 }) => ReactNode;

package/dist/src/components/SelectField/SelectFieldSync.d.ts

@@ -2,54 +2,16 @@ import { MatchSorterOptions } from 'match-sorter';
 import { SelectFieldProps, SelectFieldOption, SelectFieldGroupByValue } from './types';
 import { SyncFilterFn } from '../../internal/functions/syncFilterUtils';
 export type SelectFieldSyncProps<TID extends string | number = string | number> = Omit<SelectFieldProps<TID>, "loadOptions" | "lazy" | "debounceMs" | "cache" | "initialLoad"> & {
-    /**
-     * The options to display in the select field.
-     */
+    /** In-memory options. Search filters this list instead of calling `loadOptions`. */
     options: SelectFieldOption<TID>[];
     /**
-     * Controls how options are filtered and sorted when the user types a search value.
-     * Can be a function that returns options in the desired display order,
-     * or a MatchSorterOptions object to customize the default match-sorter behavior.
-     *
-     * Before any search is performed, options appear in the order they are supplied.
-     * By default, options are filtered by `label` and `searchText` using match-sorter,
-     * which also ranks results by match quality (best matches first).
-     *
-     * @example
-     * <SelectFieldSync
-     *   options={options}
-     *   filter={(options, searchValue) => {
-     *     return options.filter((option) => {
-     *       return option.label?.toLowerCase().includes(searchValue.toLowerCase());
-     *     });
-     *   }}
-     * />
-     *
-     * @example
-     * <SelectFieldSync
-     *   options={options}
-     *   filter={{ keys: ["label"] }}
-     * />
+     * Filter and sort as the user types. A function returns the display order;
+     * a match-sorter options object customizes the default. Unfiltered order is
+     * the `options` array. Defaults to match-sorter on `label` and `searchText`.
      */
     filter?: SyncFilterFn<TID> | MatchSorterOptions<SelectFieldOption<TID>>;
-    /**
-     * Function to compare two group values for sorting.
-     * When provided, options are sorted by group using this comparator,
-     * then by match-sort order within each group.
-     * @param a - First group value to compare
-     * @param b - Second group value to compare
-     * @returns Negative if a < b, positive if a > b, zero if equal
-     */
+    /** Orders groups when options include a `group`. */
     groupSorter?: (a: SelectFieldGroupByValue, b: SelectFieldGroupByValue) => number;
 };
-/**
- * SelectFieldSync is a simplified version of SelectField that is used to display a list of options in a select field.
- *
- * Features:
- * - Accepts `options` instead of `loadOptions` and `lazy`.
- * - Performs client-side filtering of the options.
- * - Optionally accepts a function to filter the options, or a MatchSorterOptions object to customize the default filtering.
- * - Supports grouping with optional group sorting via `groupSorter`.
- * - Supports all the other props of SelectField.
- */
+/** {@link SelectField} for a client-side `options` list. */
 export declare const SelectFieldSync: <TID extends string | number>(props: SelectFieldSyncProps<TID>) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/SelectField/internal/SelectFieldComboboxMode.d.ts

@@ -1,6 +1,3 @@
 import { SelectFieldComboboxInternalProps } from '../../../internal/types/selectFieldInternalTypes';
-/**
- * Combobox mode: searchable select using useCombobox.
- * This is the default behavior when disableSearch is false.
- */
+/** Combobox mode. Default when `disableSearch` is false. */
 export declare const SelectFieldComboboxMode: <TID extends string | number>({ id, helperUid, selectedOption, onSelectedOptionChange, displayAs, isDisabledOrReadOnly, disabled, labelAiMark, readOnly, isHighlighted, required, placeholder, size, error, hasHelperText, disableClearButton, prefix, suffix, label, hideLabel, hint, moreInfo, moreInfoId, errorMessages, warning, description, className, style, layoutStyles, pinned, groupToString, groupSorter, virtualize, options, loading, loadingMore, hasMore, loadOptions, loadMore, initialLoad, initialLoadPerformed, setInitialLoadPerformed, inputWrapperRef, debounceMs, addItemLabel, onAddNewItem, dataAttributes, }: SelectFieldComboboxInternalProps<TID>) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/SelectField/internal/SelectFieldInput.d.ts

@@ -1,25 +1,5 @@
 import { PassThroughProps, Size } from '../../../types';
 import { ReactElement, RefObject } from 'react';
-/**
- * Props for the SelectFieldInput component
- * @property {string} [placeholder] - Placeholder text displayed when input is empty
- * @property {Extract<Size, "small" | "medium" | "large">} [size] - Size variant of the input
- * @property {boolean} [disableClearButton] - Hides the clear button when true
- * @property {boolean} [disableToggleButton] - Hides the toggle button when true
- * @property {boolean} [disabled] - Disables the input entirely
- * @property {boolean} [readOnly] - Cannot be modified but remains interactive
- * @property {boolean} [isHighlighted] - Applies a subdued primary background to draw attention to the field
- * @property {boolean} [required] - Marks the input as required for form validation
- * @property {boolean} [error] - Shows error styling on the input when true
- * @property {() => void} [onClear] - Callback fired when the clear button is clicked
- * @property {string} [id] - HTML id attribute for the input element
- * @property {RefObject<HTMLDivElement>} [inputWrapperRef] - Ref for the input wrapper div element
- * @property {PassThroughProps<"div">} [htmlInputWrapperProps] - Additional props passed to the wrapper div
- * @property {PassThroughProps<"input">} [inputProps] - Additional props passed to the input element
- * @property {PassThroughProps<"button">} [toggleButtonProps] - Additional props passed to the toggle button
- * @property {string | ReactElement} [prefix] - Content to display before the input
- * @property {string | ReactElement} [suffix] - Content to display after the input
- */
 export type SelectFieldInputProps = {
     placeholder?: string;
     size?: Extract<Size, "small" | "medium" | "large">;
@@ -39,27 +19,7 @@ export type SelectFieldInputProps = {
     prefix?: string | ReactElement;
     suffix?: string | ReactElement;
 };
-/**
- * Internal input component for the SelectField that provides the text input and action buttons.
- *
- * Features:
- * - Text input for filtering and displaying selected values
- * - Optional clear button for removing the current selection
- * - Optional toggle button for opening/closing the dropdown menu
- * - Supports multiple size variants (small, medium, large)
- * - Fully accessible with proper ARIA labels on buttons
- * - Supports pass-through props for customization of internal elements
- * - Optional prefix and suffix content
- * - Error state styling
- *
- * @example
- * <SelectFieldInput
- *   placeholder="Search..."
- *   size="medium"
- *   onClear={() => handleClear()}
- *   prefix="$"
- * />
- */
+/** Combobox input, clear, and toggle chrome for searchable SelectField. */
 export declare const SelectFieldInput: {
     ({ placeholder, size, disableClearButton, disableToggleButton, disabled, readOnly, isHighlighted, required, error, onClear, id, inputWrapperRef, htmlInputWrapperProps, inputProps, toggleButtonProps, prefix, suffix, }: SelectFieldInputProps): import("react/jsx-runtime").JSX.Element;
     displayName: string;

package/dist/src/components/SelectField/internal/SelectFieldLabel.d.ts

@@ -4,20 +4,11 @@ type GetLabelProps = (options?: object) => {
     id: string;
     htmlFor: string;
 };
-/**
- * Props for the SelectFieldLabel component
- * @property {AiMarkWithTooltipOrPopoverProps} aiMark - The AI mark to display
- * @property {string} label - The text content to display as the label
- * @property {GetLabelProps} getLabelProps - Downshift getter function that returns accessibility props for the label
- * @property {boolean} [required] - Whether the field is required. Shows a red asterisk (*) when true.
- * @property {ReactNode} [moreInfo] - Additional information to display in a tooltip
- * @property {string} [moreInfoId] - ID for the sr-only description span, referenced via aria-describedby on the associated input
- * @property {boolean} [moreInfoOpen] - Controls the open state of the more info tooltip
- * @property {boolean} [hideLabel] - Visually hides the label while keeping it accessible to screen readers
- */
 export type SelectFieldLabelProps = {
     aiMark?: FieldLabelProps["aiMark"];
+    /** Accessible name; wrapped in `FieldLabel`. */
     label: string;
+    /** Downshift label ids (`htmlFor` + `id`). */
     getLabelProps: GetLabelProps;
     hideLabel?: boolean;
     moreInfo?: ReactNode;
@@ -25,24 +16,6 @@ export type SelectFieldLabelProps = {
     moreInfoOpen?: boolean;
     required?: boolean;
 };
-/**
- * Internal label component for the SelectField that renders an accessible label element.
- *
- * Features:
- * - Renders a FieldLabel with proper accessibility attributes from Downshift
- * - Automatically associates the label with the combobox input
- * - Supports screen readers with proper labeling
- * - Optional required field indicator with red asterisk
- * - Help tooltip with info icon for additional context
- * - Can visually hide the label while maintaining accessibility
- *
- * @example
- * <SelectFieldLabel
- *   label="Select an option"
- *   getLabelProps={getLabelProps}
- *   required
- *   moreInfo="Choose from available options"
- * />
- */
+/** Field label associated with the combobox or listbox trigger. */
 export declare const SelectFieldLabel: ({ aiMark, label, getLabelProps, hideLabel, moreInfo, moreInfoId, moreInfoOpen, required, }: SelectFieldLabelProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/src/components/SelectField/internal/SelectFieldSelectMode.d.ts

@@ -1,6 +1,3 @@
 import { SelectFieldBaseInternalProps } from '../../../internal/types/selectFieldInternalTypes';
-/**
- * Select mode: non-searchable select using useSelect.
- * Active when disableSearch is true.
- */
+/** Listbox mode. Active when `disableSearch` is true. */
 export declare const SelectFieldSelectMode: <TID extends string | number = string | number>({ labelAiMark, id, helperUid, selectedOption, onSelectedOptionChange, displayAs, isDisabledOrReadOnly, disabled, readOnly, isHighlighted, placeholder, size, error, hasHelperText, disableClearButton, prefix, suffix, label, hideLabel, hint, moreInfo, moreInfoId, errorMessages, warning, description, className, style, layoutStyles, pinned, groupToString, groupSorter, virtualize, options, loading, loadingMore, hasMore, loadOptions, loadMore, initialLoad, initialLoadPerformed, setInitialLoadPerformed, inputWrapperRef, required, addItemLabel, onAddNewItem, dataAttributes, }: SelectFieldBaseInternalProps<TID>) => import("react/jsx-runtime").JSX.Element;

package/dist/src/components/SelectField/internal/SelectFieldTrigger.d.ts

@@ -13,15 +13,12 @@ export type SelectFieldTriggerProps = {
     popoverTarget?: string;
     inputWrapperRef?: RefObject<HTMLDivElement>;
     toggleButtonProps?: Record<string, any>;
-    /** The display text (selected option label or empty) */
+    /** Selected option label, or empty so the placeholder shows. */
     displayValue?: string;
     prefix?: string | ReactElement;
     suffix?: string | ReactElement;
 };
-/**
- * Non-searchable select trigger for SelectField when disableSearch is true.
- * Renders a div-based trigger instead of an input, suitable for the listbox ARIA pattern.
- */
+/** Listbox trigger for SelectField when `disableSearch`. */
 export declare const SelectFieldTrigger: {
     ({ placeholder, size, disableClearButton, disabled, readOnly, isHighlighted, error, onClear, id, inputWrapperRef, toggleButtonProps, displayValue, prefix, suffix, popoverTarget, }: SelectFieldTriggerProps): import("react/jsx-runtime").JSX.Element;
     displayName: string;

package/dist/src/components/SelectField/internal/useCombo.d.ts

@@ -15,9 +15,7 @@ export type UseComboOptions<TID extends string | number> = {
     virtualize?: boolean;
     onScrollToHighlight?: (index: number) => void;
 } & Pick<UseComboboxProps<SelectItem>, "onInputValueChange" | "onIsOpenChange">;
-/**
- * The purpose of useCombo is to provide an abstraction over the downshift combobox hook.
- */
+/** Downshift combobox wiring for searchable SelectField. */
 export declare const useCombo: <TID extends string | number>({ options, pinned, groupToString, groupSorter, selectedOption, onSelectedOptionChange, onInputValueChange, onIsOpenChange, displayAs, disableHighlightOnOpen, disabled, virtualize, onScrollToHighlight, }: UseComboOptions<TID>) => {
     inputValue: string;
     wrapperDivRef: import('react').RefObject<HTMLDivElement>;

package/dist/src/components/SelectField/internal/useSelectMode.d.ts

@@ -16,10 +16,7 @@ export type UseSelectModeOptions<TID extends string | number> = {
     virtualize?: boolean;
     onScrollToHighlight?: (index: number) => void;
 };
-/**
- * Wraps downshift's useSelect for non-searchable select fields.
- * Returns a compatible interface to useCombo (minus getInputProps/inputValue).
- */
+/** Downshift useSelect wiring for `disableSearch` SelectField. */
 export declare const useSelectMode: <TID extends string | number>({ options, pinned, groupToString, groupSorter, selectedOption, onSelectedOptionChange, onIsOpenChange, displayAs, disableHighlightOnOpen, disabled, virtualize, onScrollToHighlight, }: UseSelectModeOptions<TID>) => {
     wrapperDivRef: import('react').RefObject<HTMLDivElement>;
     getToggleButtonProps: <Options>(options?: import('downshift').UseSelectGetToggleButtonPropsOptions & Options, otherOptions?: import('downshift').GetPropsCommonOptions) => import('downshift').Overwrite<import('downshift').UseSelectGetToggleButtonReturnValue, Options>;