Component
Link
Navigates to another page or resource.
Install
Run the CLI to copy the source into your project.
pnpm dlx @stalk-ui/cli add @stalk-ui/linkExamples
Live previews render through the docs app's PandaCSS codegen.
<Link href="#">View documentation</Link>
<Link href="#" underline="always"> Always underlined </Link>
<Text> Read the <Link href="#">getting started guide</Link> first. </Text>
Props
Public component props extracted from the source TypeScript types.
| Prop | Type | Required | Default | Description |
|---|---|---|---|---|
| `asChild` | `boolean` | No | - | Render the child element instead of an \`<a>\` (e.g. a router Link). |
| `tone` | `Tone` | No | - | Selects the semantic color palette. Defaults to \`accent\`. |
| `underline` | `LinkUnderline` | No | - | Underline behaviour. Defaults to \`hover\`. |
Variants
Variant axes exposed by the underlying PandaCSS recipe or slot recipe.
| Variant | Values |
|---|---|
| `underline` | `none`, `hover`, `always` |
Registry
Files this component contributes to your registry install.
- Manifest: `/r/link.json`
- Recipe: `link`
- Files: `src/components/ui/link.tsx`