@dxos/react-ui 0.8.4-main.d05673bc65 → 0.8.4-main.d9fc60f731

package/src/components/Card/Card.tsx

@@ -4,211 +4,320 @@
 
 import { Primitive } from '@radix-ui/react-primitive';
 import { Slot } from '@radix-ui/react-slot';
-import React, { type HTMLAttributes, type PropsWithChildren, createContext, forwardRef, useContext } from 'react';
+import DOMPurify from 'dompurify';
+import React, { CSSProperties, JSX, MouseEventHandler, type ReactNode, forwardRef, useId, useMemo } from 'react';
 
-import { composableProps, mx } from '@dxos/ui-theme';
-import { type Density, type SlottableProps } from '@dxos/ui-types';
+import { iconSize } from '@dxos/ui-theme';
+import { type Density } from '@dxos/ui-types';
 
 import { useThemeContext } from '../../hooks';
-import { Column } from '../../primitives';
+import { composable, composableProps, slottable } from '../../util';
 import { type ThemedClassName } from '../../util';
 import { Button } from '../Button';
-import { Icon, type IconProps } from '../Icon';
+import { Column } from '../Column';
+import { Icon, IconBlock, type IconBlockProps, type IconProps } from '../Icon';
 import { Image } from '../Image';
-import { Toolbar, type ToolbarMenuItem, type ToolbarMenuProps, type ToolbarRootProps } from '../Toolbar';
-
-//
-// Context
-//
-
-type CardContextValue = {
-  menuItems?: CardMenuItem<any>[];
-};
-
-/** @deprecated Use context for menus. */
-const CardContext = createContext<CardContextValue>({});
+import {
+  Toolbar,
+  type ToolbarActionIconButtonProps,
+  ToolbarDragHandleProps,
+  type ToolbarMenuProps,
+  type ToolbarRootProps,
+} from '../Toolbar';
 
 //
 // Root
 //
 
-type CardRootProps = SlottableProps<
-  HTMLDivElement,
-  {
-    id?: string;
-    border?: boolean;
-    fullWidth?: boolean;
-  }
->;
+const CARD_ROOT_NAME = 'Card.Root';
+
+type CardRootProps = {
+  id?: string;
+  border?: boolean;
+  fullWidth?: boolean;
+  density?: Density;
+  style?: CSSProperties;
+  tabIndex?: number;
+  onClick?: MouseEventHandler<HTMLDivElement>;
+  'data-selected'?: boolean;
+  'data-testid'?: string;
+};
 
