ENFR0.1.0-rc.3

Composants

Le vocabulaire fixe utilisable dans les pages .md et .mdx.


NoteRègles communes

Uniquement en bloc : une ligne vide avant et après chaque balise, et autour de son contenu. Les props sont de simples attributs texte. Les noms respectent la casse. Six niveaux d’imbrication au maximum.

  • <Callout>
  • <Steps>
  • <Step>
  • <Cards>
  • <Card>
  • <Tabs>
  • <Tab>
  • <CodeGroup>
  • <Hero>
  • <Action>
  • <Media>
  • <Install>
  • <StartHere>
  • <Entry>

Callout (encadré)

type vaut note, tip, warning ou danger ; title est facultatif. Un encadré ne peut pas en contenir un autre.

docs/x.mdx
<Callout type="warning" title="Ne mettez pas vos clés dans le navigateur">

Les clés d’API sont secrètes. Utilisez-les depuis la CI ou un serveur.

</Callout>

Steps (étapes)

Uniquement des enfants Step, chacun avec un title. Une étape peut contenir du code et des encadrés.

docs/x.mdx
<Steps>

<Step title="Créer une boîte">

Chaque test obtient sa propre adresse.

</Step>

</Steps>

Cards (cartes)

docs/x.mdx
<Cards>

<Card title="Démarrage rapide" href="./quickstart" description="Premier e-mail en cinq minutes." />

<Card title="Référence API" href="/api" />

</Cards>

Tabs (onglets)

Des label uniques. Sans JavaScript, tous les panneaux s’affichent à la suite ; avec, une liste d’onglets accessible. Pas d’onglets dans des onglets.

docs/x.mdx
<Tabs>

<Tab label="TypeScript">

```typescript
const client = new TestInbox({ apiKey });
```

</Tab>

<Tab label="Python">

```python
client = TestInbox(api_key=key)
```

</Tab>

</Tabs>

Cas particuliers

Une expression comme prop

CONTENT_EXPRESSION_FORBIDDEN
✕ ÉCHOUE
docs/x.mdx
<Callout type={kind}>
✓ CORRECTION
docs/x.mdx
<Callout type="tip">

Les props sont uniquement du texte.

Balise en minuscules ou inconnue

CONTENT_HTML_FORBIDDEN · CONTENT_COMPONENT_UNKNOWN
✕ ÉCHOUE
docs/x.mdx
<callout type="tip">
<Warning>
✓ CORRECTION
docs/x.mdx
<Callout type="warning">

En minuscules, c’est du HTML ; une balise inconnue ne fait pas partie du vocabulaire.

Sans lignes vides

Interprété en ligne
✕ ÉCHOUE
docs/x.mdx
<Callout type="tip">Astuce courte</Callout>
✓ CORRECTION
docs/x.mdx
<Callout type="tip">

Astuce courte

</Callout>

Les composants sont des blocs.

Signaler un problème sur cette page (GitHub)