Logoshadcn-docs-template
DocsDemo
Sections
  • Get Started
Getting Started
  • Introduction
  • Installation
Customization
  • Customizing the Template
  • MDC Components
  • Composables
  • Writing Documentation
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)

PageHeaderDescription

PreviousNext

A description component for page headers with responsive typography.

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

PropTypeDefaultDescription
classHTMLAttributes["class"]undefinedCustom 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 container
  • PageHeaderHeading - Heading component
ModeSwitcherPageHeaderHeading

On This Page

UsageAPI ReferencePageHeaderDescriptionStylingRelated Components
© shadcn-vue.com