Skip to content
MIZU.

LinkCard

A destination with enough context to decide whether to follow it.

View .md

Live — this one is real

Usage

tsx
import { LinkCard } from "mizu-ui";

export function Example() {
  return (
    <LinkCard
      href="/components/getting-started"
      title="Build with Mizu"
      description="Install the package, bring the styles and compose your first interface."
    />
  );
}

Source & setup

Add this component to your project with the shadcn CLI. The command copies its source into your configured UI directory, with base.css, Mizu’s tokens, and the stylesheets that hold its rules. Each rule lives in one stylesheet, so components you add together never repeat CSS. In a project without a components.json, run npx shadcn@latest init 0xuser64bit/mizu/preset first: plain init installs shadcn’s theme into your global CSS. Then load the fonts.

sh
npx shadcn@latest add 0xuser64bit/mizu/link-card

Every component imports from its own path, its name in kebab case. Its source, content/Typography.tsx, also holds Kbd, CodeBlock, Quote, Prose and FileCard. Each has its own command and path; adding one after this copies only its small entry file. To paste the example, replace its mizu-ui import with:

tsx
import { LinkCard } from "@/components/ui/mizu/link-card";

For npm imports, import mizu-ui/styles.css once. Fonts are optional via mizu-ui/fonts.css. Override --mizu-* tokens or use className for local styling. Uses native React and CSS; install the package peers for root imports. A Server Component: it renders on the server, with no client JavaScript of its own.

Inspect content/Typography.tsx

Source is included in the npm package under src/content/Typography.tsx.

Open full source ↗

Props

PropTypeDefaultDescription
href / titlestring—Real destination and visible link title.
description / eyebrowstring—Supporting context.
...propsAnchorHTMLAttributes—Native link behavior.

Accessibility

A single native anchor, no nested interactive elements. Open-in-new-tab behavior remains browser-owned.

Motion

CSS transitions explain state changes. Reduced motion removes travel.

Works alongside