@baseline-ui/core 3.2.1 → 3.3.0

package/dist/index.d.ts

@@ -3,7 +3,6 @@ import React__default, { ReactNode, AriaAttributes, DOMAttributes as DOMAttribut
 import { CalendarDate, CalendarDateTime, ZonedDateTime, DateDuration, CalendarIdentifier, Calendar as Calendar$1, Time, DateFormatter } from '@internationalized/date';
 import { Theme, Sprinkles } from '@baseline-ui/tokens';
 import { PanelImperativeHandle, PanelProps as PanelProps$1, SeparatorProps as SeparatorProps$2 } from 'react-resizable-panels';
-import * as react_jsx_runtime from 'react/jsx-runtime';
 export { MotionGlobalConfig } from 'motion/react';
 
 /*
@@ -6017,7 +6016,7 @@ declare function classNames(...args: any[]): string;
  * Returns the HTMLElement from a string selector, HTMLElement, or React
  * RefObject.
  */
-declare function getHTMLElement(element: string | HTMLElement | React__default.RefObject<HTMLElement> | null | undefined, ownerDocument: Document): HTMLElement | null | undefined;
+declare function getHTMLElement(element: string | HTMLElement | React__default.RefObject<HTMLElement | null> | null | undefined, ownerDocument: Document): HTMLElement | null | undefined;
 interface FontProperties {
     fontSize?: number;
     fontFamily?: string;
@@ -6585,7 +6584,7 @@ interface ListBoxProps extends StylingProps, Omit<AriaListBoxProps<ListItem> & A
      */
     withSectionHeaderPadding?: boolean;
     /** Handle to access the listbox methods. */
-    listBoxHandle?: React__default.RefObject<ListHandle$1>;
+    listBoxHandle?: React__default.RefObject<ListHandle$1 | null>;
 }
 
 declare const ListBox: React__default.ForwardRefExoticComponent<ListBoxProps & React__default.RefAttributes<HTMLUListElement>>;
@@ -6748,7 +6747,7 @@ interface PopoverContentProps extends Omit<AriaPopoverProps, "popoverRef" | "tri
      * The reference element for the popover position. By default, the popover is
      * positioned relative to the trigger element.
      */
-    triggerRef?: React__default.RefObject<HTMLElement>;
+    triggerRef?: React__default.RefObject<HTMLElement | null>;
     /** The class name for the underlay element. */
     underlayClassName?: ClassName$1;
     /** The contents of the popover. */
@@ -6959,7 +6958,7 @@ interface UNSAFE_ListBoxProps extends StylingProps, Omit<AriaListBoxProps<ListIt
     /** The label for the listbox. */
     label?: React__default.ReactNode;
     /** Handle to access the listbox methods. */
-    listBoxHandle?: React__default.RefObject<ListHandle>;
+    listBoxHandle?: React__default.RefObject<ListHandle | null>;
 }
 
 type MenuOption = Omit<CollectionOptionItem, "description"> & {
@@ -8592,7 +8591,7 @@ interface FreehandCanvasProps extends StylingProps, AriaLabelingProps {
     /** The style applicable to the SVG canvas. */
     canvasStyle?: React__default.CSSProperties;
     /** The ref for the canvas. */
-    canvasRef?: React__default.RefObject<HTMLDivElement>;
+    canvasRef?: React__default.RefObject<HTMLDivElement | null>;
     /** The className applicable to the footer. */
     footerClassName?: string;
     /** The style applicable to the footer. */
@@ -8828,7 +8827,13 @@ interface PreviewProps extends StylingProps, AriaLabelingProps {
     imageSrc?: string;
     /** The alt text for the image. */
     imageAlt?: string;
-    /** The SVG to display in the preview. This can be a React element or a string. */
+    /**
+     * The SVG to display in the preview. This can be a React element or a string.
+     * String SVGs are sanitized with DOMPurify's default profile, which removes
+     * scripts, event handlers and elements such as `use` (so `<use href="#id">`
+     * sprite icons render blank), `animate`, `set` and `foreignObject`. Pass a
+     * React element to render those. String SVGs render after mount.
+     */
     svgSrc?: string | React__default.JSX.Element;
     /** Whether the preview should be disabled or not. */
     isDisabled?: boolean;
@@ -9179,7 +9184,9 @@ interface EditorProps extends StylingProps, AriaLabelingProps {
     editableContentAriaLabel?: string;
     /**
      * An optional array of mentionable users. Mention feature is only available
-     * when `enableRichText` is set to `true` and this prop is provided.
+     * when `enableRichText` is set to `true` and this prop is provided. Pasted or
+     * dropped mentions of users not in this array, or of any user while it is
+     * undefined, become plain text.
      *
      * ```tsx
      * type MentionableUser = {
@@ -9208,7 +9215,7 @@ interface EditorProps extends StylingProps, AriaLabelingProps {
         props: Omit<ToggleIconButtonProps, "size" | "variant">;
     })[];
     /** The imperative handle for manipulating editor. */
-    editorHandle?: React__default.RefObject<EditorHandle>;
+    editorHandle?: React__default.RefObject<EditorHandle | null>;
     /**
      * Whether to clear the editor value when the editor is saved.
      *
@@ -9533,6 +9540,13 @@ interface EditorCoreOptions {
      * the character is inserted natively (e.g. no mentionable users configured).
      */
     canStartMention?: () => boolean;
+    /**
+     * Resolves a pasted mention's user id to its display name. A mention whose
+     * id resolves to `undefined` is pasted as plain text. When omitted, pasted
+     * mentions are kept as-is. Applies to pasted and dropped content, not to
+     * `value`/`setValue`.
+     */
+    resolveMention?: (userId: string) => string | undefined;
     /**
      * When this returns false, URL-shaped text is NOT auto-converted into links
      * (typing a delimiter after a URL, pasting URLs, smart-pasting a URL over a
@@ -9729,6 +9743,7 @@ declare class EditorCore {
      */
     private applyAutoLink;
     private handlePasteInput;
+    private resolvePastedMentions;
     private insertPastedData;
     /**
      * Called after an `input` event (or compositionend). Reads the current DOM
@@ -9808,7 +9823,7 @@ interface EditorState {
  * Options for {@link useEditor}. Combines the engine callbacks with the
  * React-managed props the hook owns the lifecycle for.
  */
-interface UseEditorOptions extends Pick<EditorCoreOptions, "onChange" | "onSelectionChange" | "onMentionTrigger" | "onMentionInputRemoved" | "canStartMention" | "isReadOnly"> {
+interface UseEditorOptions extends Pick<EditorCoreOptions, "onChange" | "onSelectionChange" | "onMentionTrigger" | "onMentionInputRemoved" | "canStartMention" | "resolveMention" | "isReadOnly"> {
     /** Controlled value (provide with `onChange`). */
     value?: string;
     /** Initial value for uncontrolled use (applied once on mount). */
@@ -9923,7 +9938,7 @@ interface ScrollControlButtonProps extends StylingProps, Pick<ActionButtonProps,
      *
      * @default document.body
      */
-    scrollRef?: React__default.RefObject<HTMLElement>;
+    scrollRef?: React__default.RefObject<HTMLElement | null>;
     /**
      * Indicates whether the button should be hidden when the keyboard is being
      * used.
@@ -10476,7 +10491,7 @@ type GridListProps = Omit<StylingProps & ListProps<ListOption> & AriaGridListOpt
      */
     isEditing?: boolean;
     /** Handle to access the gridlist imperative methods. */
-    gridListHandle?: React__default.RefObject<ListHandle$1>;
+    gridListHandle?: React__default.RefObject<ListHandle$1 | null>;
 }, "children" | "suppressTextValueWarning" | "allowDuplicateSelectionEvents" | "linkBehavior" | "keyboardDelegate" | "isVirtualized" | "filter">;
 
 declare const GridList: React__default.ForwardRefExoticComponent<GridListProps & React__default.RefAttributes<HTMLUListElement>>;
@@ -10595,7 +10610,7 @@ interface ColorSwatchPickerProps extends StylingProps, Pick<RadioGroupProps, "op
 
 declare const ColorSwatchPicker: React__default.ForwardRefExoticComponent<ColorSwatchPickerProps & React__default.RefAttributes<HTMLDivElement>>;
 
-declare const TimeField: React__default.ForwardRefExoticComponent<StylingProps & Omit<Omit<TimeFieldStateOptions<TimeValue>, "locale"> & AriaTimeFieldProps<TimeValue>, "validationState" | "isRequired" | "validate" | "isInvalid"> & Pick<SharedInputProps, "label" | "validationState" | "variant" | "labelPosition"> & InputMessage & React__default.RefAttributes<HTMLDivElement>>;
+declare const TimeField: React__default.ForwardRefExoticComponent<StylingProps & Omit<Omit<TimeFieldStateOptions<TimeValue>, "locale"> & AriaTimeFieldProps<TimeValue>, "validationState" | "isRequired" | "validate" | "isInvalid"> & Pick<SharedInputProps, "label" | "variant" | "validationState" | "labelPosition"> & InputMessage & React__default.RefAttributes<HTMLDivElement>>;
 
 type TimeFieldProps = StylingProps & Omit<Omit<TimeFieldStateOptions, "locale"> & AriaTimeFieldProps<TimeValue>, "validationState" | "isInvalid" | "isRequired" | "validate"> & Pick<SharedInputProps, "variant" | "labelPosition" | "validationState" | "label"> & InputMessage;
 
@@ -10787,7 +10802,7 @@ declare const Panel: React.ForwardRefExoticComponent<PanelProps & React.RefAttri
 declare const PanelGroup: React.ForwardRefExoticComponent<PanelGroupProps & React.RefAttributes<ImperativePanelGroupHandle>>;
 
 declare const PanelResizeHandle: {
-    ({ className, isDisabled, ...props }: PanelResizeHandleProps): react_jsx_runtime.JSX.Element;
+    ({ className, isDisabled, ...props }: PanelResizeHandleProps): React.JSX.Element;
     displayName: string;
 };
 
@@ -10874,7 +10889,7 @@ type DateFieldProps = StylingProps & Omit<Omit<DateFieldStateOptions, "locale">
     openCalendarLabel?: string;
 };
 
-declare const DateField: React__default.ForwardRefExoticComponent<StylingProps & Omit<Omit<DateFieldStateOptions<DateValue>, "locale"> & AriaDateFieldProps<DateValue>, "validationState" | "isRequired" | "validate" | "isInvalid" | "createCalendar"> & Pick<SharedInputProps, "label" | "validationState" | "variant" | "labelPosition"> & InputMessage & {
+declare const DateField: React__default.ForwardRefExoticComponent<StylingProps & Omit<Omit<DateFieldStateOptions<DateValue>, "locale"> & AriaDateFieldProps<DateValue>, "validationState" | "isRequired" | "validate" | "isInvalid" | "createCalendar"> & Pick<SharedInputProps, "label" | "variant" | "validationState" | "labelPosition"> & InputMessage & {
     pickerType?: DateFieldPickerType;
     openCalendarLabel?: string;
 } & React__default.RefAttributes<HTMLDivElement>>;
@@ -10985,7 +11000,7 @@ interface PointPickerContentProps extends StylingProps, Pick<FocusProps<Focusabl
     /** The ref to the element. */
     elementHandle?: React__default.RefObject<{
         focus: () => void;
-    }>;
+    } | null>;
     /**
      * The callback function that is called when the cursor is moved.
      *
@@ -11161,11 +11176,11 @@ interface StatusCardProps extends Omit<StylingProps, keyof BlockProps> {
 }
 
 declare const iconMap: {
-    warning: react_jsx_runtime.JSX.Element;
-    error: react_jsx_runtime.JSX.Element;
-    active: react_jsx_runtime.JSX.Element;
-    success: react_jsx_runtime.JSX.Element;
-    denied: react_jsx_runtime.JSX.Element;
+    warning: React__default.JSX.Element;
+    error: React__default.JSX.Element;
+    active: React__default.JSX.Element;
+    success: React__default.JSX.Element;
+    denied: React__default.JSX.Element;
 };
 declare const StatusCard: React__default.ForwardRefExoticComponent<StatusCardProps & React__default.RefAttributes<HTMLDivElement>>;
 
@@ -11277,7 +11292,7 @@ declare const Cell: React__default.ForwardRefExoticComponent<CellProps$1 & React
 interface UseTableDragAndDropOptions<T extends object = object> extends DragAndDropOptions<T> {
     /** Ref to the scrollable container element. When provided, auto-scroll
      *  activates when dragging near container edges. */
-    scrollRef?: React__default.RefObject<HTMLElement>;
+    scrollRef?: React__default.RefObject<HTMLElement | null>;
 }
 declare function useTableDragAndDrop<T extends object = object>(options: UseTableDragAndDropOptions<T>): DragAndDrop<T>;
 
@@ -11525,8 +11540,8 @@ declare const FileUploader: React__default.ForwardRefExoticComponent<FileUploade
  *
  * @param {IntersectionObserverOptions} options - The options for the
  *   IntersectionObserver.
- * @param {React.RefObject<HTMLElement>} options.ref - The ref of the target
- *   element to observe.
+ * @param {React.RefObject<HTMLElement | null>} options.ref - The ref of the
+ *   target element to observe; it is null until the element mounts.
  * @param {(entry: IntersectionObserverEntry) => void} options.onIntersect - The
  *   function to call when the target element intersects the root element.
  * @param {boolean} options.isDisabled - Whether the IntersectionObserver should
@@ -11534,14 +11549,14 @@ declare const FileUploader: React__default.ForwardRefExoticComponent<FileUploade
  * @param {number | number[]} options.threshold - The threshold(s) at which to
  *   trigger the onIntersect function.
  * @param {string} options.rootMargin - The margin around the root element.
- * @param {React.RefObject<HTMLElement>} options.root - The ref of the root
- *   element to observe.
+ * @param {React.RefObject<HTMLElement | null>} options.root - The optional
+ *   ref of the root element to observe; it may be null before that element mounts.
  */
 declare function useIntersectionObserver({ ref, onIntersect, isDisabled, threshold, rootMargin, root, }: IntersectionObserverOptions): void;
 interface IntersectionObserverOptions {
-    ref: React__default.RefObject<HTMLElement>;
+    ref: React__default.RefObject<HTMLElement | null>;
     onIntersect: (entry: IntersectionObserverEntry) => void;
-    root?: React__default.RefObject<HTMLElement>;
+    root?: React__default.RefObject<HTMLElement | null>;
     rootMargin?: string;
     threshold?: number;
     isDisabled?: boolean;
@@ -11565,8 +11580,8 @@ interface IntersectionObserverOptions {
  *   ```;
  *
  * @param {Object} options - The options object.
- * @param {React.RefObject<HTMLElement>} options.ref - The ref object that
- *   points to the observed element.
+ * @param {React.RefObject<HTMLElement | null>} options.ref - The ref object
+ *   that points to the observed element; it is null until the element mounts.
  * @param {Function} options.onResize - The callback function that is called
  *   when the element is resized.
  * @param {boolean} options.isDisabled - A flag that indicates whether the
@@ -11580,7 +11595,7 @@ declare function useResizeObserver({ ref, onResize, isDisabled, }: ResizeObserve
     } | undefined;
 };
 interface ResizeObserverOptions {
-    ref: React__default.RefObject<HTMLElement>;
+    ref: React__default.RefObject<HTMLElement | null>;
     onResize?: (entry: ResizeObserverEntry) => void;
     isDisabled?: boolean;
 }
@@ -11975,7 +11990,7 @@ declare function useLocalStorage<T>(key: string, initialValue: T): [T, SetValue<
  */
 declare function useTextSelection({ ref, onSelectionChange, onSelectionEnd, isDisabled, }: TextSelectionProps): void;
 interface TextSelectionProps {
-    ref: React__default.RefObject<HTMLElement>;
+    ref: React__default.RefObject<HTMLElement | null>;
     onSelectionChange: (selection: Selection) => void;
     onSelectionEnd?: (selection: Selection) => void;
     isDisabled?: boolean;
@@ -12047,7 +12062,7 @@ declare function useLiveInteractionModality({ ownerDocument, }: {
  */
 declare function usePreventFocus({ ref, isDisabled, }: {
     /** The ref to the element that will be prevented from receiving focus. */
-    ref: React__default.RefObject<HTMLElement>;
+    ref: React__default.RefObject<HTMLElement | null>;
     /** Whether the focus prevention is disabled. */
     isDisabled?: boolean;
 }): void;