@dxos/react-ui 0.8.4-main.422d1c7879 → 0.8.4-main.43cb759274

package/src/components/Card/Card.tsx

@@ -5,54 +5,33 @@
 import { Primitive } from '@radix-ui/react-primitive';
 import { Slot } from '@radix-ui/react-slot';
 import DOMPurify from 'dompurify';
-import React, {
-  CSSProperties,
-  MouseEventHandler,
-  type PropsWithChildren,
-  createContext,
-  forwardRef,
-  useContext,
-  useMemo,
-} from 'react';
-
-import { composable, composableProps, iconSize, mx, slottable } from '@dxos/ui-theme';
+import React, { CSSProperties, JSX, MouseEventHandler, type ReactNode, forwardRef, useId, useMemo } from 'react';
+
+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,
-  ToolbarCloseIconButtonProps,
+  type ToolbarActionIconButtonProps,
   ToolbarDragHandleProps,
-  type ToolbarMenuItem,
   type ToolbarMenuProps,
   type ToolbarRootProps,
 } from '../Toolbar';
 
-//
-// Context
-//
-
-const CARD_NAME = 'Card';
-
-type CardContextValue = {
-  menuItems?: CardMenuItem<any>[];
-};
-
-/** @deprecated Use context for menus. */
-const CardContext = createContext<CardContextValue>({});
-
 //
 // Root
 //
 
 const CARD_ROOT_NAME = 'Card.Root';
 
