@brickslab./ui-web
En-tête standard pour les pages de documentation de composants. Affiche le nom en h1, une description, un badge package monospace et des badges supplémentaires configurables. Utilisé par ComponentHeader dans PageSection.tsx.
Minimal
name + description uniquement
Avec packageName
prop packageName — badge monospace brand
Avec badges supplémentaires
prop badges — variantes default · brand · success · warning · error
Props
| Prop | Type | Défaut | Requis | Description |
|---|---|---|---|---|
name | string | — | — | Nom du composant affiché en h1. |
description | string | — | — | Description courte affichée sous le titre (max 640px). |
packageName | string | — | — | Nom du package affiché en badge monospace (ex: @brickslab./ui-web). |
badges | Array<{ label: string; variant?: DocPageHeaderBadgeVariant }> | — | — | Badges supplémentaires — variantes: default · brand · success · warning · error. |
Override rapide
Tous les paramètres listés dans cette table sont overrideables via les props. Utilisez ce squelette comme point de départ.
<MyComponent name="..." description="..." packageName="..." badges="..." />
namedescriptionpackageNamebadges