Skip to content
Unkey Design Docs
Esc
navigateopen⌘Jpreview
On this page

Item

A versatile component used for displaying content like media, links and howto information.

import { BookOpen, ChartUsage, ChevronRight } from "@unkey/icons";
import {
  Button,
  Item,
  ItemActions,
  ItemContent,
  ItemDescription,
  ItemMedia,
  ItemTitle,
} from "@unkey/ui";

export default function BasicItem() {
  return (
    <div className="flex flex-col gap-4">
      <Item>
        <ItemContent>
          <ItemTitle>Basic Item</ItemTitle>
          <ItemDescription>A simple item with title and description.</ItemDescription>
        </ItemContent>
        <ItemActions>
          <Button variant="outline">Action</Button>
        </ItemActions>
      </Item>
      <Item
        variant="outline"
        render={
          <a href="/primitives/item">
            <ItemMedia>
              <ChartUsage />
            </ItemMedia>
            <ItemContent>
              <ItemTitle>Usage</ItemTitle>
              <ItemDescription>Track your spend and usage across Unkey.</ItemDescription>
            </ItemContent>
            <ItemActions>
              <ChevronRight />
            </ItemActions>
          </a>
        }
      />
      <Item
        variant="outline"
        render={
          <a href="/primitives/item">
            <ItemMedia>
              <BookOpen />
            </ItemMedia>
            <ItemContent>
              <ItemTitle>Docs</ItemTitle>
              <ItemDescription>How plans, usage and invoices work.</ItemDescription>
            </ItemContent>
            <ItemActions>
              <ChevronRight />
            </ItemActions>
          </a>
        }
      />
    </div>
  );
}

Examples

import { ChartUsage, ChevronRight } from "@unkey/icons";
import { Item, ItemActions, ItemContent, ItemDescription, ItemMedia, ItemTitle } from "@unkey/ui";

export default function InternalLinkItem() {
  return (
    <Item
      variant="outline"
      render={
        <a href="/primitives/item">
          <ItemMedia>
            <ChartUsage />
          </ItemMedia>
          <ItemContent>
            <ItemTitle>Usage</ItemTitle>
            <ItemDescription>Track your spend and usage across Unkey</ItemDescription>
          </ItemContent>
          <ItemActions>
            <ChevronRight />
          </ItemActions>
        </a>
      }
    />
  );
}
import { ArrowUpRight, BookOpen } from "@unkey/icons";
import {
  Item,
  ItemActions,
  ItemContent,
  ItemDescription,
  ItemMedia,
  ItemTitle,
  VisuallyHidden,
} from "@unkey/ui";

export default function ExternalLinkItem() {
  return (
    <Item
      variant="outline"
      render={
        <a href="https://unkey.com/docs" target="_blank" rel="noopener noreferrer">
          <ItemMedia>
            <BookOpen />
          </ItemMedia>
          <ItemContent>
            <ItemTitle>
              Documentation
              <VisuallyHidden> (opens in a new tab)</VisuallyHidden>
            </ItemTitle>
            <ItemDescription>How plans, usage and invoices work</ItemDescription>
          </ItemContent>
          <ItemActions>
            <ArrowUpRight />
          </ItemActions>
        </a>
      }
    />
  );
}