Skip to content

LinkCard

Link-styled card with an optional leading icon, title, and description. Title and icon shift to primary on hover.

Installation

npx @cloudflare/nimbus-docs add link-card

Preview

<LinkCard
title="Getting started"
description="Five-minute intro to scaffolding a docs site."
href="#"
icon="ph:rocket-launch"
/>

Examples

Title only

Skip the description when the title is self-explanatory.

<LinkCard title="Changelog" href="#" />

With description

Add a description to clarify what the reader gets by following the link.

<LinkCard
title="API reference"
description="Every endpoint, parameter, and response shape."
href="#"
/>

API reference

Every prop the component accepts, sourced from a single declaration.

PropType
titlerequired
string
description
string
hrefrequired
string
icon
string
Components

Type to search…

↑↓ navigate↵ selectEsc close