-type CardRootOwnProps = {
+type CardRootProps = {
   id?: string;
   border?: boolean;
   fullWidth?: boolean;
@@ -64,24 +43,33 @@ type CardRootOwnProps = {
   'data-testid'?: string;
 };
 
-type CardRootProps = CardRootOwnProps;
-
-const CardRoot = slottable<HTMLDivElement, CardRootOwnProps>(
-  ({ children, id, asChild, role, border = true, fullWidth, density, ...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={density === 'coarse' ? 'lg' : 'md'}>{children}</Column.Root>
-      </Comp>
+        <div {...rest} {...(id && { 'data-object-id': id })} ref={forwardedRef}>
+          {children}
+        </div>
+      </Column.Root>
     );
   },
 );
@@ -89,24 +77,29 @@ const CardRoot = slottable<HTMLDivElement, CardRootOwnProps>(
 CardRoot.displayName = CARD_ROOT_NAME;
 
 //
-// Toolbar
+// Header
 //
 
-const CARD_TOOLBAR_NAME = 'Card.Toolbar';
+const CARD_HEADER_NAME = 'Card.Header';
 
-type CardToolbarProps = ToolbarRootProps;
+type CardHeaderProps = ToolbarRootProps;
 
-const CardToolbar = composable<HTMLDivElement, CardToolbarProps>(({ children, classNames, ...props }, forwardedRef) => {
+/**
+ * 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.toolbar', {}), classNames]} ref={forwardedRef}>
+    <Toolbar.Root {...props} style={iconSize(5)} classNames={[tx('card.header', {}), classNames]} ref={forwardedRef}>
       {children}
     </Toolbar.Root>
   );
 });
 
-CardToolbar.displayName = CARD_TOOLBAR_NAME;
+CardHeader.displayName = CARD_HEADER_NAME;
 
 //
 // DragHandle
@@ -118,7 +111,7 @@ type CardDragHandleProps = ToolbarDragHandleProps;
 
 const CardDragHandle = forwardRef<HTMLButtonElement, CardDragHandleProps>((props, forwardedRef) => {
   return (
-    <CardIconBlock padding>
+    <CardIconBlock>
       <Toolbar.DragHandle {...props} ref={forwardedRef} />
     </CardIconBlock>
   );
@@ -127,22 +120,22 @@ const CardDragHandle = forwardRef<HTMLButtonElement, CardDragHandleProps>((props
 CardDragHandle.displayName = CARD_DRAG_HANDLE_NAME;
 
 //
-// CloseIconButton
+// ActionIconButton
 //
 
-const CARD_CLOSE_ICON_BUTTON_NAME = 'Card.CloseIconButton';
+const CARD_ACTION_ICON_BUTTON_NAME = 'Card.ActionIconButton';
 
-type CloseIconButtonProps = ToolbarCloseIconButtonProps;
+type CardActionIconButtonProps = ToolbarActionIconButtonProps;
 
-const CloseIconButton = forwardRef<HTMLButtonElement, CloseIconButtonProps>((props, forwardedRef) => {
+const CardActionIconButton = forwardRef<HTMLButtonElement, CardActionIconButtonProps>((props, forwardedRef) => {
   return (
-    <CardIconBlock padding>
-      <Toolbar.CloseIconButton {...props} ref={forwardedRef} />
+    <CardIconBlock>
+      <Toolbar.ActionIconButton {...props} ref={forwardedRef} />
     </CardIconBlock>
   );
 });
 
-CloseIconButton.displayName = CARD_CLOSE_ICON_BUTTON_NAME;
+CardActionIconButton.displayName = CARD_ACTION_ICON_BUTTON_NAME;
 
 //
 // Menu
@@ -150,22 +143,17 @@ CloseIconButton.displayName = CARD_CLOSE_ICON_BUTTON_NAME;
 
 const CARD_MENU_NAME = 'Card.Menu';
 
-type CardMenuItem<T extends any | void = void> = ToolbarMenuItem<T>;
-
 type CardMenuProps<T extends any | void = void> = ToolbarMenuProps<T>;
 
-const CardMenu = <T extends any | void = void>({ context, items, ...props }: CardMenuProps<T>) => {
-  const { menuItems } = useContext(CardContext) ?? {};
-  const combinedItems = [...(items ?? []), ...((menuItems as CardMenuItem<T>[]) ?? [])];
-
+function CardMenu<T extends any | void = void>({ context, items, ...props }: CardMenuProps<T>) {
   return (
-    <CardIconBlock padding>
-      <Toolbar.Menu {...props} context={context} items={combinedItems} />
+    <CardIconBlock>
+      <Toolbar.Menu {...props} context={context} items={items ?? []} />
     </CardIconBlock>
   );
-};
+}
 
-(CardMenu as any).displayName = CARD_MENU_NAME;
+CardMenu.displayName = CARD_MENU_NAME;
 
 //
 // Icon
@@ -173,15 +161,15 @@ const CardMenu = <T extends any | void = void>({ context, items, ...props }: Car
 
 const CARD_ICON_NAME = 'Card.Icon';
 
-const CardIcon = (props: IconProps) => {
+function CardIcon(props: IconProps) {
   return (
     <CardIconBlock>
       <Icon {...props} />
     </CardIconBlock>
   );
-};
+}
 
-(CardIcon as any).displayName = CARD_ICON_NAME;
+CardIcon.displayName = CARD_ICON_NAME;
 
 //
 // IconBlock
@@ -189,17 +177,9 @@ const CardIcon = (props: IconProps) => {
 
 const CARD_ICON_BLOCK_NAME = 'Card.IconBlock';
 
-const CardIconBlock = forwardRef<HTMLDivElement, ThemedClassName<PropsWithChildren<{ padding?: boolean }>>>(
-  ({ classNames, children, padding, ...props }, forwardedRef) => {
-    const { tx } = useThemeContext();
-
-    return (
-      <div {...props} role='none' className={tx('card.icon-block', { padding }, classNames)} ref={forwardedRef}>
-        {children}
-      </div>
-    );
-  },
-);
+const CardIconBlock = forwardRef<HTMLDivElement, IconBlockProps>((props, forwardedRef) => {
+  return <IconBlock {...props} ref={forwardedRef} />;
+});
 
 CardIconBlock.displayName = CARD_ICON_BLOCK_NAME;
 
@@ -224,47 +204,24 @@ const CardTitle = slottable<HTMLDivElement>(({ children, asChild, ...props }, fo
 CardTitle.displayName = CARD_TITLE_NAME;
 
 //
-// Content
-//
-
-const CARD_CONTENT_NAME = 'Card.Content';
-
-const CardContent = slottable<HTMLDivElement>(({ children, asChild, ...props }, forwardedRef) => {
-  const { className, ...rest } = composableProps(props);
-  const Comp = asChild ? Slot : Primitive.div;
-  const { tx } = useThemeContext();
-
-  return (
-    <Comp {...rest} className={tx('card.content', {}, className)} ref={forwardedRef}>
-      {children}
-    </Comp>
-  );
-});
-
-CardContent.displayName = CARD_CONTENT_NAME;
-
-//
-// Row
+// Body
 //
 
-const CARD_ROW_NAME = 'Card.Row';
-
-type CardRowProps = { icon?: string; fullWidth?: boolean };
+const CARD_BODY_NAME = 'Card.Body';
 
-const CardRow = slottable<HTMLDivElement, CardRowProps>(({ children, asChild, 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 (
-    <Comp {...rest} className={tx('card.row', {}, className)} ref={forwardedRef}>
-      {(icon && <CardIcon classNames='text-subdued' icon={icon} size={4} />) || <div />}
+    <Comp {...rest} className={tx('card.body', {}, className)} ref={forwardedRef}>
       {children}
     </Comp>
   );
 });
 
-CardRow.displayName = CARD_ROW_NAME;
+CardBody.displayName = CARD_BODY_NAME;
 
 //
 // Section
@@ -272,53 +229,81 @@ CardRow.displayName = CARD_ROW_NAME;
 
 const CARD_SECTION_NAME = 'Card.Section';
 
+type CardSectionProps = { title?: ReactNode };
+
 /**
- * @deprecated Merge with Card.Row fullWidth
+ * 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>(({ children, asChild, role, ...props }, forwardedRef) => {
-  const { className, ...rest } = composableProps(props);
-  const Comp = asChild ? Slot : Primitive.div;
+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}>
-      {children}
-    </Comp>
-  );
-});
+    return (
+      <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
 //
 
-const CARD_HEADING_NAME = 'Card.Heading';
+const CARD_ROW_NAME = 'Card.Row';
 
-type CardHeadingProps = { variant?: 'default' | 'subtitle' };
+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 = slottable<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>
     );
   },
 );
 
-CardHeading.displayName = CARD_HEADING_NAME;
+CardRow.displayName = CARD_ROW_NAME;
 
 //
 // Text
@@ -330,9 +315,9 @@ 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}>
@@ -350,28 +335,27 @@ CardText.displayName = CARD_TEXT_NAME;
 
 const CARD_HTML_NAME = 'Card.Html';
 
-type CardHtmlProps = { html: string; variant?: 'default' | 'description' };
+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).
  */
-const CardHtml = ({ html, variant = 'default', ...props }: CardHtmlProps & ThemedClassName<object>) => {
+function CardHtml({ html = '', variant = 'default', ...props }: CardHtmlProps & ThemedClassName<object>) {
   const { tx } = useThemeContext();
   const sanitized = useMemo(() => DOMPurify.sanitize(html), [html]);
 
   return (
     <div
       {...props}
-      role='none'
       className={tx('card.text', { variant })}
       // eslint-disable-next-line react/no-danger
       dangerouslySetInnerHTML={{ __html: sanitized }}
     />
   );
-};
+}
 
-(CardHtml as any).displayName = CARD_HTML_NAME;
+CardHtml.displayName = CARD_HTML_NAME;
 
 //
 // Poster
@@ -393,13 +377,13 @@ type CardPosterProps = ThemedClassName<
   } & 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'>
+      <div className='col-span-full'>
         <Image
           classNames={[tx('card.poster', {}), aspect, props.classNames]}
           src={props.image}
@@ -417,9 +401,9 @@ const CardPoster = (props: CardPosterProps) => {
       </div>
     );
   }
-};
+}
 
-(CardPoster as any).displayName = CARD_POSTER_NAME;
+CardPoster.displayName = CARD_POSTER_NAME;
 
 //
 // Action
@@ -429,7 +413,7 @@ 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}>
@@ -438,9 +422,9 @@ const CardAction = ({ icon, actionIcon = 'ph--arrow-right--regular', label, onCl
       {actionIcon && <CardIcon icon={actionIcon} size={4} />}
     </Button>
   );
-};
+}
 
