Link

Overview

Copy the source into your project, then import the parts you need. Styles use local StyleX declarations and shared theme tokens. You can change the source without wrapping or replacing a package.

Installation

Run bunx @yopem-ui/cli init from your project root first. The CLI configures StyleX and installs shared files and dependencies.

bunx @yopem-ui/cli init

bunx @yopem-ui/cli add link

Run from your project root. The CLI installs required components, shared files, and packages. Previews may need additional components. Existing files are preserved. To refresh installed source, use update; locally edited files need an explicit --force to overwrite.

bunx @yopem-ui/cli update link

Preview

import { Link } from "@registry/components/ui/link"

export function Preview() {
  return <Link href="/components">Browse components</Link>
}

Usage

Link renders a native anchor with href, events, ref, and keyboard behavior. Use render={<RouterLink to="/path" />} with TanStack Router or render={<NextLink href="/path" />} with Next.js so the framework handles navigation. Both router components must render an anchor.

Import from the local file installed by the CLI.

"use client"

import { Link } from "@/components/ui/link"
import { Link as RouterLink } from "@tanstack/react-router"

export function Preview() {
  return (
    <Link render={<RouterLink to="/docs/installation" />}>
      Read the documentation
    </Link>
  )
}

API reference

Generated from canonical TypeScript source. Only component and Base UI props appear below. Required marks a required property, not a required component.