@baseline-ui/core 3.7.0 → 3.9.0

package/dist/index.d.ts

@@ -5996,11 +5996,9 @@ interface SharedProps {
     /** The `className` property assigned to the SVG element of the component. */
     className?: string;
     /**
-     * The `width` and `height` of the icon. This can be a string or a number. If
-     * you want to set the width and height to different values, you can pass
-     * `width` and `height` as separate props.
-     *
-     * @default "1em"
+     * The `width` and `height` of the icon. This can be a string or a number.
+     * When omitted, no `width` or `height` attribute is set and the SVG keeps any
+     * `width` and `height` from the `svg` string.
      */
     size?: string | number;
     /** The style applicable to the SVG element of the component. */
@@ -6014,8 +6012,6 @@ interface IconComponentProps$1 extends SharedProps {
      * The SVG string of the icon to render. This is useful if you want to render
      * an icon that is not in the catalog of icons provided in the list above. You
      * can use the `createIcon` function to create an icon from an SVG string.
-     *
-     * @default undefined
      */
     svg: string;
 }
@@ -6764,10 +6760,9 @@ interface ModalContentProps extends Omit<AriaModalOverlayProps, "isDismissable"
      */
     children: React__default.ReactNode | ((props: OverlayTriggerState) => React__default.ReactNode);
     /**
-     * The container element for the modal. By default, the modal is rendered as a
-     * child of the body element.
-     *
-     * @default document.body
+     * The container element for the modal. When omitted, the modal renders into
+     * the container from the nearest `PortalContainerProvider`, then the one from
+     * the nearest `FrameProvider`, and otherwise into the document body.
      */
     portalContainer?: HTMLElement;
     /**
@@ -6945,6 +6940,20 @@ interface PopoverContentProps extends Omit<AriaPopoverProps, "popoverRef" | "tri
      * @default "shift"
      */
     horizontalBoundaryBehavior?: HorizontalBoundaryBehavior;
+    /**
+     * The distance in pixels between the popover and its trigger along the main
+     * axis. When `includeArrow` is set, the arrow's 8px is added on top.
+     *
+     * @default 2
+     */
+    offset?: number;
+    /**
+     * The minimum distance in pixels kept between the popover and the edge of its
+     * boundary.
+     *
+     * @default 0
+     */
+    containerPadding?: number;
 }
 interface PopoverTriggerProps {
     /** The contents of the popover trigger. */
@@ -7091,6 +7100,12 @@ type MenuItem = MenuOption | MenuSection;
 type MenuPopoverProps = Pick<PopoverContentProps, "isNonModal" | "placement" | "shouldUpdatePosition" | "shouldFlip" | "boundaryElement" | "boundaryAxis" | "horizontalBoundaryBehavior" | "crossOffset" | "offset" | "portalContainer">;
 type MenuSelectionKeys = "selectionMode" | "selectedKeys" | "defaultSelectedKeys" | "onSelectionChange";
 interface MenuPropsBase extends MenuPopoverProps, Omit<MenuTriggerProps, "trigger">, CollectionOptionRenderProps<MenuOption, MenuItemRenderProps>, Omit<AriaMenuProps<MenuItem>, "children" | MenuSelectionKeys>, Omit<AriaMenuTriggerProps, "type" | "trigger"> {
+    /**
+     * The placement of the menu relative to its trigger.
+     *
+     * @default "bottom start"
+     */
+    placement?: Placement;
     /**
      * How the menu is opened from its trigger. With `"longPress"`, a long press
      * or `Alt` + `ArrowDown` / `ArrowUp` / `Enter` / `Space` opens the menu.
@@ -7224,6 +7239,20 @@ interface TooltipProps extends StylingProps, TooltipTriggerProps, AriaTooltipPro
      * @default document.body
      */
     portalContainer?: HTMLElement;
+    /**
+     * The distance in pixels between the tooltip and its trigger along the main
+     * axis. Defaults to 2 when `includeArrow` is false.
+     *
+     * @default 12
+     */
+    offset?: number;
+    /**
+     * The minimum distance in pixels of the arrow from the edge of the tooltip. It
+     * defaults to 0 when `includeArrow` is false.
+     *
+     * @default 8
+     */
+    arrowBoundaryOffset?: number;
 }
 interface FocusableProps extends FocusableOptions, StylingProps {
     /** The content of the focusable element. */
@@ -7387,7 +7416,9 @@ interface ColorInputProps extends OverlayTriggerProps$1, StylingProps, Pick<Colo
      * that is currently selected. If boolean, the label will be shown only when
      * the color is not `null`. If a function, the function will be called with
      * the current color and should return a string. If `false`, the label will
-     * not be shown.
+     * not be shown, but the default trigger's accessible name still includes the
+     * color name. A custom `renderTriggerButton` receives `colorName: false` and
+     * is responsible for naming its trigger.
      *
      * @default true
      */
@@ -8273,6 +8304,14 @@ interface TagProps extends StylingProps {
      * @default "md"
      */
     size?: "sm" | "md";
+    /**
+     * The element the tag renders as. Use `span` to place a tag without
+     * `onRemove` inside a button or other inline content, where a `div` is not
+     * valid HTML. Has no effect inside a `TagGroup`.
+     *
+     * @default "div"
+     */
+    elementType?: "div" | "span";
     /**
      * An optional icon to display before the tag content.
      */
@@ -8427,6 +8466,12 @@ declare const AccordionItem: React__default.ForwardRefExoticComponent<AccordionI
 
 type SelectionMode = "single" | "multiple";
 interface SelectProps<M extends SelectionMode = SelectionMode> extends Omit<AriaSelectOptions<ListItem, M> & SelectStateOptions<ListItem, M> & PopoverContentProps, "validationState" | "items" | "children" | "isRequired" | "className" | "style" | "triggerRef" | "validate" | "validationBehavior" | "keyboardDelegate" | "state" | "overlayProps">, Pick<UNSAFE_ListBoxProps, "items" | "optionStyle" | "optionClassName" | "showSectionHeader">, Pick<ColorInputProps, "onTriggerPress">, StylingProps {
+    /**
+     * The placement of the popover relative to the trigger.
+     *
+     * @default "bottom start"
+     */
+    placement?: Placement;
     /**
      * The position of the label.
      *
@@ -8558,6 +8603,40 @@ interface AvatarProps extends StylingProps {
 
 declare const Avatar: React__default.ForwardRefExoticComponent<AvatarProps & React__default.RefAttributes<HTMLSpanElement>>;
 
+interface ImageProps extends Omit<React__default.ImgHTMLAttributes<HTMLImageElement>, "children" | "dangerouslySetInnerHTML"> {
+    /** The URL of the image to display. */
+    src: string;
+    /**
+     * The text alternative of the image. Pass an empty string when the image is
+     * purely decorative.
+     */
+    alt: string;
+    /**
+     * How the image fills its container. `cover` crops the image to fill the
+     * container; `contain` shows the whole image inside it.
+     *
+     * @default "cover"
+     */
+    fit?: "cover" | "contain";
+    /**
+     * When the browser loads the image. `lazy` defers it until the image is near
+     * the viewport, which suits thumbnails in long lists; `eager` loads it right
+     * away.
+     *
+     * @default "eager"
+     */
+    loading?: "lazy" | "eager";
+    /**
+     * Content rendered in place of the image when it fails to load or `src` is
+     * empty. Without it, the browser's broken-image rendering stays. The
+     * fallback replaces the `<img>`, so `alt`, `className`, `style` and the ref
+     * do not apply to it; give a meaningful fallback its own accessible name.
+     */
+    fallback?: React__default.ReactNode;
+}
+
+declare const Image: React__default.ForwardRefExoticComponent<ImageProps & React__default.RefAttributes<HTMLImageElement>>;
+
 type ItemProps = React__default.ComponentProps<typeof _Item> & StylingProps & {
     key?: Key;
     icon?: React__default.FC<IconProps>;
@@ -8819,6 +8898,11 @@ interface FreehandCanvasProps extends StylingProps, AriaLabelingProps {
     value?: FreehandCanvasLine[];
     /** The label for the canvas. */
     label?: string;
+    /**
+     * The accessible name of the canvas. Without it, the canvas is named by
+     * `label` or `aria-labelledby`, and by "Drawing canvas" when neither is set.
+     */
+    "aria-label"?: string;
     /**
      * Whether to enable history for undo/redo.
      *
@@ -8886,7 +8970,10 @@ declare const Text: React__default.ForwardRefExoticComponent<Omit<TextProps, "re
 interface SharedFileUploadProps extends StylingProps {
     /** Whether the component is disabled. */
     isDisabled?: boolean;
-    /** The description to display. */
+    /**
+     * Announced as the file input's description. It is visually hidden; render
+     * any visible helper text yourself.
+     */
     description?: string;
     /**
      * The accepted file types, passed through to the underlying
@@ -8922,9 +9009,11 @@ interface ImageDropZoneProps extends SharedFileUploadProps, Omit<DropOptions, "r
      */
     imageSrc?: string | File;
     /**
-     * The alt text to display for the image. This will be used as the `alt`
-     * attribute of the `<img>`. element. If no `imageAlt` is provided, the
-     * `label` will be used.
+     * The alt text for the image, used as the `alt` attribute of the `<img>`
+     * element. Without it the image renders with an empty `alt` and screen
+     * readers skip it.
+     *
+     * @default ""
      */
     imageAlt?: string;
     /** The label to display for the picker button. */
@@ -9018,7 +9107,7 @@ interface PreviewProps extends StylingProps, AriaLabelingProps {
      * - "positive": Represents a positive accent color that doesn't change with
      *   theme.
      *
-     * @default "theme"
+     * @default "positive"
      */
     accent?: "theme" | "positive";
 }
@@ -10928,7 +11017,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" | "variant" | "validationState" | "labelPosition"> & InputMessage & React__default.RefAttributes<HTMLDivElement>>;
+declare const TimeField: React__default.ForwardRefExoticComponent<StylingProps & Omit<Omit<TimeFieldStateOptions<TimeValue>, "locale"> & AriaTimeFieldProps<TimeValue>, "isRequired" | "validate" | "validationState" | "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;
 
@@ -11019,9 +11108,15 @@ interface TreeViewProps extends StylingProps, Omit<AriaLabelingProps, "aria-desc
      * triggered. If not provided, the secondary action will not be shown.
      */
     onSecondaryAction?: (key: Key$1) => void;
-    /** The icon to use for the primary action. */
+    /**
+     * The icon to use for the primary action. The action is a plain button, so
+     * a `{ selected, unselected }` pair renders `unselected`.
+     */
     primaryActionIcon?: ToggleIconButtonProps["icon"] | ((key: Key$1) => ToggleIconButtonProps["icon"]);
-    /** The icon to use for the secondary action. */
+    /**
+     * The icon to use for the secondary action. The action is a plain button,
+     * so a `{ selected, unselected }` pair renders `unselected`.
+     */
     secondaryActionIcon?: ToggleIconButtonProps["icon"] | ((key: Key$1) => ToggleIconButtonProps["icon"]);
     /** The aria label for the primary action. */
     primaryActionAriaLabel?: string | ((key: Key$1) => string);
@@ -11141,9 +11236,10 @@ interface PanelProps extends StylingProps {
      */
     maxSize?: PanelProps$1["maxSize"];
     /**
-     * Minimum allowed size for the panel, accepts value between 0 - 100
+     * Minimum allowed size for the panel, accepts value between 0 - 100. When
+     * omitted, the panel has no minimum size and can shrink to 0.
      *
-     * @default 10
+     * @default 0
      */
     minSize?: PanelProps$1["minSize"];
     /** Called with current panel size on resize */
@@ -11273,7 +11369,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" | "variant" | "validationState" | "labelPosition"> & InputMessage & {
+declare const DateField: React__default.ForwardRefExoticComponent<StylingProps & Omit<Omit<DateFieldStateOptions<DateValue>, "locale"> & AriaDateFieldProps<DateValue>, "isRequired" | "validate" | "validationState" | "isInvalid" | "createCalendar"> & Pick<SharedInputProps, "label" | "variant" | "validationState" | "labelPosition"> & InputMessage & {
     pickerType?: DateFieldPickerType;
     openCalendarLabel?: string;
 } & React__default.RefAttributes<HTMLDivElement>>;
@@ -11339,13 +11435,21 @@ interface TaggedPaginationProps extends StylingProps, Pick<PaginationProps, "isD
     value?: number;
     /** The default value of the component. */
     defaultValue?: number;
-    /** The callback that is called when the value is changed. */
+    /**
+     * Called with the submitted text when a non-empty entry is submitted on
+     * Enter or blur, unless it resolves to the current page. Unknown and
+     * out-of-range entries are still reported.
+     */
     onChange?: (value: number | string) => void;
     /** The callback that is called when the value is changed successfully. */
     onChangeSuccess?: (value: number) => void;
     /** The callback that is called when the input value is changed. */
     onInputChange?: (value: string) => void;
-    /** The description of the component. */
+    /**
+     * The description of the component.
+     *
+     * @default `${value} / ${maxValue}`, or the current page alone when `maxValue` is not finite
+     */
     description?: string | ((value: number) => string);
     /**
      * The step of the component.
@@ -11429,7 +11533,32 @@ interface Description {
     label: string;
     icon: React__default.FC<IconProps>;
 }
-type FloatingOptions = Pick<PopoverContentProps, "crossOffset" | "offset" | "placement"> & {
+type FloatingOptions = {
+    /**
+     * The placement of the display relative to the anchor.
+     *
+     * @default "bottom start"
+     */
+    placement?: Placement;
+    /**
+     * The distance in pixels between the display and the anchor along the main
+     * axis.
+     *
+     * @default 0
+     */
+    offset?: number;
+    /**
+     * The distance in pixels between the display and the anchor along the cross
+     * axis. With `anchorElement: "trailing"` it is 0.
+     *
+     * @default indicator width
+     */
+    crossOffset?: number;
+    /**
+     * The element the display is anchored to.
+     *
+     * @default "indicator"
+     */
     anchorElement?: "indicator" | "trailing";
 };
 interface PointPickerDisplayProps extends StylingProps {
@@ -11785,6 +11914,16 @@ interface StepperProps extends StylingProps {
 
 declare const Stepper: React__default.ForwardRefExoticComponent<StepperProps & React__default.RefAttributes<HTMLOListElement>>;
 
+interface FileListItemTag {
+    /** The tag text. */
+    label: string;
+    /**
+     * The colour of the tag.
+     *
+     * @default "neutral"
+     */
+    variant?: TagVariant;
+}
 interface FileListItem {
     /** Stable identifier used to remove the item and as the listbox key. */
     id: string;
@@ -11792,42 +11931,88 @@ interface FileListItem {
     name: string;
     /**
      * Whether the item is currently uploading. When `true`, a spinner is
-     * rendered in place of the remove button.
+     * rendered in place of the remove button. Shown in the `compact` variant
+     * only.
      */
     isLoading?: boolean;
     /**
      * Primary error message. When set, the row is rendered in the error
-     * state with a red border and the message below the file name.
+     * state with a red border and the message below the file name. Shown in
+     * the `compact` variant only.
      */
     errorMessage?: React__default.ReactNode;
     /**
      * Optional secondary explanation rendered below `errorMessage` in the
-     * helper color.
+     * helper color. Shown in the `compact` variant only.
      */
     errorExplanation?: React__default.ReactNode;
+    /**
+     * Secondary text rendered under the name and read as the item's accessible
+     * description. Shown in the `expanded` and `grid` variants.
+     */
+    description?: string;
+    /**
+     * A status tag rendered at the end of the row and read as part of the
+     * item's accessible description. Shown in the `expanded` variant, and
+     * disabled with the item.
+     */
+    tag?: FileListItemTag;
+    /**
+     * A preview of the file, such as an `Image`, shown in place of the file
+     * icon in the `grid` variant. An `Image` without a `fallback` shows the file
+     * icon when it fails to load.
+     */
+    preview?: React__default.ReactNode;
 }
 interface FileListProps extends AriaLabelingProps {
     /** The className applied to the root element. */
     className?: string;
     /** The style applied to the root element. */
     style?: React__default.CSSProperties;
+    /**
+     * How the items are rendered.
+     *
+     * - `compact` (default): divided rows with a file icon and name, for files
+     *   the user has added. The only variant that renders the remove button,
+     *   the loading spinner and error messages.
+     * - `expanded`: bordered cards with the name, `description` and `tag`.
+     *   Past about five rows the list scrolls.
+     * - `grid`: preview tiles with the `preview`, name and `description`, up to
+     *   six per row. Past about two rows the grid scrolls.
+     *
+     * @default "compact"
+     */
+    variant?: "compact" | "expanded" | "grid";
+    /**
+     * A title rendered above the list that also labels it for assistive
+     * technology.
+     */
+    label?: React__default.ReactNode;
+    /**
+     * Called with the `id` of the item the user picks by clicking it or
+     * pressing Enter.
+     */
+    onAction?: (id: string) => void;
     /**
      * The items rendered in the list. Pass a stable reference (e.g. memoize
      * or hoist) when possible — every new array identity rebuilds the
      * underlying listbox collection.
      */
     items: FileListItem[];
-    /** Called when the user removes an item via the row button or Delete. */
+    /**
+     * Called when the user removes an item via the row button, Delete or
+     * Backspace. Only the `compact` variant supports removal.
+     */
     onRemove?: (id: string) => void;
     /**
      * Keys of items that should be disabled individually, or `"all"` to
      * disable every item. Disabled items cannot be removed via the row
-     * button or keyboard.
+     * button or keyboard, or picked with `onAction`.
      */
     disabledKeys?: Iterable<string> | "all";
     /**
      * Overrides the accessible name of a file row while it is loading, and of
-     * its spinner.
+     * its spinner. Used in the `compact` variant only.
      *
      * Message id: `bui.fileList.loading`. Defaults to `"Loading {fileName}"`.
      * A string is used as-is, with no placeholder substitution. To include
@@ -11839,7 +12024,7 @@ interface FileListProps extends AriaLabelingProps {
     }) => string);
     /**
      * Overrides the accessible name of a removable file row, telling keyboard
-     * users how to delete it.
+     * users how to delete it. Used in the `compact` variant only.
      *
      * Message id: `bui.fileList.removeHint`. Defaults to
      * `"{fileName}, press Delete or Backspace to remove"`. A string is used
@@ -11858,25 +12043,41 @@ interface FileUploaderProps extends Omit<StylingProps, keyof BlockProps> {
     /**
      * The visual variant.
      *
-     * - `dropzone` (default): renders a drop area that accepts dragged and
-     *   pasted files. Clicking anywhere in the area opens the file picker.
-     * - `button`: renders an `ActionButton` that opens the file picker. No
-     *   drop target is rendered.
+     * - `dropzone-box` (default): a filled drop area that accepts dragged and
+     *   pasted files. Clicking blank space in the area opens the file picker.
+     * - `dropzone-inline`: the same drop area outlined with a dashed border and
+     *   rounded corners instead of a filled box.
+     * - `dropzone-compact`: a one-line dashed bar with the upload icon, the
+     *   action text and the `description` side by side. The action text and the
+     *   description truncate with an ellipsis rather than wrap. The `children`
+     *   render below the bar, outside the drop area.
+     * - `button`: an `ActionButton` that opens the file picker. No drop target
+     *   is rendered.
+     * - `dropzone` (deprecated): an alias for `dropzone-box`, or for
+     *   `dropzone-inline` when `isInline` is set. Use one of the values above.
      *
-     * @default "dropzone"
+     * @default "dropzone-box"
      */
-    variant?: "dropzone" | "button";
+    variant?: "dropzone-box" | "dropzone-inline" | "dropzone-compact" | "button" | "dropzone";
     /**
-     * Whether the `dropzone` drop area is rendered inline — outlined with a
-     * dashed border and rounded corners — instead of as a plain filled box.
-     * Has no effect on the `button` variant.
+     * Whether the drop area is rendered inline. Only honoured when `variant` is
+     * omitted or the deprecated `"dropzone"`; any other `variant` ignores it.
      *
+     * @deprecated Use `variant="dropzone-inline"`.
      * @default false
      */
     isInline?: boolean;
     /** Optional label rendered above the trigger. */
     label?: React__default.ReactNode;
-    /** Optional description rendered below the label. */
+    /**
+     * Optional description. The dropzone variants render it inside the drop
+     * area, under the action text (beside it in `dropzone-compact`), where
+     * clicking it opens the file picker; a link in it should be a Baseline
+     * `Link`, since a native `<a>` also opens the picker. Keep it plain text in
+     * `dropzone-compact`: it truncates there, so a link can be cut off while
+     * still taking keyboard focus. The `button` variant renders it below the
+     * label.
+     */
     description?: React__default.ReactNode;
     /** Called when the user selects or drops new files. */
     onAdd?: (files: File[]) => void;
@@ -11909,12 +12110,26 @@ interface FileUploaderProps extends Omit<StylingProps, keyof BlockProps> {
      */
     buttonLabel?: string;
     /**
-     * The text rendered inside the clickable drop area in the `dropzone`
-     * variant.
+     * The text rendered inside the clickable drop area in the dropzone
+     * variants.
      *
      * @default "Drop files here or click to upload"
      */
     dropzoneLabel?: string;
+    /**
+     * Content offered alongside the drop area, typically a `FileList` of sample
+     * files the user can pick instead of uploading one. In the `dropzone-box`
+     * and `dropzone-inline` variants it renders inside the drop area, centered,
+     * so a file dropped on it is still added; clicking blank space in the drop
+     * area opens the file picker, and clicking an item, button or link does not.
+     * Use Baseline components for anything clickable here: a native `<button>`,
+     * `<a>` or `<input>` also opens the picker. Use the `grid` `FileList`
+     * variant here; an `expanded` list shrinks to its widest card. The `button`
+     * and `dropzone-compact` variants render it below the control. Disabling the
+     * uploader disables a `FileList` passed here. To show samples outside the
+     * drop area, render the `FileList` next to the uploader instead.
+     */
+    children?: React__default.ReactNode;
 }
 
 declare const FileUploader: React__default.ForwardRefExoticComponent<FileUploaderProps & React__default.RefAttributes<HTMLDivElement>>;
@@ -12090,11 +12305,14 @@ declare function useImage({ src, alt }: {
  *
  * @example
  *   ```tsx
- *   const { state, push, undo, redo, pastStates, futureStates, canUndo, canRedo } = useUndoRedo({
- *     onAction: (state, action) => {
- *     // do something
+ *   const { state, push, undo, redo, pastStates, futureStates, canUndo, canRedo } = useUndoRedo(
+ *     { foo: "" },
+ *     {
+ *       onAction: (state, action) => {
+ *         // do something
+ *       },
  *     },
- *   });
+ *   );
  *
  *   // push a new state
  *   push({ foo: "bar" });
@@ -12131,9 +12349,11 @@ declare const useUndoRedo: <T>(initialState: T | undefined, { isDisabled, onActi
 };
 
 /**
- * This hook returns true if the component is being rendered for the first time.
- * This is useful for avoiding side effects on the first render inside of
- * useEffect.
+ * This hook returns true during the component's first render and false on
+ * every render after that. It does not trigger a re-render itself: the value
+ * only changes once something else re-renders the component. This is useful
+ * for skipping an effect on mount. Keep `isFirstRender` out of the effect's
+ * dependencies, or its change to `false` re-runs the effect on the next render.
  *
  * @example
  *   ```tsx
@@ -12141,14 +12361,11 @@ declare const useUndoRedo: <T>(initialState: T | undefined, { isDisabled, onActi
  *
  *   useEffect(() => {
  *      if (isFirstRender) return;
- *      // do something
- *      return () => {
- *        // do something on unmount
- *      };
- *   }, [isFirstRender]);
+ *      // runs when `value` changes, not on mount
+ *   }, [value]);
  *   ```;
  *
- * @returns Whether or not the component is being rendered for the first time
+ * @returns Whether the component is being rendered for the first time
  */
 declare function useIsFirstRender(): boolean;
 
@@ -12412,6 +12629,9 @@ type SetValue<T> = Dispatch<SetStateAction<T>>;
 /**
  * A hook to persist a value to localStorage.
  *
+ * The server render and hydration use `initialValue`; the stored value is read
+ * right after hydration.
+ *
  * @example
  *   ```tsx
  *   function MyComponent() {
@@ -12595,5 +12815,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, 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 };
+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, Image, 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, FileListItemTag, FileListProps, FileUploaderProps, FocusableProps, FrameProviderProps, FreehandCanvasProps, GridListProps, GroupProps, HorizontalBoundaryBehavior, I18nProviderProps, I18nResult, IconColorInputProps, IconComponentProps$1 as IconComponentProps, IconProps, IconSelectProps, IconSliderProps, ImageDropZoneProps, ImageGalleryProps, ImageProps, 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 };