@dxos/react-ui 0.8.4-main.8360d9e660 → 0.8.4-main.8baae0fced

package/src/components/Card/Card.tsx

@@ -4,17 +4,19 @@
 
 import { Primitive } from '@radix-ui/react-primitive';
 import { Slot } from '@radix-ui/react-slot';
+import DOMPurify from 'dompurify';
 import React, {
   CSSProperties,
-  type HTMLAttributes,
+  MouseEventHandler,
   type PropsWithChildren,
   createContext,
   forwardRef,
   useContext,
+  useMemo,
 } from 'react';
 
-import { composableProps, largeIconSize, mx } from '@dxos/ui-theme';
-import { type Density, type SlottableProps } from '@dxos/ui-types';
+import { composable, composableProps, iconSize, mx, slottable } from '@dxos/ui-theme';
+import { type Density } from '@dxos/ui-types';
 
 import { useThemeContext } from '../../hooks';
 import { Column } from '../../primitives';
@@ -35,6 +37,8 @@ import {
 // Context
 //
 
+const CARD_NAME = 'Card';
+
 type CardContextValue = {
   menuItems?: CardMenuItem<any>[];
 };
@@ -46,84 +50,115 @@ const CardContext = createContext<CardContextValue>({});
 // Root
 //
 
-type CardRootProps = SlottableProps<
-  HTMLDivElement,
-  {
-    id?: string;
-    border?: boolean;
-    fullWidth?: boolean;
-    density?: Density;
-  }
->;
+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, 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 === 'coarse' ? 'lg' : '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>
     );
   },
 );
 
+CardRoot.displayName = CARD_ROOT_NAME;
+
 //
 // Toolbar
 //
 
+const CARD_TOOLBAR_NAME = 'Card.Toolbar';
+
 type CardToolbarProps = ToolbarRootProps;
 
