Aller au contenu principal

Annotations

@CStory

Marque une fonction composable comme une story, démontrant un composant dans le catalogue.

ParamètreTypeRequisDescription
collectionStringouiNiveau racine de la navigation du catalogue.
groupStringouiRegroupement logique des stories sous une collection. Peut être hiérarchique.
nameStringouiLibellé de la story affiché dans la navigation. Ne doit pas contenir /.
tagsArray<String>nonTags optionnels pour la story.
componentStringnonRéférence FQN sûre vers un @CStoryComponent, généralement via CStoryComponentRefs.
themeWrapperKClass<*>nonObjet 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ètreTypeRequisDescription
namespaceStringnonNamespace 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.