Sections
Getting Started
Components
- DocTabs
- Callout
- ComponentPreview
- CommandMenu
- CopyButton
- DocsSidebar
- DocsTableOfContents
- PageHeader
- SiteHeader
- CopyCodeButton
- DocsCopyPage
- CodeBlockCommand
- CommandMenuItem
- CommandMenuKbd
- GitHubLink
- LucideIcon
- MainNav
- MobileNav
- ModeSwitcher
- PageHeaderDescription
- PageHeaderHeading
- SiteBody
- SiteConfig
- SiteFooter
- OgImage (Custom)
The PageHeaderDescription component provides styled description text for page headers.
Usage
<script setup lang="ts">
import { PageHeaderDescription } from '@/components/PageHeaderDescription'
</script>
<template>
<PageHeaderDescription>
A brief description of what this page covers.
</PageHeaderDescription>
</template>API Reference
PageHeaderDescription
| Prop | Type | Default | Description |
|---|---|---|---|
class | HTMLAttributes["class"] | undefined | Custom CSS classes |
Styling
- Responsive text sizes:
text-base(mobile),sm:text-lg(desktop) - Max width:
max-w-3xl - Text balance for better wrapping
- Foreground color
Related Components
PageHeader- Parent containerPageHeaderHeading- Heading component