Skip to content

The Open Standard for Generative UI

3.9 KB
Raw Blame
import clsx from "clsx";
import { ChevronRight } from "lucide-react";
import { forwardRef, type HTMLAttributes, type ReactNode } from "react";
import { CardBlockLayout, cardKeyDownHandler } from "../_shared/cards/CardBlockLayout";
import { TooltipWrapper } from "../TooltipWrapper";

export interface SnippetCardTooltip {
  heading?: string;
  content?: string;
}

export interface SnippetCardBlockItem {
  id?: string;
  /** Left-hand content (typically an IconText / ImageText). */
  lhs: ReactNode;
  /** Right-hand value content (typically a Text / BoldText). Chevron is shown instead when clickable and absent. */
  rhs?: ReactNode;
  /** Tooltip shown when the lhs text is truncated. */
  lhsTooltip?: SnippetCardTooltip;
  /** Tooltip shown when the rhs text is truncated. */
  rhsTooltip?: SnippetCardTooltip;
}

export interface SnippetCardBlockProps extends Omit<HTMLAttributes<HTMLDivElement>, "onClick"> {
  items: SnippetCardBlockItem[];
  /** Collapses the grid to 2 / 1 columns on narrow containers. */
  responsive?: boolean;
  /** Overrides the gap between cards (px number or any CSS length). */
  gap?: number | string;
  /** Renders the cards as buttons and fires `onItemClick`. */
  clickable?: boolean;
  onItemClick?: (item: SnippetCardBlockItem, index: number) => void;
  className?: string;
}

const TEXT_BLOCK_HEADING_SELECTOR = ".openui-text-block__primary";
const TEXT_BLOCK_CONTENT_SELECTOR = ".openui-text-block__secondary";

const SnippetCardBlock = forwardRef<HTMLDivElement, SnippetCardBlockProps>((props, ref) => {
  const {
    items,
    responsive = true,
    gap,
    clickable = false,
    onItemClick,
    className,
    ...rest
  } = props;

  const isClickable = clickable && Boolean(onItemClick);

  return (
    <CardBlockLayout
      ref={ref}
      size="small"
      cardType="value-card"
      data-card-type="SnippetCard"
      items={items ?? []}
      layout="grid"
      responsive={responsive}
      maxPerRow={2}
      gap={gap}
      className={className}
      itemKey={(item, index) => item.id ?? `snippet-card-${index}`}
      renderItem={(item, index) => (
        <div
          className={clsx(
            "openui-value-card",
            !isClickable && "openui-value-card--static",
            isClickable && "openui-value-card--clickable",
          )}
          role={isClickable ? "button" : undefined}
          tabIndex={isClickable ? 0 : undefined}
          onClick={isClickable ? () => onItemClick?.(item, index) : undefined}
          onKeyDown={isClickable ? cardKeyDownHandler(() => onItemClick?.(item, index)) : undefined}
        >
          {item.lhs != null && (
            <TooltipWrapper
              tooltipHeading={item.lhsTooltip?.heading}
              tooltipContent={item.lhsTooltip?.content}
              showOnlyWhenTruncated
              headingSelector={TEXT_BLOCK_HEADING_SELECTOR}
              contentSelector={TEXT_BLOCK_CONTENT_SELECTOR}
            >
              <div className="openui-value-card__lhs">{item.lhs}</div>
            </TooltipWrapper>
          )}
          <div className="openui-value-card__rhs">
            {item.rhs != null ? (
              <TooltipWrapper
                tooltipHeading={item.rhsTooltip?.heading}
                tooltipContent={item.rhsTooltip?.content}
                showOnlyWhenTruncated
                headingSelector={TEXT_BLOCK_HEADING_SELECTOR}
                contentSelector={TEXT_BLOCK_CONTENT_SELECTOR}
              >
                <div className="openui-value-card__rhs-content">{item.rhs}</div>
              </TooltipWrapper>
            ) : (
              isClickable && (
                <div className="openui-value-card__chevron" aria-hidden="true">
                  <ChevronRight size={14} />
                </div>
              )
            )}
          </div>
        </div>
      )}
      {...rest}
    />
  );
});

SnippetCardBlock.displayName = "SnippetCardBlock";

export { SnippetCardBlock };