@baseline-ui/core 3.5.0 → 3.7.0

package/dist/index.d.ts

@@ -6340,7 +6340,7 @@ declare const capitalize: (str: string) => string;
  * Without DOMParser (on the server) it only strips tags: entities are not
  * decoded, script or style content is kept, and the result is not sanitized.
  */
-declare const getPlainText: (text: string) => string;
+declare const getPlainText$1: (text: string) => string;
 
 /**
  * Checks whether a given DOM node is inside an iframe.
@@ -7098,8 +7098,6 @@ interface MenuPropsBase extends MenuPopoverProps, Omit<MenuTriggerProps, "trigge
      * @default "press"
      */
     trigger?: "press" | "longPress";
-    /** The `className` property assigned to the root element of the component. */
-    className?: string;
     /** The `className` property assigned to the content element of the component. */
     contentClassName?: string;
     /**
@@ -7635,6 +7633,8 @@ declare const IconSlider: React__default.ForwardRefExoticComponent<IconSliderPro
 interface SwitchProps extends Omit<AriaSwitchProps, "children" | "isRequired" | "validate" | "validationBehavior" | "validationState" | "isInvalid" | "aria-errormessage" | "onClick" | "onPress" | "onPressStart" | "onPressEnd" | "onPressUp" | "onPressChange">, StylingProps {
     /** The label to display next to the switch. */
     label?: React__default.ReactNode;
+    /** Helper text shown below the label and announced as its accessible description. */
+    description?: string;
     /** The position of the label. */
     labelPosition?: "top" | "left";
     /** The status label to display next to the switch. */
