shieldcn
Docs
Studio
Showcase
Sponsor
jal-co/shieldcn606
shieldcn

Member of the Vercel OSS Program

Analytics provided by OpenPanel

Monitored by Sentry

Powered by Neon.

Community

GitHubjal-co/uiStatsllms.txtPrivacyContact

Product

DocumentationAPI ReferenceToken PoolGeneratorAgent Skill

inspired by shields.io and badgen.net

Made with in by Justin Levine

shieldcn
Docs
Studio
Showcase
Sponsor
jal-co/shieldcn606

Search documentation

Search all badge providers, guides, and reference docs.

Getting Started

IntroductionREADME StudioCLIAgent SkillNewSelf-HostingAPI ReferenceToken PoolSponsor

Badges

Badge GroupStatic BadgeDynamic JSONHTTPS Endpoint

Charts

OverviewStar history

Headers

OverviewGenerator

Sponsors

OverviewGenerator

Contributors

OverviewGenerator
OverviewReadmeBadgeReadmeBadgeRowBadgePreview
shieldcn

Member of the Vercel OSS Program

Analytics provided by OpenPanel

Monitored by Sentry

Powered by Neon.

Community

GitHubjal-co/uiStatsllms.txtPrivacyContact

Product

DocumentationAPI ReferenceToken PoolGeneratorAgent Skill

inspired by shields.io and badgen.net

Made with in by Justin Levine

BadgePreview

Visual badge preview with live rendering and copyable code snippet.

Installation

pnpm dlx shadcn@latest add @shieldcn/badge-preview

Usage

import { BadgePreview } from "@/components/badge-preview"

Basic preview

<BadgePreview src="https://shieldcn.dev/npm/react.svg" alt="React" />

With code snippet

Shows a copyable code block below the badge preview.

![React](https://shieldcn.dev/npm/react.svg?variant=branded)

With label

![stars](https://shieldcn.dev/github/stars/vercel/next.js.svg?variant=outline)

Dark and light modes

/npm/react.svg
/npm/react.svg?mode=light

Variant grid

Use BadgePreviewGroup and BadgePreviewCard to show multiple variants:

/npm/react.svg
/npm/react.svg?variant=branded
/npm/react.svg?variant=outline
/npm/react.svg?variant=ghost

API Reference

BadgePreview

PropType

On This Page

InstallationUsageBasic previewWith code snippetWith labelDark and light modesVariant gridAPI Reference