-const CardRoot = forwardRef<HTMLDivElement, CardRootProps>(
-  ({ children, id, asChild, role, border = true, fullWidth, ...props }, forwardedRef) => {
+/**
+ * `Card.Root` does not support `asChild`. The Column grid is the root element
+ * (one `<div>` carrying both the `dx-card` and `dx-column-root` classes
+ * instead of the previous outer-card + inner-column pair), so caller-provided
+ * HTML attributes — `onClick`, `tabIndex`, `style`, `data-*`, `grid-template-rows`
+ * overrides via `classNames` — land directly on the grid container.
+ * Slot-parents (`Focus.Item asChild`, `Mosaic.Tile asChild`, etc.) continue to
+ * work because `composable()` preserves the COMPOSABLE marker that slottable parents
+ * check before warning, and Radix `Slot` merges the parent's props onto the inner
+ * `<div>` exactly the way `slottable`'s `Slot`/`Primitive.div` branch did.
+ */
+const CardRoot = composable<HTMLDivElement, CardRootProps>(
+  ({ children, id, role, border = true, fullWidth, density, ...props }, forwardedRef) => {
     const { className, ...rest } = composableProps(props);
-    const Comp = asChild ? Slot : Primitive.div;
     const { tx } = useThemeContext();
 
     return (
-      <Comp
-        {...rest}
-        {...(id && { 'data-object-id': id })}
+      <Column.Root
+        asChild
+        gutter={density === 'lg' ? 'lg' : density === 'sm' || density === 'xs' ? 'sm' : 'md'}
+        classNames={tx('card.root', { border, fullWidth }, className)}
         role={role ?? 'group'}
-        className={tx('card.root', { border, fullWidth }, className)}
-        ref={forwardedRef}
       >
-        <Column.Root gutter='rail'>{children}</Column.Root>
-      </Comp>
+        <div {...rest} {...(id && { 'data-object-id': id })} ref={forwardedRef}>
+          {children}
+        </div>
+      </Column.Root>
     );
   },
 );
 
+CardRoot.displayName = CARD_ROOT_NAME;
+
 //
-// Toolbar
+// Header
 //
 
-type CardToolbarProps = ToolbarRootProps & {
-  density?: Density;
-};
+const CARD_HEADER_NAME = 'Card.Header';
 
-// TODO(burdon): Roncile name with DialogHeader.
-const CardToolbar = forwardRef<HTMLDivElement, CardToolbarProps>(
-  ({ children, classNames, density = 'fine', ...props }, forwardedRef) => {
-    const { tx } = useThemeContext();
+type CardHeaderProps = ToolbarRootProps;
 
-    return (
-      <Toolbar.Root
-        {...props}
-        classNames={[tx('card.toolbar', { coarse: density !== 'fine' }), classNames]}
-        ref={forwardedRef}
-      >
-        {children}
-      </Toolbar.Root>
-    );
-  },
-);
+/**
+ * Top "header" slot of a Card. Despite the name, this renders as an ARIA
+ * toolbar (`role="toolbar"`) so its action children get keyboard navigation
+ * for free — `<header>` is allowed to contain a toolbar.
+ */
+const CardHeader = composable<HTMLDivElement, CardHeaderProps>(({ children, classNames, ...props }, forwardedRef) => {
+  const { tx } = useThemeContext();
+
+  return (
+    <Toolbar.Root {...props} style={iconSize(5)} classNames={[tx('card.header', {}), classNames]} ref={forwardedRef}>
+      {children}
+    </Toolbar.Root>
+  );
+});
+
+CardHeader.displayName = CARD_HEADER_NAME;
 
 //
-// Menu (delegated to Toolbar.Menu)
+// DragHandle
 //
 
-type CardMenuItem<T extends any | void = void> = ToolbarMenuItem<T>;
-type CardMenuProps<T extends any | void = void> = ToolbarMenuProps<T>;
+const CARD_DRAG_HANDLE_NAME = 'Card.DragHandle';
 
-const CardMenu = <T extends any | void = void>({ context, items }: CardMenuProps<T>) => {
-  const { menuItems } = useContext(CardContext) ?? {};
-  const combinedItems = [...(items ?? []), ...((menuItems as CardMenuItem<T>[]) ?? [])];
+type CardDragHandleProps = ToolbarDragHandleProps;
 
-  return <Toolbar.Menu context={context} items={combinedItems} />;
-};
+const CardDragHandle = forwardRef<HTMLButtonElement, CardDragHandleProps>((props, forwardedRef) => {
+  return (
+    <CardIconBlock>
+      <Toolbar.DragHandle {...props} ref={forwardedRef} />
+    </CardIconBlock>
+  );
+});
+
+CardDragHandle.displayName = CARD_DRAG_HANDLE_NAME;
 
 //
-// Title
+// ActionIconButton
 //
 
-type CardTitleProps = SlottableProps<HTMLDivElement>;
+const CARD_ACTION_ICON_BUTTON_NAME = 'Card.ActionIconButton';
 
-const CardTitle = forwardRef<HTMLDivElement, CardTitleProps>(({ children, asChild, role, ...props }, forwardedRef) => {
-  const { className, ...rest } = composableProps(props);
-  const Comp = asChild ? Slot : Primitive.div;
-  const { tx } = useThemeContext();
+type CardActionIconButtonProps = ToolbarActionIconButtonProps;
 
+const CardActionIconButton = forwardRef<HTMLButtonElement, CardActionIconButtonProps>((props, forwardedRef) => {
   return (
-    <Comp {...rest} role={role ?? 'heading'} className={tx('card.title', {}, className)} ref={forwardedRef}>
-      {children}
-    </Comp>
+    <CardIconBlock>
+      <Toolbar.ActionIconButton {...props} ref={forwardedRef} />
+    </CardIconBlock>
   );
 });
 
+CardActionIconButton.displayName = CARD_ACTION_ICON_BUTTON_NAME;
+
+//
+// Menu
+//
+
+const CARD_MENU_NAME = 'Card.Menu';
+
+type CardMenuProps<T extends any | void = void> = ToolbarMenuProps<T>;
+
+function CardMenu<T extends any | void = void>({ context, items, ...props }: CardMenuProps<T>) {
+  return (
+    <CardIconBlock>
+      <Toolbar.Menu {...props} context={context} items={items ?? []} />
+    </CardIconBlock>
+  );
+}
+
+CardMenu.displayName = CARD_MENU_NAME;
+
 //
-// Content
+// Icon
 //
 
-type CardContentProps = SlottableProps<HTMLDivElement>;
+const CARD_ICON_NAME = 'Card.Icon';
+
+function CardIcon(props: IconProps) {
+  return (
+    <CardIconBlock>
+      <Icon {...props} />
+    </CardIconBlock>
+  );
+}
+
+CardIcon.displayName = CARD_ICON_NAME;
 
-const CardContent = forwardRef<HTMLDivElement, CardContentProps>(({ children, role, ...props }, forwardedRef) => {
+//
+// IconBlock
+//
+
+const CARD_ICON_BLOCK_NAME = 'Card.IconBlock';
+
+const CardIconBlock = forwardRef<HTMLDivElement, IconBlockProps>((props, forwardedRef) => {
+  return <IconBlock {...props} ref={forwardedRef} />;
+});
+
+CardIconBlock.displayName = CARD_ICON_BLOCK_NAME;
+
+//
+// Title
+//
+
+const CARD_TITLE_NAME = 'Card.Title';
+
+const CardTitle = slottable<HTMLDivElement>(({ children, asChild, ...props }, forwardedRef) => {
   const { tx } = useThemeContext();
+  const { className, ...rest } = composableProps(props, { role: 'heading' });
+  const Comp = asChild ? Slot : Primitive.div;
 
   return (
-    <div {...props} role={role ?? 'none'} className={tx('card.content', {})} ref={forwardedRef}>
+    <Comp {...rest} className={tx('card.title', {}, className)} ref={forwardedRef}>
       {children}
-    </div>
+    </Comp>
   );
 });
 
+CardTitle.displayName = CARD_TITLE_NAME;
+
 //
-// Row
+// Body
 //
 
-type CardRowProps = SlottableProps<HTMLDivElement, { icon?: string }>;
+const CARD_BODY_NAME = 'Card.Body';
 
-const CardRow = forwardRef<HTMLDivElement, CardRowProps>(({ children, role, icon, ...props }, forwardedRef) => {
+const CardBody = slottable<HTMLDivElement>(({ children, asChild, ...props }, forwardedRef) => {
   const { className, ...rest } = composableProps(props);
+  const Comp = asChild ? Slot : Primitive.div;
+  const { tx } = useThemeContext();
+
   return (
-    <Column.Row {...rest} role={role ?? 'none'} classNames={className} ref={forwardedRef}>
-      {(icon && <CardIcon classNames='text-subdued' icon={icon} />) || <div />}
+    <Comp {...rest} className={tx('card.body', {}, className)} ref={forwardedRef}>
       {children}
-      <div />
-    </Column.Row>
+    </Comp>
   );
 });
 
+CardBody.displayName = CARD_BODY_NAME;
+
 //
 // Section
 //
 
-type CardSectionProps = SlottableProps<HTMLDivElement>;
+const CARD_SECTION_NAME = 'Card.Section';
+
+type CardSectionProps = { title?: ReactNode };
 
-const CardSection = forwardRef<HTMLDivElement, CardSectionProps>(
-  ({ children, asChild, role, ...props }, forwardedRef) => {
+/**
+ * A labeled grouping of card content. `display: contents` keeps children aligned
+ * to the Card's column grid (like `Card.Body`); when `title` is provided,
+ * renders a subheading row at the top and exposes the group with
+ * `role='group' aria-labelledby=…` for screen readers.
+ */
+const CardSection = slottable<HTMLDivElement, CardSectionProps>(
+  ({ children, asChild, title, role, ...props }, forwardedRef) => {
     const { className, ...rest } = composableProps(props);
     const Comp = asChild ? Slot : Primitive.div;
+    const { tx } = useThemeContext();
+    const titleId = useId();
 
     return (
-      <Comp {...rest} role={role ?? 'none'} className={mx('col-span-full', className)} ref={forwardedRef}>
+      <Comp
+        {...rest}
+        role={role ?? (title ? 'group' : 'none')}
+        aria-labelledby={title ? titleId : undefined}
+        className={tx('card.section', {}, className)}
+        ref={forwardedRef}
+      >
+        {title && (
+          <div id={titleId} className={tx('card.section-title', {})}>
+            {title}
+          </div>
+        )}
         {children}
       </Comp>
     );
   },
 );
 
+CardSection.displayName = CARD_SECTION_NAME;
+
 //
-// Heading
+// Row
 //
 
-type CardHeadingProps = SlottableProps<HTMLDivElement, { variant?: 'default' | 'subtitle' }>;
+const CARD_ROW_NAME = 'Card.Row';
+
+type CardRowProps = { icon?: string | JSX.Element; fullWidth?: boolean };
 
 /**
- * @deprecated Use typography.
+ * A row inside a Card.
+ * - Default: spans all 3 columns and establishes a subgrid so children align to the Card's columns.
+ *   An optional `icon` lands in the first column; when omitted, the first column is left empty.
+ * - `fullWidth`: spans all columns without a subgrid — children do their own internal layout.
+ *   The `icon` prop is ignored in this mode.
  */
-const CardHeading = forwardRef<HTMLDivElement, CardHeadingProps>(
-  ({ children, asChild, role, variant = 'default', ...props }, forwardedRef) => {
+const CardRow = slottable<HTMLDivElement, CardRowProps>(
+  ({ children, asChild, icon: iconProp, fullWidth, ...props }, forwardedRef) => {
+    const { tx } = useThemeContext();
     const { className, ...rest } = composableProps(props);
     const Comp = asChild ? Slot : Primitive.div;
-    const { tx } = useThemeContext();
+    const icon =
+      typeof iconProp === 'string' ? (
+        <CardIcon classNames='text-subdued' icon={iconProp as string} size={4} />
+      ) : iconProp ? (
+        iconProp
+      ) : (
+        <div />
+      );
 
     return (
-      <Comp
-        {...rest}
-        role={role ?? 'heading'}
-        className={tx('card.heading', { variant }, className)}
-        ref={forwardedRef}
-      >
+      <Comp {...rest} className={tx('card.row', { fullWidth }, className)} ref={forwardedRef}>
+        {!fullWidth && icon}
         {children}
       </Comp>
     );
   },
 );
 
+CardRow.displayName = CARD_ROW_NAME;
+
 //
 // Text
 //
 
-type CardTextProps = SlottableProps<HTMLDivElement, { truncate?: boolean; variant?: 'default' | 'description' }>;
+const CARD_TEXT_NAME = 'Card.Text';
 
-const CardText = forwardRef<HTMLDivElement, CardTextProps>(
+type CardTextProps = { truncate?: boolean; variant?: 'default' | 'description' };
+
+const CardText = slottable<HTMLDivElement, CardTextProps>(
   ({ children, asChild, role, truncate, variant = 'default', ...props }, forwardedRef) => {
+    const { tx } = useThemeContext();
     const { className, ...rest } = composableProps(props);
     const Comp = asChild ? Slot : Primitive.div;
-    const { tx } = useThemeContext();
 
     return (
       <Comp {...rest} role={role ?? 'none'} className={tx('card.text', { variant }, className)} ref={forwardedRef}>
@@ -218,24 +327,69 @@ const CardText = forwardRef<HTMLDivElement, CardTextProps>(
   },
 );
 
+CardText.displayName = CARD_TEXT_NAME;
+
+//
+// Html
+//
+
+const CARD_HTML_NAME = 'Card.Html';
+
+type CardHtmlProps = { html?: string; variant?: 'default' | 'description' };
+
+/**
+ * Renders sanitized HTML content inside a card text slot.
+ * Uses DOMPurify to prevent XSS from untrusted markup (e.g. RSS feed content).
+ */
+function CardHtml({ html = '', variant = 'default', ...props }: CardHtmlProps & ThemedClassName<object>) {
+  const { tx } = useThemeContext();
+  const sanitized = useMemo(() => DOMPurify.sanitize(html), [html]);
+
+  return (
+    <div
+      {...props}
+      className={tx('card.text', { variant })}
+      // eslint-disable-next-line react/no-danger
+      dangerouslySetInnerHTML={{ __html: sanitized }}
+    />
+  );
+}
+
+CardHtml.displayName = CARD_HTML_NAME;
+
 //
 // Poster
 //
 
+const CARD_POSTER_NAME = 'Card.Poster';
+
 type CardPosterProps = ThemedClassName<
   {
     alt: string;
     aspect?: 'video' | 'auto';
+    /**
+     * How the image fills the poster box. `'contain'` (default) preserves
+     * aspect ratio and may letterbox; `'cover'` fills the box edge-to-edge,
+     * cropping as needed. Forwarded to the underlying `Image`'s
+     * `object-fit`.
+     */
+    fit?: 'contain' | 'cover';
   } & Partial<{ image: string; icon: string }>
 >;
 
-const CardPoster = (props: CardPosterProps) => {
+function CardPoster(props: CardPosterProps) {
   const { tx } = useThemeContext();
   const aspect = props.aspect === 'auto' ? 'aspect-auto' : 'aspect-video';
+
   if (props.image) {
     return (
-      <div role='none' className='col-span-full mb-1'>
-        <Image classNames={[tx('card.poster', {}), aspect, props.classNames]} src={props.image} alt={props.alt} />
+      <div className='col-span-full'>
+        <Image
+          classNames={[tx('card.poster', {}), aspect, props.classNames]}
+          src={props.image}
+          alt={props.alt}
+          fit={props.fit}
+        />
       </div>
     );
   }
@@ -247,32 +401,40 @@ const CardPoster = (props: CardPosterProps) => {
       </div>
     );
   }
-};
+}
+
+CardPoster.displayName = CARD_POSTER_NAME;
 
 //
 // Action
 //
 
+const CARD_ACTION_NAME = 'Card.Action';
+
 type CardActionProps = { icon?: string; label: string; actionIcon?: string; onClick?: () => void };
 
-const CardAction = ({ icon, actionIcon = 'ph--arrow-right--regular', label, onClick }: CardActionProps) => {
+function CardAction({ icon, actionIcon = 'ph--arrow-right--regular', label, onClick }: CardActionProps) {
   const { tx } = useThemeContext();
   return (
     <Button variant='ghost' classNames={tx('card.action', {})} onClick={onClick}>
-      {icon ? <CardIcon classNames='text-subdued' icon={icon} /> : <div />}
+      {icon ? <CardIcon classNames='text-subdued' icon={icon} size={4} /> : <div />}
       <span className={tx('card.action-label', {}, !actionIcon ? 'col-span-2' : undefined)}>{label}</span>
-      {actionIcon && <CardIcon icon={actionIcon} />}
+      {actionIcon && <CardIcon icon={actionIcon} size={4} />}
     </Button>
   );
-};
+}
+
+CardAction.displayName = CARD_ACTION_NAME;
 
 //
 // Link
 //
 
+const CARD_LINK_NAME = 'Card.Link';
+
 type CardLinkProps = { label: string; href: string };
 
-const CardLink = ({ label, href }: CardLinkProps) => {
+function CardLink({ label, href }: CardLinkProps) {
   const { tx } = useThemeContext();
   return (
     <a className={tx('card.link', {})} data-variant='ghost' href={href} target='_blank' rel='noreferrer'>
@@ -281,37 +443,9 @@ const CardLink = ({ label, href }: CardLinkProps) => {
       <CardIcon classNames='invisible group-hover:visible' icon='ph--arrow-square-out--regular' />
     </a>
   );
-};
-
-//
-// Icon
-//
-
-const CardIcon = ({ toolbar, ...props }: IconProps & { toolbar?: boolean }) => {
-  return (
-    <CardIconBlock>
-      <Icon {...props} size={toolbar ? 5 : 4} />
-    </CardIconBlock>
-  );
-};
+}
 
-//
-// IconBlock
-//
-
-const CardIconBlock = ({
-  classNames,
-  children,
-  role,
-  ...props
-}: ThemedClassName<PropsWithChildren<HTMLAttributes<HTMLDivElement>>>) => {
-  const { tx } = useThemeContext();
-  return (
-    <div {...props} role={role ?? 'none'} className={tx('card.icon-block', {}, classNames)}>
-      {children}
-    </div>
-  );
-};
+CardLink.displayName = CARD_LINK_NAME;
 
 //
 // Card
@@ -320,28 +454,35 @@ const CardIconBlock = ({
 export const Card = {
   Root: CardRoot,
 
-  // Toolbar
-  Toolbar: CardToolbar,
-  ToolbarIconButton: Toolbar.IconButton,
-  ToolbarSeparator: Toolbar.Separator,
-  DragHandle: forwardRef<HTMLButtonElement, Parameters<typeof Toolbar.DragHandle>[0]>((props, ref) => (
-    <Toolbar.DragHandle testId='card-drag-handle' {...props} ref={ref} />
-  )),
-  CloseIconButton: Toolbar.CloseIconButton,
-  Title: CardTitle,
+  // Header
+  Header: CardHeader,
+
+  // Header parts
+  IconBlock: CardIconBlock,
+  DragHandle: CardDragHandle,
+  ActionIconButton: CardActionIconButton,
   Menu: CardMenu,
   Icon: CardIcon,
-  IconBlock: CardIconBlock,
+  Title: CardTitle,
 
-  // Content
-  Content: CardContent,
-  Row: CardRow,
+  // Body
+  Body: CardBody,
   Section: CardSection,
-  Heading: CardHeading,
+  Row: CardRow,
+
+  // Body parts
   Text: CardText,
+  Html: CardHtml,
   Poster: CardPoster,
   Action: CardAction,
   Link: CardLink,
 };
 
-export type { CardContextValue, CardRootProps, CardToolbarProps, CardMenuProps };
+export type {
+  CardRootProps,
+  CardHeaderProps,
+  CardDragHandleProps,
+  CardActionIconButtonProps,
+  CardMenuProps,
+  CardSectionProps,
+};