@baseline-ui/core 0.53.0 → 0.54.0

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import { Time, CalendarDateTime, ZonedDateTime, CalendarDate, CalendarIdentifier
 import { NumberFormatOptions } from '@internationalized/number';
 import { LocalizedStrings } from '@internationalized/message';
 import { Theme, Sprinkles } from '@baseline-ui/tokens';
-import { PanelProps as PanelProps$1, ImperativePanelHandle as ImperativePanelHandle$1, PanelGroupProps as PanelGroupProps$1, ImperativePanelGroupHandle as ImperativePanelGroupHandle$1, PanelResizeHandleProps as PanelResizeHandleProps$1 } from 'react-resizable-panels';
+import { PanelProps as PanelProps$1, PanelImperativeHandle, GroupProps as GroupProps$1, SeparatorProps as SeparatorProps$2 } from 'react-resizable-panels';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 export { MotionGlobalConfig } from 'motion/react';
 
@@ -437,17 +437,17 @@ interface SingleSelection {
   /** The currently selected key in the collection (controlled). */
   selectedKey?: Key | null,
   /** The initial selected key in the collection (uncontrolled). */
-  defaultSelectedKey?: Key,
+  defaultSelectedKey?: Key | null,
   /** Handler that is called when the selection changes. */
   onSelectionChange?: (key: Key | null) => void
 }
 
-type SelectionMode$2 = 'none' | 'single' | 'multiple';
+type SelectionMode$3 = 'none' | 'single' | 'multiple';
 type SelectionBehavior = 'toggle' | 'replace';
 type Selection$1 = 'all' | Set<Key>;
 interface MultipleSelection {
   /** The type of selection that is allowed in the collection. */
-  selectionMode?: SelectionMode$2,
+  selectionMode?: SelectionMode$3,
   /** Whether the collection allows empty selection. */
   disallowEmptySelection?: boolean,
   /** The currently selected keys in the collection (controlled). */
@@ -1001,6 +1001,11 @@ interface PressEvent {
   x: number,
   /** Y position relative to the target. */
   y: number,
+  /**
+   * The key that triggered the press event, if it was triggered by a keyboard interaction.
+   * This is useful for differentiating between Space and Enter key presses.
+   */
+  key?: string,
   /**
    * By default, press events stop propagation to parent elements.
    * In cases where a handler decides not to handle a specific event,
@@ -1350,7 +1355,7 @@ interface AriaBaseButtonProps extends FocusableDOMProps, AriaLabelingProps {
    * The URL that processes the information submitted by the button.
    * Overrides the action attribute of the button's form owner.
    */
-  formAction?: string,
+  formAction?: ButtonHTMLAttributes<HTMLButtonElement>['formAction'],
   /** Indicates how to encode the form data that is submitted. */
   formEncType?: string,
   /** Indicates the HTTP method used to submit the form. */
@@ -1660,22 +1665,48 @@ interface AriaColorSwatchProps extends AriaLabelingProps, DOMProps {
 
 
 type MenuTriggerAction = 'focus' | 'input' | 'manual';
+type SelectionMode$2 = 'single' | 'multiple';
+type ValueType$1<M extends SelectionMode$2> = M extends 'single' ? Key | null : Key[];
+type ValidationType$1<M extends SelectionMode$2> = M extends 'single' ? Key : Key[];
 
-interface ComboBoxValidationValue {
-  /** The selected key in the ComboBox. */
+interface ComboBoxValidationValue<M extends SelectionMode$2 = 'single'> {
+  /**
+   * The selected key in the ComboBox.
+   * @deprecated
+   */
   selectedKey: Key | null,
+  /** The keys of the currently selected items. */
+  value: ValidationType$1<M>,
   /** The value of the ComboBox input. */
   inputValue: string
 }
 
-interface ComboBoxProps$1<T> extends CollectionBase<T>, Omit<SingleSelection, 'disallowEmptySelection' | 'onSelectionChange'>, InputBase, TextInputBase, Validation<ComboBoxValidationValue>, FocusableProps$1<HTMLInputElement>, LabelableProps, HelpTextProps {
+interface ComboBoxProps$1<T, M extends SelectionMode$2 = 'single'> extends CollectionBase<T>, InputBase, ValueBase<ValueType$1<M>>, TextInputBase, Validation<ComboBoxValidationValue>, FocusableProps$1<HTMLInputElement>, LabelableProps, HelpTextProps {
   /** The list of ComboBox items (uncontrolled). */
   defaultItems?: Iterable<T>,
   /** The list of ComboBox items (controlled). */
   items?: Iterable<T>,
   /** Method that is called when the open state of the menu changes. Returns the new open state and the action that caused the opening of the menu. */
   onOpenChange?: (isOpen: boolean, menuTrigger?: MenuTriggerAction) => void,
-  /** Handler that is called when the selection changes. */
+  /**
+   * Whether single or multiple selection is enabled.
+   * @default 'single'
+   */
+  selectionMode?: M,
+  /**
+   * The currently selected key in the collection (controlled).
+   * @deprecated
+   */
+  selectedKey?: Key | null,
+  /**
+   * The initial selected key in the collection (uncontrolled).
+   * @deprecated
+   */
+  defaultSelectedKey?: Key | null,
+  /**
+   * Handler that is called when the selection changes.
+   * @deprecated
+   */
   onSelectionChange?: (key: Key | null) => void,
   /** The value of the ComboBox input (controlled). */
   inputValue?: string,
@@ -1684,7 +1715,7 @@ interface ComboBoxProps$1<T> extends CollectionBase<T>, Omit<SingleSelection, 'd
   /** Handler that is called when the ComboBox input value changes. */
   onInputChange?: (value: string) => void,
   /** Whether the ComboBox allows a non-item matching input value to be set. */
-  allowsCustomValue?: boolean,
+allowsCustomValue?: boolean,
   // /**
   //  * Whether the Combobox should only suggest matching options or autocomplete the field with the nearest matching option.
   //  * @default 'suggest'
@@ -1697,7 +1728,7 @@ interface ComboBoxProps$1<T> extends CollectionBase<T>, Omit<SingleSelection, 'd
   menuTrigger?: MenuTriggerAction
 }
 
-interface AriaComboBoxProps<T> extends ComboBoxProps$1<T>, DOMProps, InputDOMProps, AriaLabelingProps {
+interface AriaComboBoxProps<T, M extends SelectionMode$2 = 'single'> extends ComboBoxProps$1<T, M>, DOMProps, InputDOMProps, AriaLabelingProps {
   /** Whether keyboard navigation is circular. */
   shouldFocusWrap?: boolean
 }
@@ -1766,7 +1797,7 @@ interface FocusState {
 }
 interface MultipleSelectionState extends FocusState {
     /** The type of selection that is allowed in the collection. */
-    readonly selectionMode: SelectionMode$2;
+    readonly selectionMode: SelectionMode$3;
     /** The selection behavior for the collection. */
     readonly selectionBehavior: SelectionBehavior;
     /** Sets the selection behavior for the collection. */
@@ -1784,7 +1815,7 @@ interface MultipleSelectionState extends FocusState {
 }
 interface MultipleSelectionManager extends FocusState {
     /** The type of selection that is allowed in the collection. */
-    readonly selectionMode: SelectionMode$2;
+    readonly selectionMode: SelectionMode$3;
     /** The selection behavior for the collection. */
     readonly selectionBehavior: SelectionBehavior;
     /** Whether the collection allows empty selection. */
@@ -1866,7 +1897,7 @@ declare class SelectionManager implements MultipleSelectionManager {
     /**
      * The type of selection that is allowed in the collection.
      */
-    get selectionMode(): SelectionMode$2;
+    get selectionMode(): SelectionMode$3;
     /**
      * Whether the collection allows empty selection.
      */
@@ -2133,7 +2164,7 @@ interface OverlayTriggerState {
 }
 
 type FilterFn = (textValue: string, inputValue: string) => boolean;
-interface ComboBoxStateOptions<T> extends Omit<ComboBoxProps$1<T>, 'children'>, CollectionStateBase<T> {
+interface ComboBoxStateOptions<T, M extends SelectionMode$2 = 'single'> extends Omit<ComboBoxProps$1<T, M>, 'children'>, CollectionStateBase<T> {
     /** The filter function used to determine if a option should be included in the combo box list. */
     defaultFilter?: FilterFn;
     /** Whether the combo box allows the menu to be open when the collection is empty. */
@@ -2142,7 +2173,7 @@ interface ComboBoxStateOptions<T> extends Omit<ComboBoxProps$1<T>, 'children'>,
     shouldCloseOnBlur?: boolean;
 }
 
-interface AriaComboBoxOptions<T> extends Omit<AriaComboBoxProps<T>, 'children'> {
+interface AriaComboBoxOptions<T, M extends SelectionMode$2 = 'single'> extends Omit<AriaComboBoxProps<T, M>, 'children'> {
     /** The ref for the input element. */
     inputRef: RefObject<HTMLInputElement | null>;
     /** The ref for the list box popover. */
@@ -2331,8 +2362,7 @@ type NullToObject<T> = T extends (null | undefined) ? {} : T;
 type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never;
 /**
  * Merges multiple props objects together. Event handlers are chained,
- * classNames are combined, and ids are deduplicated - different ids
- * will trigger a side-effect and re-render components hooked up with `useId`.
+ * classNames are combined, ids are deduplicated, and refs are merged.
  * For all other props, the last prop object overrides all previous ones.
  * @param args - Multiple sets of props to merge together.
  */
@@ -2392,7 +2422,7 @@ interface FocusScopeProps {
     restoreFocus?: boolean;
     /** Whether to auto focus the first focusable element in the focus scope on mount. */
     autoFocus?: boolean;
-    /** The owner document to use for focus restoration. */
+    /** The owner document for the focus scope. Used to support iframes and shadow DOM. */
     ownerDocument?: Document;
 }
 interface FocusManagerOptions {
@@ -2852,11 +2882,11 @@ declare function useCollator(options?: Intl.CollatorOptions): Intl.Collator;
 
 interface Filter {
     /** Returns whether a string starts with a given substring. */
-    startsWith(string: string, substring: string): boolean;
+    startsWith: (string: string, substring: string) => boolean;
     /** Returns whether a string ends with a given substring. */
-    endsWith(string: string, substring: string): boolean;
+    endsWith: (string: string, substring: string) => boolean;
     /** Returns whether a string contains a given substring. */
-    contains(string: string, substring: string): boolean;
+    contains: (string: string, substring: string) => boolean;
 }
 /**
  * Provides localized string search functionality that is useful for filtering or matching items
@@ -3356,7 +3386,7 @@ interface AriaProgressBarProps extends ProgressBarProps$1, DOMProps, AriaLabelin
 
 
 
-interface RadioGroupProps$1 extends ValueBase<string|null, string>, InputBase, Pick<InputDOMProps, 'name'>, Validation<string | null>, LabelableProps, HelpTextProps, FocusEvents {
+interface RadioGroupProps$1 extends ValueBase<string|null, string>, InputBase, Pick<InputDOMProps, 'name'>, Validation<string>, LabelableProps, HelpTextProps, FocusEvents {
   /**
    * The axis the Radio Button(s) should align with.
    * @default 'vertical'
@@ -3415,10 +3445,11 @@ interface AriaSearchFieldProps extends SearchFieldProps, Omit<AriaTextFieldProps
 
 
 type SelectionMode$1 = 'single' | 'multiple';
-type ValueType<M extends SelectionMode$1> = M extends 'single' ? Key | null : Key[];
+type ValueType<M extends SelectionMode$1> = M extends 'single' ? Key | null : readonly Key[];
+type ChangeValueType<M extends SelectionMode$1> = M extends 'single' ? Key | null : Key[];
 type ValidationType<M extends SelectionMode$1> = M extends 'single' ? Key : Key[];
 
-interface SelectProps$1<T, M extends SelectionMode$1 = 'single'> extends CollectionBase<T>, Omit<InputBase, 'isReadOnly'>, ValueBase<ValueType<M>>, Validation<ValidationType<M>>, HelpTextProps, LabelableProps, TextInputBase, FocusableProps$1 {
+interface SelectProps$1<T, M extends SelectionMode$1 = 'single'> extends CollectionBase<T>, Omit<InputBase, 'isReadOnly'>, ValueBase<ValueType<M>, ChangeValueType<M>>, Validation<ValidationType<M>>, HelpTextProps, LabelableProps, TextInputBase, FocusableProps$1 {
   /**
    * Whether single or multiple selection is enabled.
    * @default 'single'
@@ -3433,7 +3464,7 @@ interface SelectProps$1<T, M extends SelectionMode$1 = 'single'> extends Collect
    * The initial selected key in the collection (uncontrolled).
    * @deprecated
    */
-  defaultSelectedKey?: Key,
+  defaultSelectedKey?: Key | null,
   /**
    * Handler that is called when the selection changes.
    * @deprecated
@@ -3444,7 +3475,9 @@ interface SelectProps$1<T, M extends SelectionMode$1 = 'single'> extends Collect
   /** Sets the default open state of the menu. */
   defaultOpen?: boolean,
   /** Method that is called when the open state of the menu changes. */
-  onOpenChange?: (isOpen: boolean) => void
+  onOpenChange?: (isOpen: boolean) => void,
+  /** Whether the select should be allowed to be open when the collection is empty. */
+  allowsEmptyCollection?: boolean
 }
 
 interface AriaSelectProps<T, M extends SelectionMode$1 = 'single'> extends SelectProps$1<T, M>, DOMProps, AriaLabelingProps, FocusableDOMProps {
@@ -3574,12 +3607,16 @@ declare let _Item: <T>(props: ItemProps$1<T>) => JSX.Element;
 
 
 
-interface TabListProps<T> extends CollectionBase<T>, Omit<SingleSelection, 'disallowEmptySelection' | 'onSelectionChange'> {
+interface TabListProps<T> extends CollectionBase<T>, Omit<SingleSelection, 'disallowEmptySelection' | 'selectedKey' | 'defaultSelectedKeys' | 'onSelectionChange'> {
   /**
    * Whether the TabList is disabled.
    * Shows that a selection exists, but is not available in that circumstance.
    */
   isDisabled?: boolean,
+  /** The currently selected key in the collection (controlled). */
+  selectedKey?: Key,
+  /** The initial selected keys in the collection (uncontrolled). */
+  defaultSelectedKey?: Key,
   /** Handler that is called when the selection changes. */
   onSelectionChange?: (key: Key) => void
 }
@@ -3714,7 +3751,13 @@ interface TooltipTriggerProps extends OverlayTriggerProps$1 {
    * By default, opens for both focus and hover. Can be made to open only for focus.
    * @default 'hover'
    */
-  trigger?: 'hover' | 'focus'
+  trigger?: 'hover' | 'focus',
+
+  /**
+   * Whether the tooltip should close when the trigger is pressed.
+   * @default true
+   */
+  shouldCloseOnPress?: boolean
 }
 
 interface TooltipProps$1 {
@@ -3831,9 +3874,9 @@ interface ListData<T> {
     /**
      * Updates an item in the list.
      * @param key - The key of the item to update.
-     * @param newValue - The new value for the item.
+     * @param newValue - The new value for the item, or a function that returns the new value based on the previous value.
      */
-    update(key: Key, newValue: T): void;
+    update(key: Key, newValue: T | ((prev: T) => T)): void;
 }
 /**
  * Manages state for an immutable list data structure, and provides convenience methods to
@@ -3952,7 +3995,7 @@ type ClassNameOrFunction<T> = string | ((values: T & {
 type StyleOrFunction<T> = CSSProperties | ((values: T & {
     defaultStyle: CSSProperties;
 }) => CSSProperties | undefined);
-interface StyleRenderProps<T> {
+interface StyleRenderProps<T, E extends keyof React__default.JSX.IntrinsicElements = 'div'> extends DOMRenderProps<E, T> {
     /** The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state. */
     className?: ClassNameOrFunction<T>;
     /** The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state. */
@@ -3965,6 +4008,21 @@ interface SlotProps {
      */
     slot?: string | null;
 }
+type DOMRenderFunction<E extends keyof React__default.JSX.IntrinsicElements, T> = (props: React__default.JSX.IntrinsicElements[E], renderProps: T) => ReactElement;
+interface DOMRenderProps<E extends keyof React__default.JSX.IntrinsicElements, T> {
+    /**
+     * Overrides the default DOM element with a custom render function.
+     * This allows rendering existing components with built-in styles and behaviors
+     * such as router links, animation libraries, and pre-styled components.
+     *
+     * Requirements:
+     *
+     * * You must render the expected element type (e.g. if `<button>` is expected, you cannot render an `<a>`).
+     * * Only a single root DOM element can be rendered (no fragments).
+     * * You must pass through props and ref to the underlying DOM element, merging with your own prop as appropriate.
+     */
+    render?: DOMRenderFunction<E, T>;
+}
 
 interface AutocompleteProps$1 {
     /** The value of the autocomplete input (controlled). */
@@ -3999,7 +4057,7 @@ interface AriaAutocompleteProps<T> extends AutocompleteProps$1 {
 interface AutocompleteProps<T = object> extends AriaAutocompleteProps<T>, SlotProps {
 }
 /**
- * An autocomplete combines a TextField or SearchField with a Menu or ListBox, allowing users to search or filter a list of suggestions.
+ * An autocomplete allows users to search or filter a list of suggestions.
  */
 declare function Autocomplete<T extends object>(props: AutocompleteProps<T>): JSX.Element;
 
@@ -4045,7 +4103,7 @@ interface ItemRenderProps {
      * The type of selection that is allowed in the collection.
      * @selector [data-selection-mode="single | multiple"]
      */
-    selectionMode: SelectionMode$2;
+    selectionMode: SelectionMode$3;
     /** The selection behavior for the collection. */
     selectionBehavior: SelectionBehavior;
     /**
@@ -4597,6 +4655,12 @@ interface GridLayoutOptions {
      * @default 2
      */
     dropIndicatorThickness?: number;
+    /**
+     * The fixed height of a loader element in px. This loader is specifically for
+     * "load more" elements rendered when loading more rows at the root level or inside nested row/sections.
+     * @default 48
+     */
+    loaderHeight?: number;
 }
 /**
  * GridLayout is a virtualizer Layout implementation
@@ -4787,6 +4851,12 @@ interface WaterfallLayoutOptions {
      * @default 2
      */
     dropIndicatorThickness?: number;
+    /**
+     * The fixed height of a loader element in px. This loader is specifically for
+     * "load more" elements rendered when loading more rows at the root level or inside nested row/sections.
+     * @default 48
+     */
+    loaderHeight?: number;
 }
 declare class WaterfallLayout<T extends object, O extends WaterfallLayoutOptions = WaterfallLayoutOptions> extends Layout<Node$1<T>, O> implements LayoutDelegate, DropTargetDelegate {
     private contentSize;
@@ -4840,9 +4910,9 @@ interface AriaToolbarProps extends AriaLabelingProps {
      */
     orientation?: Orientation;
     /**
-   * Allows tabbing through the toolbar's content when false.
-   * @default true
-   */
+     * Allows tabbing through the toolbar's content when false.
+     * @default true
+     */
     isSingleTabStop?: boolean;
 }
 
@@ -8190,26 +8260,24 @@ interface PanelProps extends StylingProps {
      */
     minSize?: PanelProps$1["minSize"];
     /** Called with current panel size on resize */
-    onResize?: PanelProps$1["onResize"];
-    /**
-     * Provide a value in case of conditional rendering to ensure panels are
-     * correctly added back
-     */
-    order?: PanelProps$1["order"];
+    onResize?: (size: number) => void;
 }
 interface PanelGroupProps extends StylingProps {
     /** Content comprising `Panel` and `PanelResizeHandle` */
     children: ReactNode;
     /** Orientation of the layout */
-    direction: PanelGroupProps$1["direction"];
-    /** Called with current panel sizes when group layout changes */
-    onLayout?: PanelGroupProps$1["onLayout"];
+    direction: NonNullable<GroupProps$1["orientation"]>;
+    /**
+     * Called with a map of panel id to size (percentage) when group layout
+     * changes
+     */
+    onLayout?: (layout: Record<string, number>) => void;
     /**
      * When passed, automatically persists layouts, should be unique amongst other
      * `PanelGroup`. Each `Panel` should have a stable `id` prop for persistence
      * to work correctly.
      */
-    autoSaveId?: PanelGroupProps$1["autoSaveId"];
+    autoSaveId?: string;
 }
 interface PanelResizeHandleProps extends StylingProps {
     /**
@@ -8217,13 +8285,13 @@ interface PanelResizeHandleProps extends StylingProps {
      *
      * @default false
      */
-    isDisabled?: PanelResizeHandleProps$1["disabled"];
+    isDisabled?: SeparatorProps$2["disabled"];
 }
 interface ImperativePanelGroupHandle {
-    setLayout?: ImperativePanelGroupHandle$1["setLayout"];
+    setLayout?: (layout: Record<string, number>) => void;
 }
 interface ImperativePanelHandle {
-    resize?: ImperativePanelHandle$1["resize"];
+    resize?: PanelImperativeHandle["resize"];
 }
 
 declare const Panel: React.ForwardRefExoticComponent<PanelProps & React.RefAttributes<ImperativePanelHandle>>;