Item

PreviousNext

List item component with actions.

Docs
hextauiui

Preview

Loading preview…
registry/new-york/ui/item.tsx
import { Slot } from "@radix-ui/react-slot";
import { cva, type VariantProps } from "class-variance-authority";
import * as React from "react";
import { cn } from "@/lib/utils";
import { Separator } from "@/registry/new-york/ui/separator";

const ItemGroup = React.forwardRef<HTMLDivElement, React.ComponentProps<"div">>(
  function ItemGroup({ className, ...props }, ref) {
    return (
      <div
        className={cn(
          "group/item-group flex touch-manipulation flex-col",
          className
        )}
        data-slot="item-group"
        ref={ref}
        role="list"
        {...props}
      />
    );
  }
);

function ItemSeparator({
  className,
  ...props
}: React.ComponentProps<typeof Separator>) {
  return (
    <Separator
      className={cn("my-0", className)}
      data-slot="item-separator"
      orientation="horizontal"
      {...props}
    />
  );
}

const itemVariants = cva(
  "group/item flex touch-manipulation flex-wrap items-center rounded-md border border-transparent text-sm outline-none transition-colors focus-visible:border-ring focus-visible:ring-[3px] focus-visible:ring-ring/50 motion-safe:duration-200 [a]:transition-colors [a]:hover:bg-accent/50",
  {
    variants: {
      variant: {
        default: "bg-transparent",
        outline: "border-border",
        muted: "bg-muted/50",
      },
      size: {
        default: "gap-4 p-4",
        sm: "gap-2.5 px-4 py-3",
      },
    },
    defaultVariants: {
      variant: "default",
      size: "default",
    },
  }
);

const Item = React.forwardRef<
  HTMLDivElement,
  React.ComponentProps<"div"> &
    VariantProps<typeof itemVariants> & { asChild?: boolean }
>(function Item(
  {
    className,
    variant = "default",
    size = "default",
    asChild = false,
    ...props
  },
  ref
) {
  const Comp = asChild ? Slot : "div";
  return (
    <Comp
      className={cn(itemVariants({ variant, size }), className)}
      data-size={size}
      data-slot="item"
      data-variant={variant}
      ref={ref}
      role="listitem"
      {...props}
    />
  );
});

const itemMediaVariants = cva(
  "flex shrink-0 items-center justify-center gap-2 group-has-[[data-slot=item-description]]/item:translate-y-0.5 group-has-[[data-slot=item-description]]/item:self-start [&_svg]:pointer-events-none",
  {
    variants: {
      variant: {
        default: "bg-transparent",
        icon: "size-8 rounded-sm border bg-muted [&_svg:not([class*='size-'])]:size-4",
        image:
          "size-10 overflow-hidden rounded-sm [&_img]:size-full [&_img]:object-cover",
      },
    },
    defaultVariants: {
      variant: "default",
    },
  }
);

const ItemMedia = React.forwardRef<
  HTMLDivElement,
  React.ComponentProps<"div"> & VariantProps<typeof itemMediaVariants>
>(function ItemMedia({ className, variant = "default", ...props }, ref) {
  return (
    <div
      className={cn(itemMediaVariants({ variant }), className)}
      data-slot="item-media"
      data-variant={variant}
      ref={ref}
      {...props}
    />
  );
});

const ItemContent = React.forwardRef<
  HTMLDivElement,
  React.ComponentProps<"div">
>(function ItemContent({ className, ...props }, ref) {
  return (
    <div
      className={cn(
        "flex flex-1 flex-col gap-1 [&+[data-slot=item-content]]:flex-none",
        className
      )}
      data-slot="item-content"
      ref={ref}
      {...props}
    />
  );
});

const ItemTitle = React.forwardRef<HTMLDivElement, React.ComponentProps<"div">>(
  function ItemTitle({ className, ...props }, ref) {
    return (
      <div
        className={cn(
          "flex w-fit items-center gap-2 font-medium text-sm leading-snug",
          className
        )}
        data-slot="item-title"
        ref={ref}
        {...props}
      />
    );
  }
);

const ItemDescription = React.forwardRef<
  HTMLParagraphElement,
  React.ComponentProps<"p">
>(function ItemDescription({ className, ...props }, ref) {
  return (
    <p
      className={cn(
        "line-clamp-2 text-balance font-normal text-muted-foreground text-sm tabular-nums leading-normal",
        "[&>a:hover]:text-primary [&>a]:underline [&>a]:underline-offset-4",
        className
      )}
      data-slot="item-description"
      ref={ref}
      {...props}
    />
  );
});

const ItemActions = React.forwardRef<
  HTMLDivElement,
  React.ComponentProps<"div">
>(function ItemActions({ className, ...props }, ref) {
  return (
    <div
      className={cn("flex items-center gap-2", className)}
      data-slot="item-actions"
      ref={ref}
      {...props}
    />
  );
});

const ItemHeader = React.forwardRef<
  HTMLDivElement,
  React.ComponentProps<"div">
>(function ItemHeader({ className, ...props }, ref) {
  return (
    <div
      className={cn(
        "flex basis-full items-center justify-between gap-2",
        className
      )}
      data-slot="item-header"
      ref={ref}
      {...props}
    />
  );
});

const ItemFooter = React.forwardRef<
  HTMLDivElement,
  React.ComponentProps<"div">
>(function ItemFooter({ className, ...props }, ref) {
  return (
    <div
      className={cn(
        "flex basis-full items-center justify-between gap-2",
        className
      )}
      data-slot="item-footer"
      ref={ref}
      {...props}
    />
  );
});

export {
  Item,
  ItemMedia,
  ItemContent,
  ItemActions,
  ItemGroup,
  ItemSeparator,
  ItemTitle,
  ItemDescription,
  ItemHeader,
  ItemFooter,
};

Installation

npx shadcn@latest add @hextaui/item

Usage

import { Item } from "@/components/ui/item"
<Item />