-const CardToolbar = forwardRef<HTMLDivElement, CardToolbarProps>(({ children, classNames, ...props }, forwardedRef) => {
+const CardToolbar = composable<HTMLDivElement, CardToolbarProps>(({ children, classNames, ...props }, forwardedRef) => {
   const { tx } = useThemeContext();
 
   return (
-    <Toolbar.Root {...props} style={largeIconSize} classNames={[tx('card.toolbar', {}), classNames]} ref={forwardedRef}>
+    <Toolbar.Root {...props} style={iconSize(5)} classNames={[tx('card.toolbar', {}), classNames]} ref={forwardedRef}>
       {children}
     </Toolbar.Root>
   );
 });
 
+CardToolbar.displayName = CARD_TOOLBAR_NAME;
+
 //
 // DragHandle
 //
 
+const CARD_DRAG_HANDLE_NAME = 'Card.DragHandle';
+
 type CardDragHandleProps = ToolbarDragHandleProps;
 
 const CardDragHandle = forwardRef<HTMLButtonElement, CardDragHandleProps>((props, forwardedRef) => {
   return (
-    <CardIconBlock>
-      <Toolbar.DragHandle {...props} testId='card-drag-handle' ref={forwardedRef} />
+    <CardIconBlock padding>
+      <Toolbar.DragHandle {...props} ref={forwardedRef} />
     </CardIconBlock>
   );
 });
 
+CardDragHandle.displayName = CARD_DRAG_HANDLE_NAME;
+
 //
 // CloseIconButton
 //
 
+const CARD_CLOSE_ICON_BUTTON_NAME = 'Card.CloseIconButton';
+
 type CloseIconButtonProps = ToolbarCloseIconButtonProps;
 
 const CloseIconButton = forwardRef<HTMLButtonElement, CloseIconButtonProps>((props, forwardedRef) => {
   return (
-    <CardIconBlock>
+    <CardIconBlock padding>
       <Toolbar.CloseIconButton {...props} ref={forwardedRef} />
     </CardIconBlock>
   );
 });
 
+CloseIconButton.displayName = CARD_CLOSE_ICON_BUTTON_NAME;
+
 //
 // Menu
 //
 
+const CARD_MENU_NAME = 'Card.Menu';
+
 type CardMenuItem<T extends any | void = void> = ToolbarMenuItem<T>;
 
 type CardMenuProps<T extends any | void = void> = ToolbarMenuProps<T>;
@@ -133,16 +168,20 @@ const CardMenu = <T extends any | void = void>({ context, items, ...props }: Car
   const combinedItems = [...(items ?? []), ...((menuItems as CardMenuItem<T>[]) ?? [])];
 
   return (
-    <CardIconBlock>
+    <CardIconBlock padding>
       <Toolbar.Menu {...props} context={context} items={combinedItems} />
     </CardIconBlock>
   );
 };
 
+(CardMenu as any).displayName = CARD_MENU_NAME;
+
 //
 // Icon
 //
 
+const CARD_ICON_NAME = 'Card.Icon';
+
 const CardIcon = (props: IconProps) => {
   return (
     <CardIconBlock>
@@ -151,101 +190,126 @@ const CardIcon = (props: IconProps) => {
   );
 };
 
+(CardIcon as any).displayName = CARD_ICON_NAME;
+
 //
 // IconBlock
 //
 
-const CardIconBlock = forwardRef<HTMLDivElement, ThemedClassName<PropsWithChildren>>(
-  ({ classNames, children, ...props }, forwardedRef) => {
+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', {}, classNames)} ref={forwardedRef}>
+      <div {...props} className={tx('card.icon-block', { padding }, classNames)} ref={forwardedRef}>
         {children}
       </div>
     );
   },
 );
 
+CardIconBlock.displayName = CARD_ICON_BLOCK_NAME;
+
 //
 // Title
 //
 
-type CardTitleProps = SlottableProps<HTMLDivElement>;
+const CARD_TITLE_NAME = 'Card.Title';
 
-const CardTitle = forwardRef<HTMLDivElement, CardTitleProps>(({ children, asChild, role, ...props }, forwardedRef) => {
-  const { className, ...rest } = composableProps(props);
-  const Comp = asChild ? Slot : Primitive.div;
+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 (
-    <Comp {...rest} role={role ?? 'heading'} className={tx('card.title', {}, className)} ref={forwardedRef}>
+    <Comp {...rest} className={tx('card.title', {}, className)} ref={forwardedRef}>
       {children}
     </Comp>
   );
 });
 
+CardTitle.displayName = CARD_TITLE_NAME;
+
 //
 // Content
 //
 
-type CardContentProps = SlottableProps<HTMLDivElement>;
+const CARD_CONTENT_NAME = 'Card.Content';
 
-const CardContent = forwardRef<HTMLDivElement, CardContentProps>(({ children, role, ...props }, forwardedRef) => {
+const CardContent = slottable<HTMLDivElement>(({ children, asChild, ...props }, forwardedRef) => {
+  const { className, ...rest } = composableProps(props);
+  const Comp = asChild ? Slot : Primitive.div;
   const { tx } = useThemeContext();
 
   return (
-    <div {...props} role={role ?? 'none'} className={tx('card.content', {})} ref={forwardedRef}>
+    <Comp {...rest} className={tx('card.content', {}, className)} ref={forwardedRef}>
       {children}
-    </div>
+    </Comp>
   );
 });
 
+CardContent.displayName = CARD_CONTENT_NAME;
+
 //
 // Row
 //
 
-type CardRowProps = SlottableProps<HTMLDivElement, { icon?: string }>;
+const CARD_ROW_NAME = 'Card.Row';
+
+type CardRowProps = { icon?: string; fullWidth?: boolean };
 
-const CardRow = forwardRef<HTMLDivElement, CardRowProps>(({ children, role, icon, ...props }, forwardedRef) => {
+// TODO(burdon): fullWidth should mean no columns.
+const CardRow = slottable<HTMLDivElement, CardRowProps>(({ children, asChild, icon, ...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.row', {}, className)} ref={forwardedRef}>
+      {(icon && <CardIcon classNames='text-subdued' icon={icon} size={4} />) || <div />}
       {children}
-      <div />
-    </Column.Row>
+    </Comp>
   );
 });
 
+CardRow.displayName = CARD_ROW_NAME;
+
 //
 // Section
 //
 
-type CardSectionProps = SlottableProps<HTMLDivElement>;
+const CARD_SECTION_NAME = 'Card.Section';
 
-const CardSection = forwardRef<HTMLDivElement, CardSectionProps>(
-  ({ children, asChild, role, ...props }, forwardedRef) => {
-    const { className, ...rest } = composableProps(props);
-    const Comp = asChild ? Slot : Primitive.div;
+/**
+ * @deprecated Merge with Card.Row fullWidth
+ */
+const CardSection = slottable<HTMLDivElement>(({ children, asChild, role, ...props }, forwardedRef) => {
+  const { className, ...rest } = composableProps(props);
+  const Comp = asChild ? Slot : Primitive.div;
 
-    return (
-      <Comp {...rest} role={role ?? 'none'} className={mx('col-span-full', className)} ref={forwardedRef}>
-        {children}
-      </Comp>
-    );
-  },
-);
+  return (
+    <Comp {...rest} role={role ?? 'none'} className={mx('col-span-full', className)} ref={forwardedRef}>
+      {children}
+    </Comp>
+  );
+});
+
+CardSection.displayName = CARD_SECTION_NAME;
 
 //
 // Heading
 //
 
-type CardHeadingProps = SlottableProps<HTMLDivElement, { variant?: 'default' | 'subtitle' }>;
+const CARD_HEADING_NAME = 'Card.Heading';
+
+type CardHeadingProps = { variant?: 'default' | 'subtitle' };
 
 /**
  * @deprecated Use typography.
  */
-const CardHeading = forwardRef<HTMLDivElement, CardHeadingProps>(
+const CardHeading = slottable<HTMLDivElement, CardHeadingProps>(
   ({ children, asChild, role, variant = 'default', ...props }, forwardedRef) => {
     const { className, ...rest } = composableProps(props);
     const Comp = asChild ? Slot : Primitive.div;
@@ -264,13 +328,17 @@ const CardHeading = forwardRef<HTMLDivElement, CardHeadingProps>(
   },
 );
 
+CardHeading.displayName = CARD_HEADING_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 { className, ...rest } = composableProps(props);
     const Comp = asChild ? Slot : Primitive.div;
@@ -284,24 +352,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).
+ */
+const 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 as any).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) => {
   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>
     );
   }
@@ -315,27 +428,35 @@ const CardPoster = (props: CardPosterProps) => {
   }
 };
 
+(CardPoster as any).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) => {
   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 as any).displayName = CARD_ACTION_NAME;
+
 //
 // Link
 //
 
+const CARD_LINK_NAME = 'Card.Link';
+
 type CardLinkProps = { label: string; href: string };
 
 const CardLink = ({ label, href }: CardLinkProps) => {
@@ -349,6 +470,8 @@ const CardLink = ({ label, href }: CardLinkProps) => {
   );
 };
 
+(CardLink as any).displayName = CARD_LINK_NAME;
+
 //
 // Card
 //
@@ -375,6 +498,7 @@ export const Card = {
   Section: CardSection,
   Heading: CardHeading,
   Text: CardText,
+  Html: CardHtml,
   Poster: CardPoster,
   Action: CardAction,
   Link: CardLink,