@@ -9600,6 +9600,10 @@ interface RichTextEditorText {
     underline?: boolean;
     color?: string;
     backgroundColor?: string;
+    /** CSS value, passed through opaquely. */
+    fontFamily?: string;
+    /** CSS value, passed through opaquely. */
+    fontSize?: string;
 }
 interface RichTextEditorLink {
     type: typeof LINK;
@@ -9619,9 +9623,16 @@ interface RichTextEditorMentionInput {
 type RichTextEditorInline = RichTextEditorText | RichTextEditorLink | RichTextEditorMention | RichTextEditorMentionInput;
 interface RichTextEditorParagraph {
     type: typeof PARAGRAPH;
+    /** CSS `text-align` value, passed through opaquely. */
+    textAlign?: string;
     children: RichTextEditorInline[];
 }
 type RichTextEditorDoc = RichTextEditorParagraph[];
+/**
+ * Returns the document as plain text, without formatting. Paragraphs are
+ * separated by `"\n"` and a mention contributes its display name.
+ */
+declare function getPlainText(doc: RichTextEditorDoc): string;
 
 interface ModelPoint {
     /** [paragraphIndex, inlineIndex within paragraph.children] */
@@ -9633,16 +9644,37 @@ interface ModelRange {
     anchor: ModelPoint;
     focus: ModelPoint;
 }
+/**
+ * Compares two points in document order: `-1` when `a` comes before `b`, `1`
+ * when it comes after, `0` when they are the same point.
+ */
+declare function comparePoints(a: ModelPoint, b: ModelPoint): -1 | 0 | 1;
+/** The point at the very start of the document. */
+declare function docStart(doc: RichTextEditorDoc): ModelPoint;
+/** The point at the very end of the document. */
+declare function docEnd(doc: RichTextEditorDoc): ModelPoint;
 
 type MarkName = "bold" | "italic" | "underline";
-/** Marks shared by all text content covered by a range. */
+/**
+ * Formatting at a selection. Over a range, `bold`, `italic` and `underline` are
+ * `true` when every covered text run has the mark, `false` when none does, and
+ * absent when the runs differ. At a collapsed caret, and with no selection,
+ * they are always `true` or `false`, and reflect marks toggled for the next
+ * typed text. A value mark is its value when every covered run shares it,
+ * absent when none has one, and `null` when the runs differ.
+ */
 interface ActiveMarks {
-    bold?: true;
-    italic?: true;
-    underline?: true;
-    color?: string;
-    backgroundColor?: string;
+    bold?: boolean;
+    italic?: boolean;
+    underline?: boolean;
+    color?: string | null;
+    backgroundColor?: string | null;
+    fontFamily?: string | null;
+    fontSize?: string | null;
 }
+type ValueMarkKey = "color" | "backgroundColor" | "fontFamily" | "fontSize";
+/** A CSS property the engine reads back from HTML and the DOM. */
+type EditorStyle = ValueMarkKey | "textAlign";
 
 /**
  * EditorCore.ts — framework-free orchestrator for the rich-text editor.
@@ -9662,6 +9694,14 @@ interface ActiveMarks {
  * - Identity-diffing: commands that return the same `doc` reference are no-ops.
  */
 
+interface SelectOptions {
+    /**
+     * Whether to focus the editor before writing the selection. Defaults to
+     * true. With false an unfocused editor stays unfocused and applies the
+     * range when it next gains focus.
+     */
+    focus?: boolean;
+}
 interface SelectionState {
     /** Active marks at the current selection (merged with pendingMarks). */
     marks: ActiveMarks;
@@ -9676,6 +9716,8 @@ interface SelectionState {
 interface EditorCoreOptions {
     /** Called after each user-visible document change; receives serialized HTML. */
     onChange?: (html: string) => void;
+    /** Called alongside `onChange` with the document model after each user-visible change. */
+    onDocChange?: (doc: RichTextEditorDoc) => void;
     /** Called when the selection changes. */
     onSelectionChange?: (state: SelectionState) => void;
     /**
@@ -9707,6 +9749,34 @@ interface EditorCoreOptions {
      * selection). Defaults to enabled.
      */
     autoLink?: () => boolean;
+    /**
+     * Runs on a paste after the target, read-only and composition guards. A
+     * returned doc is inserted at the caret as a fragment; `null` swallows the
+     * paste; `undefined` falls through to the built-in paste pipeline. A throw
+     * swallows the paste and is rethrown asynchronously.
+     */
+    onPaste?: (event: ClipboardEvent) => RichTextEditorDoc | null | undefined;
+    /**
+     * Runs on `copy` and `cut` with the fragment the selection covers, or an
+     * empty document when the selection is collapsed. Return true after writing
+     * the clipboard: the engine then calls `preventDefault()` and, for `cut` with
+     * a selection, deletes it.
+     */
+    onCopy?: (event: ClipboardEvent, fragment: RichTextEditorDoc) => boolean;
+    /**
+     * Maximum document length, counted as `docLength` counts it. Typing, pasting,
+     * soft breaks and IME input stop at the limit; a selection being replaced
+     * counts as free space. Undefined means unlimited.
+     */
+    maxLength?: () => number | undefined;
+    /**
+     * The CSS properties read from HTML the engine parses: `setValue`. A style
+     * missing here is dropped from that HTML. The DOM the engine renders itself
+     * is always read back in full after native input, and pasted and dropped
+     * HTML always reads only `color` and `backgroundColor`; use `onPaste` to
+     * bring in more. Undefined means `color` and `backgroundColor`.
+     */
+    htmlStyles?: () => readonly EditorStyle[] | undefined;
     /** When this returns true all mutation inputs are blocked (preventDefault'd). */
     isReadOnly?: () => boolean;
     /**
@@ -9717,13 +9787,20 @@ interface EditorCoreOptions {
      * leaving a consumer free to wire their own. Defaults to enabled.
      */
     areKeyboardShortcutsEnabled?: () => boolean;
+    /**
+     * Whether Enter splits the paragraph instead of inserting a soft break.
+     * Shift+Enter always inserts a soft break.
+     *
+     * @default false
+     */
+    enterInsertsParagraph?: () => boolean;
 }
 /** Names of commands that EditorCore can dispatch via exec(). */
-type CommandName = "toggleMark" | "setMarkValue" | "wrapLink" | "updateLinkUrl" | "unwrapLink" | "deleteRange" | "insertText" | "insertFragment" | "insertSoftBreak" | "insertMentionInput" | "confirmMention" | "removeMentionInput";
+type CommandName = "toggleMark" | "setMarkValue" | "wrapLink" | "updateLinkUrl" | "unwrapLink" | "deleteRange" | "insertText" | "insertFragment" | "insertSoftBreak" | "insertParagraph" | "insertMentionInput" | "confirmMention" | "removeMentionInput";
 /** Argument tuple for each command (beyond doc + range which are implicit). */
 interface CommandArgs {
     toggleMark: [mark: MarkName];
-    setMarkValue: [key: "color" | "backgroundColor", value?: string];
+    setMarkValue: [key: ValueMarkKey, value?: string];
     wrapLink: [url: string];
     updateLinkUrl: [url: string];
     unwrapLink: [];
@@ -9731,6 +9808,7 @@ interface CommandArgs {
     insertText: [text: string];
     insertFragment: [fragment: RichTextEditorDoc];
     insertSoftBreak: [];
+    insertParagraph: [];
     insertMentionInput: [];
     confirmMention: [user: {
         id: string;
@@ -9752,33 +9830,12 @@ declare class EditorCore {
      * editor's own edits, so re-sending an unchanged `value` still reverts it.
      */
     private lastAppliedValue;
-    private cachedRange;
-    /**
-     * A doc replacement landed while the editor was unfocused, so `cachedRange`
-     * was never written to the DOM. Replayed by the focus handler.
-     */
-    private needsSelectionRestore;
+    /** Doc last applied by {@link setDoc}; cleared on own edits like `lastAppliedValue`. */
+    private lastAppliedDoc;
+    private readonly selection;
     private composing;
-    private pending;
-    /**
-     * Number of upcoming selectionchange events that must NOT clear pending marks.
-     *
-     * handleSelectionChange normally clears pending the moment the caret leaves
-     * pending.caretOffset. But a single user keystroke (and insertSoftBreak)
-     * triggers our own writeSelection, which the browser reports back as one or
-     * more selectionchange events — and in shadow DOM (notably Chromium and
-     * Firefox) one of those can arrive with the post-keystroke caret offset before
-     * syncFromDom has updated pending.caretOffset to match. Without this guard,
-     * that transient mismatch clears pending mid-typing, the toolbar flips off,
-     * and the next character is no longer colored. We absorb a small burst of
-     * these self-inflicted events (a single boolean is not enough — shadow DOM can
-     * emit several per action) and re-sync caretOffset to the real caret as they
-     * arrive, so a genuine later caret move still clears pending correctly.
-     *
-     * Confirmed load-bearing: removing it makes the shadow-DOM "color buttons stay
-     * active while typing" CT flake/time out in Chromium.
-     */
-    private preservePendingSelectionChanges;
+    private enterHasShift;
+    private readonly pendingMarks;
     private history;
     private opts;
     private el;
@@ -9798,19 +9855,18 @@ declare class EditorCore {
     attach(el: HTMLElement): () => void;
     private readonly handleBeforeInputBound;
     private readonly handleInputBound;
+    private isClipboardTargetInEditor;
     private readonly handlePasteBound;
+    private readonly handleCopyBound;
+    private readonly handleKeyDownBound;
+    private readonly handleDocumentKeyDownBound;
     private readonly handlePointerDownBound;
     private readonly handleFocusBound;
     private readonly handleCompositionStartBound;
     private readonly handleCompositionEndBound;
     private readonly handleSelectionChangeBound;
-    /**
-     * Synchronously refreshes cachedRange from the live DOM selection when that
-     * selection is inside the editor. Leaves cachedRange untouched when the
-     * selection is elsewhere (dialogs, toolbar popovers) or unreadable.
-     */
-    private refreshSelectionFromDom;
-    getDoc(): RichTextEditorDoc;
+    /** The full document, or the normalized fragment `range` covers. */
+    getDoc(range?: ModelRange): RichTextEditorDoc;
     getValue(): string;
     /**
      * Sets the document from an HTML string (controlled entry point).
@@ -9823,53 +9879,89 @@ declare class EditorCore {
     setValue(html: string, opts?: {
         emit?: boolean;
     }): void;
+    /**
+     * Sets the document from a model (controlled entry point), the counterpart of
+     * {@link setValue}: normalizes, keeps the caret offset, records no history and
+     * emits only with `emit: true`.
+     *
+     * SKIPS (no-op) when `doc` is the current document, the object last applied
+     * here, or has the same content as the current document.
+     */
+    setDoc(doc: RichTextEditorDoc, opts?: {
+        emit?: boolean;
+    }): void;
+    private replaceDoc;
     private static docHasMentionInput;
     /**
      * Dispatches a named command at the current selection.
      *
      * Identity-diff: if the command returns the same `doc` reference (no-op),
-     * nothing changes — except for `toggleMark` on a collapsed selection, which
-     * sets pendingMarks and emits onSelectionChange.
+     * nothing changes — except for `toggleMark` and `setMarkValue` on a collapsed
+     * selection, which set pendingMarks and emit onSelectionChange.
      */
     exec<K extends CommandName>(name: K, ...args: CommandArgs[K]): void;
+    /** `args` cut to what fits under maxLength, or null when nothing does. */
+    private fitToCapacity;
+    private maxLength;
+    private clampToMaxLength;
+    /**
+     * Where text inserted over the last known range ends in `read`; the fallback
+     * when the DOM caret cannot be read.
+     */
+    private insertionEnd;
+    /** Characters that can still be inserted over `range`; undefined when unlimited. */
+    private capacity;
     undo(): void;
     redo(): void;
     canUndo(): boolean;
     canRedo(): boolean;
     focus(): void;
-    private hasFocus;
     setCaretPosition(absoluteOffset: number): void;
     /**
      * Restores a model selection: focuses the editor and writes the range to
-     * both the DOM and cachedRange. Used by toolbar popovers (e.g. the color
+     * both the DOM and the editor selection. Used by toolbar popovers (e.g. the color
      * picker) that captured the selection before taking focus — on Firefox,
      * refocusing a contenteditable collapses its DOM selection, so the range
      * must be re-applied explicitly before dispatching a command.
+     *
+     * With `focus: false` an unfocused editor keeps focus where it is: the
+     * range scopes the next command and is written to the DOM when the editor
+     * regains focus. A toolbar input that formats the whole document on Enter
+     * relies on this, since focusing the editor during the keydown would let
+     * the key's default action insert a paragraph.
      */
-    select(range: ModelRange): void;
+    select(range: ModelRange, options?: SelectOptions): void;
     selectStart(): void;
     selectEnd(): void;
+    /** Selects the whole document. */
+    selectAll(options?: SelectOptions): void;
+    /**
+     * The selection state computed now, from the live DOM selection when it is
+     * inside the editor and otherwise from the last known range.
+     */
     getSelectionState(): SelectionState;
     private buildSelectionState;
-    private mergePendingMarks;
+    private notifyChange;
+    private emitSelectionChange;
     /**
-     * Toggle a pending boolean mark for the collapsed-caret case.
-     *
-     * We store the FULL effective marks snapshot (base + toggle) so that
-     * applyPendingMarks can apply them directly to the just-typed range.
-     * Toggling the same mark a second time returns to the base state.
+     * Every document change ends here: applies the doc and range, renders,
+     * places the selection and notifies consumers, per `source`.
      */
-    private setPendingMark;
+    private commit;
     /**
-     * Set or clear a pending color/backgroundColor mark for the collapsed-caret case.
-     * `value === undefined` removes that key from the pending snapshot.
+     * Native typing at the limit would insert at the caret and then lose its tail
+     * when syncFromDom cuts from the document's end; insert the part that fits
+     * through the model instead. Returns whether it handled the event.
      */
-    private setPendingColorMark;
-    private emitSelectionChange;
+    private insertOverflowingText;
+    private handleNativeInsert;
     /**
-     * Applies a doc+range change, re-renders if attached, emits events.
+     * Spellcheck and autocorrect replace a word natively, which can drop the
+     * replaced run's marks; replaces it through the model instead. Returns
+     * whether it handled the event.
      */
-    private applyDocChange;
+    private replaceTargetText;
+    private breakCommand;
     private handleBeforeInput;
     /**
      * Returns true when the current caret position is preceded by a word boundary
@@ -9877,6 +9969,7 @@ declare class EditorCore {
      */
     private shouldTriggerMention;
     private lastCharOf;
+    private allowedStyles;
     private autoLinkEnabled;
     /**
      * Gates {@link findAutoLinkBeforeCaret} on the feature being enabled and no
@@ -9897,7 +9990,8 @@ declare class EditorCore {
      * Wraps a previously-detected token span (absolute offsets in the CURRENT
      * doc) in a link, recording its own history entry and leaving the caret where
      * it is (wrapLink is length-preserving). Called right after the delimiter that
-     * triggered the conversion has been inserted.
+     * triggered the conversion has been inserted; does nothing when that insert
+     * was refused and left the document at `docBefore`.
      */
     private applyAutoLink;
     private handlePasteInput;
@@ -9908,24 +10002,9 @@ declare class EditorCore {
      * back into a model doc and reconciles with internal state.
      */
     private syncFromDom;
-    /**
-     * Apply pending marks to the text that was just typed.
-     *
-     * The just-typed range is determined by diffing the pre-input caret absolute
-     * offset against the post-input caret absolute offset.
-     */
-    private applyPendingMarks;
-    /**
-     * Applies the pending mark snapshot to the [preOffset, postOffset] range,
-     * re-deriving the range from absolute offsets before each command (commands
-     * may split nodes and stale a ModelRange). Returns the resulting doc by
-     * identity when no mark changed.
-     */
-    private applyPendingMarkSnapshot;
     private handleSelectionChange;
     private dispatchCommand;
     private collapsedAtDocEnd;
-    private rangesEqual;
 }
 
 /**
@@ -9969,23 +10048,63 @@ interface EditorState {
     redo: EditorCore["redo"];
     getValue: EditorCore["getValue"];
     setValue: EditorCore["setValue"];
+    getDoc: EditorCore["getDoc"];
+    setDoc: EditorCore["setDoc"];
+    selectAll: EditorCore["selectAll"];
+    /**
+     * Selects `range`, focusing the editor first unless `options.focus` is
+     * false. Does nothing until the editor is attached to an element.
+     */
+    select: EditorCore["select"];
+    /**
+     * The selection state computed now. Unlike the reactive
+     * {@link selectionState}, which updates on the next render, this reflects a
+     * selection made in the same tick, for example right after {@link select}.
+     */
+    getSelectionState: EditorCore["getSelectionState"];
     exec: EditorCore["exec"];
     /** Whether `mark` is active at the current selection. */
     isMarkActive: (mark: MarkName) => boolean;
     /** Toggle a boolean mark (bold/italic/underline). */
     toggleMark: (mark: MarkName) => void;
-    /** Set or clear a color mark; omit `value` to clear. */
-    setMark: (key: "color" | "backgroundColor", value?: string) => void;
+    /** Set or clear a value mark (color or font); omit `value` to clear. */
+    setMark: (key: ValueMarkKey, value?: string) => void;
 }
 /**
  * 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" | "resolveMention" | "isReadOnly"> {
+interface UseEditorOptions extends Pick<EditorCoreOptions, "onChange" | "onDocChange" | "onPaste" | "onCopy" | "onSelectionChange" | "onMentionTrigger" | "onMentionInputRemoved" | "canStartMention" | "resolveMention" | "isReadOnly"> {
     /** Controlled value (provide with `onChange`). */
     value?: string;
     /** Initial value for uncontrolled use (applied once on mount). */
     defaultValue?: string;
+    /**
+     * Controlled document model (provide with `onDocChange`). Throws when
+     * combined with `value`, `defaultValue` or `defaultDoc`.
+     */
+    doc?: RichTextEditorDoc;
+    /** Initial document model for uncontrolled use (applied once on mount). */
+    defaultDoc?: RichTextEditorDoc;
+    /**
+     * Maximum document length, counted as `docLength` counts it (a paragraph
+     * separator is one character). Typing, pasting, soft breaks and IME input
+     * stop at the limit; replacing a selection frees its characters. Must be a
+     * finite integer of at least 0; anything else throws.
+     */
+    maxLength?: number;
+    /**
+     * The CSS properties the editor keeps when it parses `value`,
+     * `defaultValue` and `setValue` HTML. Font marks and paragraph `textAlign`
+     * in that HTML survive only when listed. Everything else is unaffected: a
+     * `doc`/`defaultDoc`, marks set with `setMark` and text typed or edited
+     * natively keep every style the document carries. Pasted and dropped HTML
+     * always keeps only `color` and `backgroundColor`, since HTML from other
+     * apps carries their fonts and sizes; use `onPaste` to bring in more.
+     *
+     * @default ["color", "backgroundColor"]
+     */
+    htmlStyles?: readonly EditorStyle[];
     /** When true, the editor is read-only and selection is cleared. */
     isDisabled?: boolean;
     /**
@@ -10002,6 +10121,13 @@ interface UseEditorOptions extends Pick<EditorCoreOptions, "onChange" | "onSelec
      * @default true
      */
     autoLink?: boolean;
+    /**
+     * Whether Enter splits the paragraph instead of inserting a soft break.
+     * Shift+Enter always inserts a soft break.
+     *
+     * @default false
+     */
+    enterInsertsParagraph?: boolean;
 }
 
 /**
@@ -10043,6 +10169,8 @@ interface EditableProps {
     suppressContentEditableWarning: true;
     role: "textbox";
     "aria-multiline": true;
+    /** Marks the editable root for styling and querying the rendered content. */
+    "data-editor-root": "true";
     onKeyDown?: KeyboardEventHandler;
     onKeyUp?: KeyboardEventHandler;
 }
@@ -10360,7 +10488,7 @@ interface ImageGalleryProps extends StylingProps, Omit<UNSAFE_ListBoxProps, "ite
     /**
      * The aspect ratio of the images.
      *
-     * @default 16 / 9
+     * @default 3 / 4
      */
     aspectRatio?: number;
     /**
@@ -10397,11 +10525,12 @@ interface ImageGalleryProps extends StylingProps, Omit<UNSAFE_ListBoxProps, "ite
         isSelected: boolean;
     }) => Dimension);
     /**
-     * The title of the delete confirmation modal.
+     * The title of the delete confirmation modal. A function receives the keys
+     * about to be deleted, or `"all"` when the delete comes from Select All.
      *
      * @default "Are you sure you want to delete this item?"
      */
-    deleteConfirmationTitle?: string | ((selectedKeys: Selection$1) => string);
+    deleteConfirmationTitle?: string | ((keys: Selection$1) => string);
     /**
      * Overrides the label of the button that permanently deletes the selected
      * image(s), and the accessible label of each image's individual delete
@@ -10666,9 +10795,14 @@ type GridListProps = Omit<StylingProps & ListProps<ListOption> & AriaGridListOpt
         };
     }, ref: React__default.Ref<HTMLLIElement>) => React__default.JSX.Element;
     /**
-     * Enables editing mode which disables keydown event capturing, useful
-     * when you may want the internal `GridList` from taking away focus from
-     * child input due to type-ahead
+     * Enables editing mode for an inline input inside a row. While editing,
+     * the grid's own keyboard handling skips every key except Enter and
+     * Escape, so type-ahead and arrow, Home, End, PageUp and PageDown
+     * navigation do not move focus out of the input. Keys still reach the
+     * input's own handlers. They also reach `onKeyDown` handlers on
+     * ancestors and document-level listeners, except an Enter or Escape the
+     * grid acts on, such as Enter selecting the row or Escape clearing the
+     * selection.
      *
      * @default false
      */
@@ -11160,11 +11294,23 @@ declare const DeviceProviderContext: React__default.Context<{
 }>;
 declare const DeviceProvider: React__default.FC<DeviceProviderProps>;
 
-interface TaggedPaginationProps extends StylingProps, Pick<PaginationProps, "isDisabled" | "decrementAriaLabel" | "incrementAriaLabel">, Pick<AriaTextFieldOptions<"input">, "onBlur" | "onKeyDown" | "isDisabled" | "isReadOnly" | "label"> {
-    /** Whether the decrement button is disabled. */
+interface TaggedPaginationProps extends StylingProps, Pick<PaginationProps, "isDisabled">, Pick<AriaTextFieldOptions<"input">, "onBlur" | "onKeyDown" | "isDisabled" | "isReadOnly" | "label"> {
+    /** Whether the decrement button and ArrowDown are disabled. */
     isDecrementButtonDisabled?: boolean;
-    /** Whether the increment button is disabled. */
+    /** Whether the increment button and ArrowUp are disabled. */
     isIncrementButtonDisabled?: boolean;
+    /**
+     * The accessible name and tooltip of the decrement button.
+     *
+     * @default "Previous Page"
+     */
+    decrementAriaLabel?: string;
+    /**
+     * The accessible name and tooltip of the increment button.
+     *
+     * @default "Next Page"
+     */
+    incrementAriaLabel?: string;
     /**
      * Determines the size of the component.
      *
@@ -11173,12 +11319,16 @@ interface TaggedPaginationProps extends StylingProps, Pick<PaginationProps, "isD
     size?: "xs" | "sm" | "md";
     /** The label for the component. */
     label?: React__default.ReactNode;
-    /** The aria-label for the description. */
+    /**
+     * The aria-label for the description.
+     *
+     * @deprecated Has no effect.
+     */
     descriptionAriaLabel?: string;
     /**
      * The type of the input field.
      *
-     * @default "number"
+     * @default "text"
      */
     type?: "number" | "text";
     /** The minimum value of the component. */
@@ -11769,6 +11919,66 @@ interface FileUploaderProps extends Omit<StylingProps, keyof BlockProps> {
 
 declare const FileUploader: React__default.ForwardRefExoticComponent<FileUploaderProps & React__default.RefAttributes<HTMLDivElement>>;
 
+interface BreadcrumbsProps extends Omit<StylingProps, keyof BlockProps>, AriaLabelingProps {
+    /** The `id` of the root element. */
+    id?: string;
+    /** The `Breadcrumb` items to render, from the root to the current page. */
+    children: React__default.ReactNode;
+    /** Handler that is called with the `id` of a breadcrumb when it is pressed. */
+    onAction?: (key: Key) => void;
+    /**
+     * The `id`s of the breadcrumbs that are disabled. Only the link is disabled:
+     * unlike `isDisabled`, the list item gets no `data-disabled` attribute.
+     */
+    disabledKeys?: Iterable<Key>;
+    /**
+     * Whether every breadcrumb is disabled.
+     *
+     * @default false
+     */
+    isDisabled?: boolean;
+    /**
+     * The element rendered between breadcrumbs. It is hidden from assistive
+     * technology. Pass `null`, `false` or `""` to render no separator.
+     *
+     * @default A caret icon pointing toward the current page
+     */
+    separator?: React__default.ReactNode;
+}
+interface BreadcrumbProps extends Omit<StylingProps, keyof BlockProps> {
+    /**
+     * A unique id for the breadcrumb, passed to `onAction` when its link is
+     * pressed.
+     */
+    id: Key;
+    /** The text of the breadcrumb. */
+    label?: string;
+    /**
+     * A URL that the breadcrumb links to, rendering it as a real link. The
+     * current and disabled breadcrumbs are not rendered as links.
+     */
+    href?: string;
+    /** An icon rendered before the label. */
+    icon?: React__default.FC<IconProps>;
+    /**
+     * The accessible name of the breadcrumb. Required for an icon-only
+     * breadcrumb, which has no `label`.
+     */
+    "aria-label"?: string;
+    /**
+     * Custom content that replaces the breadcrumb link, such as a `Select` or a
+     * `Menu`. It is rendered as is, so `label`, `icon`, `aria-label` and `href`
+     * are ignored, `onAction` is not called for it, and the content stays
+     * interactive when it is the last breadcrumb. It does not receive
+     * `disabledKeys`, `isDisabled` or the current-page marking, so handle those
+     * in the content itself.
+     */
+    children?: React__default.ReactNode;
+}
+
+declare const Breadcrumbs: React__default.ForwardRefExoticComponent<BreadcrumbsProps & React__default.RefAttributes<HTMLElement>>;
+declare const Breadcrumb: React__default.ForwardRefExoticComponent<BreadcrumbProps & React__default.RefAttributes<HTMLLIElement>>;
+
 /**
  * A hook that creates an IntersectionObserver and observes a target element.
  *
@@ -11955,7 +12165,7 @@ declare function useIsFirstRender(): boolean;
  *   const uncovered = messageIds.filter((id) => !(id in ourCatalog.en));
  *   ```;
  */
-declare const messageIds: readonly ["bui.alertDialog.close", "bui.audioPlayer.audioTimeline", "bui.audioPlayer.pause", "bui.audioPlayer.play", "bui.buttonSelect.more", "bui.buttonSelect.moreWithLabel", "bui.calendar.nextMonth", "bui.calendar.nextYear", "bui.calendar.previousMonth", "bui.calendar.previousYear", "bui.calendar.selectMonth", "bui.calendar.selectYear", "bui.colorInput.add", "bui.colorInput.addColor", "bui.colorInput.cancel", "bui.colorInput.colorFormat", "bui.colorInput.colorPresets", "bui.colorInput.customColors", "bui.colorInput.indeterminate", "bui.colorInput.newColor", "bui.colorInput.noColor", "bui.colorInput.removeColor", "bui.colorInput.transparent", "bui.colorSwatch.none", "bui.dateField.openCalendar", "bui.drawer.close", "bui.editor.action", "bui.editor.addLink", "bui.editor.backgroundColor", "bui.editor.bold", "bui.editor.cancel", "bui.editor.close", "bui.editor.copy", "bui.editor.cut", "bui.editor.editLink", "bui.editor.fontColor", "bui.editor.help", "bui.editor.italic", "bui.editor.linkAnnotation", "bui.editor.mention", "bui.editor.openHelpDialog", "bui.editor.paste", "bui.editor.redo", "bui.editor.removeLink", "bui.editor.save", "bui.editor.selectAll", "bui.editor.shortcut", "bui.editor.submit", "bui.editor.toolbarFocus", "bui.editor.underline", "bui.editor.undo", "bui.fileList.loading", "bui.fileList.removeHint", "bui.freehandCanvas.redo", "bui.freehandCanvas.undo", "bui.imageDropZone.selectImage", "bui.imageGallery.cancel", "bui.imageGallery.delete", "bui.imageGallery.loading", "bui.inlineAlert.close", "bui.pagination.goToPage", "bui.pagination.nextPage", "bui.pagination.pageXofY", "bui.pagination.prevPage", "bui.select.clear", "bui.select.more", "bui.select.search", "bui.select.selectAll", "bui.stepper.completed", "bui.stepper.label", "bui.stepper.step", "bui.table.loading", "bui.tag.remove", "bui.toolbar.more", "bui.treeView.collapse", "bui.treeView.expand", "bui.treeView.rename", "bui.useMedia.paused", "bui.useMedia.playing"];
+declare const messageIds: readonly ["bui.alertDialog.close", "bui.audioPlayer.audioTimeline", "bui.audioPlayer.pause", "bui.audioPlayer.play", "bui.buttonSelect.more", "bui.buttonSelect.moreWithLabel", "bui.calendar.nextMonth", "bui.calendar.nextYear", "bui.calendar.previousMonth", "bui.calendar.previousYear", "bui.calendar.selectMonth", "bui.calendar.selectYear", "bui.colorInput.add", "bui.colorInput.addColor", "bui.colorInput.cancel", "bui.colorInput.colorFormat", "bui.colorInput.colorPresets", "bui.colorInput.customColors", "bui.colorInput.indeterminate", "bui.colorInput.newColor", "bui.colorInput.noColor", "bui.colorInput.removeColor", "bui.colorInput.transparent", "bui.colorSwatch.none", "bui.dateField.openCalendar", "bui.drawer.close", "bui.editor.action", "bui.editor.addLink", "bui.editor.backgroundColor", "bui.editor.bold", "bui.editor.cancel", "bui.editor.close", "bui.editor.copy", "bui.editor.cut", "bui.editor.editLink", "bui.editor.fontColor", "bui.editor.help", "bui.editor.italic", "bui.editor.linkAnnotation", "bui.editor.mention", "bui.editor.openHelpDialog", "bui.editor.paste", "bui.editor.redo", "bui.editor.removeLink", "bui.editor.save", "bui.editor.selectAll", "bui.editor.shortcut", "bui.editor.submit", "bui.editor.toolbarFocus", "bui.editor.underline", "bui.editor.undo", "bui.fileList.loading", "bui.fileList.removeHint", "bui.freehandCanvas.redo", "bui.freehandCanvas.undo", "bui.imageDropZone.selectImage", "bui.imageGallery.cancel", "bui.imageGallery.delete", "bui.imageGallery.loading", "bui.inlineAlert.close", "bui.pagination.goToPage", "bui.pagination.nextPage", "bui.pagination.pageXofY", "bui.pagination.prevPage", "bui.select.clear", "bui.select.more", "bui.select.search", "bui.select.selectAll", "bui.stepper.completed", "bui.stepper.label", "bui.stepper.step", "bui.table.loading", "bui.tag.remove", "bui.taggedPagination.nextPage", "bui.taggedPagination.prevPage", "bui.toolbar.more", "bui.treeView.collapse", "bui.treeView.expand", "bui.treeView.rename", "bui.useMedia.paused", "bui.useMedia.playing"];
 type MessageId = (typeof messageIds)[number];
 /**
  * Maps each deprecated bare id — the last dot-segment of a namespaced id — to
@@ -12385,5 +12595,5 @@ declare namespace reactStately {
   export type { reactStately_Color as Color, reactStately_ListData as ListData, reactStately_TreeData as TreeData };
 }
 
-export { Accordion, AccordionItem, ActionButton, ActionGroup, ActionGroupItem, ActionIconButton, Actionable, AlertDialog, AudioPlayer, Autocomplete, Avatar, Box, ButtonSelect, Calendar, Cell, Checkbox, Code, ColorInput, ColorSwatch, ColorSwatchPicker, Column, ComboBox, DateField, DateFormat, DefaultListOption, DeviceProvider, DeviceProviderContext, Dialog, DialogTitle, Disclosure, DomNodeRenderer, Drawer, EMPTY_SELECTION_STATE, Editor, EditorCore, EditorProvider, FileInput, FileList$1 as FileList, FileUploader, FocusScope, Focusable, FrameProvider, FreehandCanvas, GlobalToastRegion, GridLayout, GridList, Group, I18nProvider, Icon, IconColorInput, IconColorInputButton, IconSelect, IconSlider, ImageDropZone, ImageGallery, InlineAlert, Kbd, Link, ListBox, ListLayout, LocaleAwareGridLayout, Markdown, Menu, MessageFormat, Modal, ModalClose, ModalContent, ModalTrigger, NumberFormat, NumberInput, Pagination, Panel, PanelGroup, PanelResizeHandle, PointPicker, PointPickerContent, PointPickerDisplay, Popover, PopoverContent, PopoverTrigger, Portal, PortalContainerProvider, Pressable, Preview, ProgressBar, ProgressSpinner, REACT_ARIA_INCOMPATIBLE_KEYS, RadioGroup, RangeCalendar, Reaction, Row, ScrollControlButton, SearchInput, Select, Separator, Size, Skeleton, Slider, StatusCard, Stepper, Switch, TabItem, Table, TableBody, TableHeader, TableLayout, Tabs, Tag, TagGroup, TaggedPagination, Text, TextInput, ThemeProvider, TimeField, ToastQueue, ToggleButton, ToggleIconButton, Toolbar, Tooltip, TreeView, UNSAFE_ListBox, reactAria as UNSAFE_aria, reactStately as UNSAFE_stately, VIRTUALIZER_LAYOUT_DEFAULT_OPTIONS, Virtualizer, VisuallyHidden, WaterfallLayout, announce, areColorsEqual, booleanOrObjectToConfig, calculateFontSizeToFitWidth, capitalize, clamp, classNames, cleanKeyFromGlobImport, clearAnnouncer, createMessageFormatter, defineMessages, destroyAnnouncer, devWarnOnce, directionVar, disableAnimations, enableAnimations, filterDOMProps, filterTruthyValues, findFocusableElements, getAbsoluteBounds, getAbsolutePosition, getActiveElement, getHTMLElement, getOsSpecificKeyboardShortcutLabel, getOwnerDocument, getPlainText, getSvgPathFromStroke, getTextDimensions, handleEditorShortcut, iconMap, invariant, isFocusableElement, isInIframe, isInShadowDOM, isInputThatOpensKeyboard, isInsideOverlayContent, isRect, isUrl, legacyMessageIdMap, lightenColor, mergeProps, mergeRefs, messageIds, onDropOrPaste, parseColor, safeSpreadProps, useCollator, useDateFormatter, useDevice, useDragAndDrop, useEditable, useEditor, useEditorContext, useFilter, useFocusRing, useFocusVisible, useFrameDimensions, useI18n, useId, useImage, useInteractionModality, useIntersectionObserver, useIsFirstRender, useKeyboard, useListData, useLiveInteractionModality, useLocalStorage, useLocale, useMutationObserver, useNumberFormatter, useObjectRef, usePointProximity, usePortalContainer, usePreventFocus, useResizeObserver, useTableDragAndDrop, useTextSelection, useUndoRedo, useUserPreferences };
-export type { AccordionItemProps, AccordionProps, ActionButtonProps, ActionGroupProps, ActionIconButtonProps, ActionableProps, ActiveMarks, AlertDialogProps, AudioPlayerProps, AutocompleteProps, AvatarProps, BlockProps, BoundaryAxis, BoxProps, ButtonSelectProps, CalendarHeaderVariant, CalendarProps, CalendarSize, CellProps, CheckboxProps, CodeProps, ColorInputProps, ColorPreset, ColorSwatchPickerProps, ColorSwatchProps, ColumnProps, ComboBoxProps, CommandArgs, CommandName, CreateMessageFormatterOptions, DateFieldPickerType, DateFieldProps, DateFormatProps, Device, DeviceProviderProps, DialogProps, DialogTitleProps, DisclosureProps, DomNodeRendererProps, DrawerProps, EditableProps, EditorCoreOptions, EditorHandle, EditorProps, EditorProviderProps, EditorState, FileInputProps, FileListItem, FileListProps, FileUploaderProps, FocusableProps, FrameProviderProps, FreehandCanvasProps, GridListProps, GroupProps, HorizontalBoundaryBehavior, I18nProviderProps, I18nResult, IconColorInputProps, IconComponentProps$1 as IconComponentProps, IconProps, IconSelectProps, IconSliderProps, ImageDropZoneProps, ImageGalleryProps, ImperativePanelGroupHandle, ImperativePanelHandle, InlineAlertProps, IntersectionObserverOptions, KbdProps, Key, LinkProps, ListBoxProps, ListHandle$1 as ListHandle, ListOption, MarkName, MarkdownProps, MenuItem, MenuProps, MessageDescriptor, MessageFormatProps, MessageFormatter, MessageId, MessageIssue, MessageIssueCode, ModalContentProps, ModalProps, ModelPoint, ModelRange, NumberFormatProps, NumberInputProps, PaginationProps, PanelGroupProps, PanelProps, PanelResizeHandleProps, PointPickerContentProps, PointPickerDisplayProps, PointPickerProps, PopoverContentHandle, PopoverContentProps, PopoverProps, PopoverTriggerProps, PortalProps, PressEvent, PreviewProps, ProgressBarProps, ProgressSpinnerProps, RadioGroupProps, RangeCalendarProps, ReactAriaIncompatibleKey, ReactionProps, Rect, ResizeObserverOptions, RichTextEditorDoc, RichTextEditorInline, RichTextEditorLink, RichTextEditorMention, RichTextEditorMentionInput, RichTextEditorParagraph, RichTextEditorText, RowProps, SVGRProps, SafeDOMAttributes, ScrollControlButtonProps, SearchInputProps, SelectProps, SelectionState, SeparatorProps, SetValue, SkeletonProps, SliderProps, StatusCardProps, StepperItem, StepperProps, StylingProps, SwitchProps, TabItemProps, TableBodyProps, TableHeaderProps, TableProps, TabsProps, TagGroupProps, TagProps, TagVariant, TaggedPaginationProps, TextInputProps, TextProps, TextSelectionProps, ThemeProviderProps, TimeFieldProps, ToastProps, ToggleButtonProps, ToggleIconButtonProps, ToolbarProps, TooltipProps, TreeItemRenderState, TreeListItem, TreeViewProps, UNSAFE_ListBoxProps, UseEditableOptions, UseEditorOptions, UseTableDragAndDropOptions, VirtualizerProps };
+export { Accordion, AccordionItem, ActionButton, ActionGroup, ActionGroupItem, ActionIconButton, Actionable, AlertDialog, AudioPlayer, Autocomplete, Avatar, Box, Breadcrumb, Breadcrumbs, ButtonSelect, Calendar, Cell, Checkbox, Code, ColorInput, ColorSwatch, ColorSwatchPicker, Column, ComboBox, DateField, DateFormat, DefaultListOption, DeviceProvider, DeviceProviderContext, Dialog, DialogTitle, Disclosure, DomNodeRenderer, Drawer, EMPTY_SELECTION_STATE, Editor, EditorCore, EditorProvider, FileInput, FileList$1 as FileList, FileUploader, FocusScope, Focusable, FrameProvider, FreehandCanvas, GlobalToastRegion, GridLayout, GridList, Group, I18nProvider, Icon, IconColorInput, IconColorInputButton, IconSelect, IconSlider, ImageDropZone, ImageGallery, InlineAlert, Kbd, Link, ListBox, ListLayout, LocaleAwareGridLayout, Markdown, Menu, MessageFormat, Modal, ModalClose, ModalContent, ModalTrigger, NumberFormat, NumberInput, Pagination, Panel, PanelGroup, PanelResizeHandle, PointPicker, PointPickerContent, PointPickerDisplay, Popover, PopoverContent, PopoverTrigger, Portal, PortalContainerProvider, Pressable, Preview, ProgressBar, ProgressSpinner, REACT_ARIA_INCOMPATIBLE_KEYS, RadioGroup, RangeCalendar, Reaction, Row, ScrollControlButton, SearchInput, Select, Separator, Size, Skeleton, Slider, StatusCard, Stepper, Switch, TabItem, Table, TableBody, TableHeader, TableLayout, Tabs, Tag, TagGroup, TaggedPagination, Text, TextInput, ThemeProvider, TimeField, ToastQueue, ToggleButton, ToggleIconButton, Toolbar, Tooltip, TreeView, UNSAFE_ListBox, reactAria as UNSAFE_aria, reactStately as UNSAFE_stately, VIRTUALIZER_LAYOUT_DEFAULT_OPTIONS, Virtualizer, VisuallyHidden, WaterfallLayout, announce, areColorsEqual, booleanOrObjectToConfig, calculateFontSizeToFitWidth, capitalize, clamp, classNames, cleanKeyFromGlobImport, clearAnnouncer, comparePoints, createMessageFormatter, defineMessages, destroyAnnouncer, devWarnOnce, directionVar, disableAnimations, docEnd, docStart, enableAnimations, filterDOMProps, filterTruthyValues, findFocusableElements, getAbsoluteBounds, getAbsolutePosition, getActiveElement, getPlainText as getDocPlainText, getHTMLElement, getOsSpecificKeyboardShortcutLabel, getOwnerDocument, getPlainText$1 as getPlainText, getSvgPathFromStroke, getTextDimensions, handleEditorShortcut, iconMap, invariant, isFocusableElement, isInIframe, isInShadowDOM, isInputThatOpensKeyboard, isInsideOverlayContent, isRect, isUrl, legacyMessageIdMap, lightenColor, mergeProps, mergeRefs, messageIds, onDropOrPaste, parseColor, safeSpreadProps, useCollator, useDateFormatter, useDevice, useDragAndDrop, useEditable, useEditor, useEditorContext, useFilter, useFocusRing, useFocusVisible, useFrameDimensions, useI18n, useId, useImage, useInteractionModality, useIntersectionObserver, useIsFirstRender, useKeyboard, useListData, useLiveInteractionModality, useLocalStorage, useLocale, useMutationObserver, useNumberFormatter, useObjectRef, usePointProximity, usePortalContainer, usePreventFocus, useResizeObserver, useTableDragAndDrop, useTextSelection, useUndoRedo, useUserPreferences };
+export type { AccordionItemProps, AccordionProps, ActionButtonProps, ActionGroupProps, ActionIconButtonProps, ActionableProps, ActiveMarks, AlertDialogProps, AudioPlayerProps, AutocompleteProps, AvatarProps, BlockProps, BoundaryAxis, BoxProps, BreadcrumbProps, BreadcrumbsProps, ButtonSelectProps, CalendarHeaderVariant, CalendarProps, CalendarSize, CellProps, CheckboxProps, CodeProps, ColorInputProps, ColorPreset, ColorSwatchPickerProps, ColorSwatchProps, ColumnProps, ComboBoxProps, CommandArgs, CommandName, CreateMessageFormatterOptions, DateFieldPickerType, DateFieldProps, DateFormatProps, Device, DeviceProviderProps, DialogProps, DialogTitleProps, DisclosureProps, DomNodeRendererProps, DrawerProps, EditableProps, EditorCoreOptions, EditorHandle, EditorProps, EditorProviderProps, EditorState, EditorStyle, FileInputProps, FileListItem, FileListProps, FileUploaderProps, FocusableProps, FrameProviderProps, FreehandCanvasProps, GridListProps, GroupProps, HorizontalBoundaryBehavior, I18nProviderProps, I18nResult, IconColorInputProps, IconComponentProps$1 as IconComponentProps, IconProps, IconSelectProps, IconSliderProps, ImageDropZoneProps, ImageGalleryProps, ImperativePanelGroupHandle, ImperativePanelHandle, InlineAlertProps, IntersectionObserverOptions, KbdProps, Key, LinkProps, ListBoxProps, ListHandle$1 as ListHandle, ListOption, MarkName, MarkdownProps, MenuItem, MenuProps, MessageDescriptor, MessageFormatProps, MessageFormatter, MessageId, MessageIssue, MessageIssueCode, ModalContentProps, ModalProps, ModelPoint, ModelRange, NumberFormatProps, NumberInputProps, PaginationProps, PanelGroupProps, PanelProps, PanelResizeHandleProps, PointPickerContentProps, PointPickerDisplayProps, PointPickerProps, PopoverContentHandle, PopoverContentProps, PopoverProps, PopoverTriggerProps, PortalProps, PressEvent, PreviewProps, ProgressBarProps, ProgressSpinnerProps, RadioGroupProps, RangeCalendarProps, ReactAriaIncompatibleKey, ReactionProps, Rect, ResizeObserverOptions, RichTextEditorDoc, RichTextEditorInline, RichTextEditorLink, RichTextEditorMention, RichTextEditorMentionInput, RichTextEditorParagraph, RichTextEditorText, RowProps, SVGRProps, SafeDOMAttributes, ScrollControlButtonProps, SearchInputProps, SelectOptions, SelectProps, SelectionState, SeparatorProps, SetValue, SkeletonProps, SliderProps, StatusCardProps, StepperItem, StepperProps, StylingProps, SwitchProps, TabItemProps, TableBodyProps, TableHeaderProps, TableProps, TabsProps, TagGroupProps, TagProps, TagVariant, TaggedPaginationProps, TextInputProps, TextProps, TextSelectionProps, ThemeProviderProps, TimeFieldProps, ToastProps, ToggleButtonProps, ToggleIconButtonProps, ToolbarProps, TooltipProps, TreeItemRenderState, TreeListItem, TreeViewProps, UNSAFE_ListBoxProps, UseEditableOptions, UseEditorOptions, UseTableDragAndDropOptions, ValueMarkKey, VirtualizerProps };