Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

1.7 KB
Raw Blame
import { useResizeObserver } from "@mantine/hooks";
import type { ReactNode, RefObject } from "react";

import { Box, type BoxProps } from "metabase/ui";

import {
  FLEXIBLE_SIZE_DEFAULT_HEIGHT,
  FLEXIBLE_SIZE_DEFAULT_WIDTH,
} from "./FlexibleSizeComponent";

/**
 * Props for the ResizeWrapper component.
 * @extends BoxProps
 */
interface ResizeWrapperProps extends BoxProps {
  /** Content to be wrapped and resized */
  children: ReactNode;
  /** Optional ref to attach to the inner div that receives the measured dimensions */
  ref?: RefObject<HTMLDivElement | null>;
}

/**
 * A wrapper component that measures available space and applies those dimensions to its children.
 *
 * Uses a resize observer on the outer container to track size changes, then applies
 * the measured dimensions to an inner div wrapping the children. This ensures children
 * render with explicit dimensions matching their available space.
 *
 * @param props - Component props
 * @param props.children - Content to render inside the measured container
 * @param props.ref - Optional ref for the inner div (renamed to divRef internally to avoid conflict)
 * @param props...props - Additional BoxProps passed to the outer Box container
 *
 * @example
 * ```tsx
 * <ResizeWrapper>
 *   <MyChart />
 * </ResizeWrapper>
 * ```
 */
export function ResizeWrapper({
  children,
  ref: divRef,
  h = FLEXIBLE_SIZE_DEFAULT_HEIGHT,
  w = FLEXIBLE_SIZE_DEFAULT_WIDTH,
  ...props
}: ResizeWrapperProps) {
  const [ref, rect] = useResizeObserver();

  return (
    <Box ref={ref} w={w} h={h} {...props}>
      <div
        ref={divRef}
        style={{
          width: rect.width,
          height: rect.height,
        }}
      >
        {children}
      </div>
    </Box>
  );
}