Annotations
@CStory
Marque une fonction composable comme une story, démontrant un composant dans le catalogue.
| Paramètre | Type | Requis | Description |
|---|---|---|---|
collection | String | oui | Niveau racine de la navigation du catalogue. |
group | String | oui | Regroupement logique des stories sous une collection. Peut être hiérarchique. |
name | String | oui | Libellé de la story affiché dans la navigation. Ne doit pas contenir /. |
tags | Array<String> | non | Tags optionnels pour la story. |
component | String | non | Référence FQN sûre vers un @CStoryComponent, généralement via CStoryComponentRefs. |
themeWrapper | KClass<*> | non | Objet implémentant CStoriesThemeWrapper, utilisé uniquement pour cette story. |
S'applique à : fonctions @Composable top-level. Any::class signifie que le wrapper du catalogue est utilisé.
@CStoryComponent
Marque une fonction du design system comme un composant documentable, la rendant disponible via l'objet
CStoryComponentRefs généré afin qu'une @CStory puisse la référencer de façon sûre, et affiche son KDoc dans le
panneau de documentation du catalogue.
| Paramètre | Type | Requis | Description |
|---|---|---|---|
namespace | String | non | Namespace optionnel, devant être un identifiant Kotlin valide, utilisé pour imbriquer la référence générée sous CStoryComponentRefs.<namespace>.... Laisser vide pour conserver la référence historique à la racine. |
S'applique à : fonctions top-level, ou fonctions membres d'un objet/companion object.
Voir aussi : Référencer un composant dans une story et Personnaliser le thème du catalogue.