@baseline-ui/core 3.8.0 → 3.9.1

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;
     /**
@@ -8975,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
@@ -9011,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. */
@@ -11017,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>, "isRequired" | "validate" | "validationState" | "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>, "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;
 
@@ -11236,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 */
@@ -11368,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>, "isRequired" | "validate" | "validationState" | "isInvalid" | "createCalendar"> & Pick<SharedInputProps, "label" | "variant" | "validationState" | "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>>;
@@ -11434,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.
@@ -12296,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" });
@@ -12337,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
@@ -12347,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;
 
@@ -12618,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() {