-(CardAction as any).displayName = CARD_ACTION_NAME;
+CardAction.displayName = CARD_ACTION_NAME;
 
 //
 // Link
@@ -450,7 +434,7 @@ 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'>
@@ -459,9 +443,9 @@ const CardLink = ({ label, href }: CardLinkProps) => {
       <CardIcon classNames='invisible group-hover:visible' icon='ph--arrow-square-out--regular' />
     </a>
   );
-};
+}
 
-(CardLink as any).displayName = CARD_LINK_NAME;
+CardLink.displayName = CARD_LINK_NAME;
 
 //
 // Card
@@ -470,24 +454,23 @@ const CardLink = ({ label, href }: CardLinkProps) => {
 export const Card = {
   Root: CardRoot,
 
-  // Toolbar
-  Toolbar: CardToolbar,
-  ToolbarIconButton: Toolbar.IconButton,
-  ToolbarSeparator: Toolbar.Separator,
+  // Header
+  Header: CardHeader,
 
-  // Toolbar blocks
+  // Header parts
   IconBlock: CardIconBlock,
   DragHandle: CardDragHandle,
-  CloseIconButton: CloseIconButton,
+  ActionIconButton: CardActionIconButton,
   Menu: CardMenu,
   Icon: CardIcon,
   Title: CardTitle,
 
-  // Content
-  Content: CardContent,
-  Row: CardRow,
+  // Body
+  Body: CardBody,
   Section: CardSection,
-  Heading: CardHeading,
+  Row: CardRow,
+
+  // Body parts
   Text: CardText,
   Html: CardHtml,
   Poster: CardPoster,
@@ -496,10 +479,10 @@ export const Card = {
 };
 
 export type {
-  CardContextValue,
   CardRootProps,
-  CardToolbarProps,
+  CardHeaderProps,
   CardDragHandleProps,
-  CloseIconButtonProps,
+  CardActionIconButtonProps,
   CardMenuProps,
+  CardSectionProps,
 };