Jamdesk Documentation logo

Volet extensible

Expandable crée une simple bascule afficher/masquer pour du contenu que les lecteurs pourraient vouloir consulter, mais qui n'est pas essentiel au flux principal.

Utilisez Expandable pour masquer les réponses API verbeuses, les étapes de dépannage ou les détails supplémentaires qui interrompraient autrement le flux de lecture. Il se rend comme un seul élément de divulgation cliquable -- plus léger qu'Accordion, qui est conçu pour des sections groupées et navigables.

Utilisez Expandable lorsque :

  • Les détails supplémentaires interrompraient le récit principal
  • Les informations optionnelles bénéficient à certains lecteurs mais pas à tous
  • Le contenu long (comme les réponses API complètes) doit être réduit par défaut

Utilisation de base

<Expandable title="Show more details">

  These details are hidden by default and revealed when clicked.

</Expandable>

Ouvert par défaut

Commencer développé :

Cette section commence visible.

<Expandable title="Expanded by default" defaultOpen>

  This section starts visible.

</Expandable>

Cas d'utilisation courants

Détails de réponse API

Réduire les réponses verbeuses qui interrompraient autrement le flux de documentation :

Étapes de dépannage

Props

stringrequired

Texte d'en-tête de section.

booleandefault: false

Commencer développé.

Expandable vs Accordion

FonctionnalitéExpandableAccordion
ObjectifMasquer du contenu supplémentaireOrganiser des sections d'égale importance
IcônesNonOui
DescriptionsNonOui (support de sous-titre)
GroupementAutonomePeut être groupé avec AccordionGroup
Idéal pourDétails optionnels, longs exemplesFAQ, listes de fonctionnalités, navigation

Règle générale : Si le contenu est "agréable à avoir", utilisez Expandable. Si les utilisateurs doivent choisir entre des sections, utilisez Accordion.

Et ensuite ?

Vue d'ensemble des composants

Parcourir tous les composants disponibles

Bases MDX

Apprendre à utiliser les composants dans MDX