Skip to content

Commit 8f34e51

Browse files
committed
docs: 📝 améliore la documentation
- amélioration de la documentation de l’infobulle - homogénéisation de la documentation des composants
1 parent 824f9e2 commit 8f34e51

File tree

75 files changed

+398
-338
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+398
-338
lines changed

demo-app/views/AppHome.vue

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<script setup>
1+
<script setup lang="ts">
22
import pDebounce from 'p-debounce'
33
import { ref, watch } from 'vue'
44
@@ -71,6 +71,27 @@ const onClick = () => {
7171
}
7272
7373
const activeAccordion = ref(-1)
74+
75+
const selection = ref([])
76+
const headers = [
77+
{
78+
key: 'id',
79+
label: 'ID',
80+
},
81+
{
82+
key: 'name',
83+
label: 'Name',
84+
},
85+
{
86+
key: 'email',
87+
label: 'Email',
88+
},
89+
]
90+
const rows = [
91+
[1, 'John Doe', 'john.doe@gmail.com'],
92+
[2, 'Jane Doe', 'jane.doe@gmail.com'],
93+
[3, 'James Bond', 'james.bond@mi6.gov.uk'],
94+
]
7495
</script>
7596

7697
<template>
@@ -126,6 +147,36 @@ const activeAccordion = ref(-1)
126147
</DsfrAccordion>
127148
</DsfrAccordionsGroup>
128149
</div>
150+
<div>
151+
<DsfrDataTable
152+
v-model:selection="selection"
153+
title="Titre du tableau (caption)"
154+
:headers-row="headers"
155+
:rows="rows"
156+
selectable-rows
157+
sortable-rows
158+
:row-key="0"
159+
>
160+
<template #cell="{ colKey, cell }">
161+
<template v-if="colKey === 'email'">
162+
<DsfrTooltip
163+
content="Envoyer un courriel"
164+
on-hover
165+
>
166+
<a :href="`mailto:${cell as string}`">{{ cell }}</a>
167+
</DsfrTooltip>
168+
</template>
169+
<template v-else>
170+
<DsfrTooltip
171+
:content="`(${colKey})`"
172+
on-hover
173+
>
174+
{{ cell }}
175+
</DsfrTooltip>
176+
</template>
177+
</template>
178+
</DsfrDataTable>
179+
</div>
129180

130181
<div class="flex justify-between w-full relative">
131182
<DsfrTooltip
@@ -148,7 +199,7 @@ const activeAccordion = ref(-1)
148199
<AsyncButton
149200
:is-loading="isLoading"
150201
:disabled="disabled"
151-
@click="onClick($event)"
202+
@click="onClick()"
152203
>
153204
Cliquer pour voir un chargement
154205
</AsyncButton>

docs/gabarit-doc-composant.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Tuile - `DsfrTile`
22

3-
## 🌟 Introduction
3+
## 🌟Introduction
44

55
La tuile est un raccourci ou point d’entrée qui redirige les utilisateurs vers des pages de contenu. Elle fait généralement partie d'une collection ou liste de tuiles similaires. La tuile n’est jamais présentée de manière isolée.
66

@@ -10,7 +10,7 @@ Le composant `DsfrTile` est une tuile flexible et stylisée, idéale pour affich
1010

1111
<VIcon name="vi-file-type-storybook" /> La story sur la tuile sur le storybook de [VueDsfr](https://storybook.vue-ds.fr/?path=/docs/composants-dsfrtile--docs)
1212

13-
## 📐 Structure
13+
## 📐Structure
1414

1515
- `<DsfrTile>` : Le composant principal.
1616
- Affiche un titre, une description, des détails et un pictogramme (image ou SVG).
@@ -39,15 +39,15 @@ Le composant `DsfrTile` est une tuile flexible et stylisée, idéale pour affich
3939
| `noBackground` | `boolean` | Si vrai, n'affiche pas de fond dans la tuile. | `false` |
4040
| `grey` | `boolean` | Si vrai, affiche un fond gris pour la tuile. | `false` |
4141

42-
## 📡 Événements
42+
## 📡Événements
4343

4444
Ce composant ne déclenche pas d'événements spécifiques.
4545

46-
## 🧩 Slots
46+
## 🧩Slots
4747

4848
- `header` : Slot pour insérer du contenu personnalisé dans l'en-tête de la tuile.
4949

50-
## 📝 Exemples
50+
## 📝Exemples
5151

5252
Section vide comme demandé.
5353

docs/guide/guide-developpeur.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Vous devriez voir 20.x.x
9595
- Faire des demandes dans [discussions](https://github.com/dnum-mi/vue-dsfr/discussions)
9696
- Rejoindre le [server Discord](https://discord.gg/jbBJ9769ZZ)
9797

98-
### À propos des pull-requests
98+
### Àpropos des pull-requests
9999

100100
Les commits doivent suivre la spécification des **[Commits Conventionnels](https://www.conventionalcommits.org/fr/v1.0.0/)** afin que
101101
l’outil de release automatique détecte les nouvelles fonctionnalités et les corrections d’anomalies.

src/components/DsfrAccordion/DsfrAccordion.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Accordéon - `DsfrAccordion`
22

3-
## 🌟 Introduction
3+
## 🌟 Introduction
44

55
Les accordéons permettent aux utilisateurs d'afficher et de masquer des sections de contenu présentés dans une page.
66

77
🏅 La documentation sur l’accordéon sur le [DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/accordeon)
88

99
<VIcon name="vi-file-type-storybook" /> La story sur l’accordéon sur le storybook de [VueDsfr](https://storybook.vue-ds.fr/?path=/docs/composants-dsfraccordion--docs)
1010

11-
## 📐 Structure
11+
## 📐 Structure
1212

1313
Un accordéon est constitué des éléments suivants :
1414

@@ -30,7 +30,7 @@ Autres props :
3030
| `titleTag` | [*`TitleTag`*](/docs/types.md#title-tag) | `'h3'` | |
3131
| `id` | *`string`* | *random string* | |
3232

33-
## 📡 Évenements
33+
## 📡Évenements
3434

3535
Pas d'événements spécifiques émis directement par ce composant.
3636

@@ -39,11 +39,11 @@ Pas d'événements spécifiques émis directement par ce composant.
3939
- **`title`** : Slot pour le contenu personnalisé du titre de l’accordéon. Si non utilisé, le texte fourni via la prop `title` sera utilisé.
4040
- **`default`** : Slot pour le contenu principal de l'accordéon, affiché dans la section repliable.
4141

42-
## Utilisation
42+
## 📝 Exemples
4343

4444
Ce composant peut être utilisé uniquement avec [`DsfrAccordionsGroup`](/composants/DsfrAccordionsGroup).
4545

46-
## ️ Code source du composant
46+
## ️Code source du composant
4747

4848
::: code-group
4949
<<< DsfrAccordion.vue

src/components/DsfrAccordion/DsfrAccordionsGroup.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Groupe d’accordéons - `DsfrAccordionsGroup`
22

3-
## 🌟 Introduction
3+
## 🌟 Introduction
44

55
Le composant `DsfrAccordionsGroup` permet de regrouper plusieurs accordéons en une seule unité cohérente. Il gère la logique de sélection active entre les accordéons enfants, permettant ainsi d'ouvrir un accordéon tout en fermant les autres. Ce composant est essentiel pour organiser des ensembles d'accordéons liés de manière interactive.
66

@@ -16,7 +16,7 @@ Le composant `DsfrAccordionsGroup` agit comme un conteneur pour les composants d
1616
|-------------|------|------------|-------------|
1717
| `modelValue` | `number` | `-1` | Index de l'accordéon actuellement actif. Cette prop est utilisée pour le contrôle externe de l'accordéon ouvert (un seul peut être ouvert à la fois). |
1818

19-
## 📡 Événements
19+
## 📡Événements
2020

2121
| Nom de l'Événement | Payload | Description |
2222
|--------------------|---------|-------------|
@@ -26,11 +26,11 @@ Le composant `DsfrAccordionsGroup` agit comme un conteneur pour les composants d
2626
Il est donc possible (et recommandé) d’utiliser la directive `v-model` sur ce composant.
2727
:::
2828

29-
## 🧩 Slots
29+
## 🧩 Slots
3030

3131
- **`default`** : Slot par défaut pour le contenu du groupe d'accordéons. Ce slot contiendra les composants `DsfrAccordion` enfants.
3232

33-
## 📝 Exemple
33+
## 📝 Exemple
3434

3535
::: code-group
3636

src/components/DsfrAlert/DsfrAlert.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Alertes - `DsfrAlert`
22

3-
## 🌟 Introduction
3+
## 🌟 Introduction
44

55
Les alertes permettent d’attirer l’attention de l’utilisateur sur une information sans interrompre sa tâche en cours.
66

src/components/DsfrBackToTop/DsfrBackToTop.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Retour en haut de page - `DsfrBackToTop`
22

3-
## 🌟 Introduction
3+
## 🌟 Introduction
44

55
Bonjour et bienvenue à cette page de documentation incroyablement utile (et légèrement humoristique) pour notre composant `DsfrBackToTop`. Ce composant est votre meilleur ami pour permettre aux utilisateurs de remonter en haut de la page avec style et élégance. Et oui, même dans le monde du code, la classe, ça compte !
66

@@ -19,10 +19,6 @@ Si il y a des bloc de poursuite de lecture (liens vers d’autres articles), il
1919

2020
<VIcon name="vi-file-type-storybook" /> La story sur le retour en haut de page sur le storybook de [VueDsfr](https://storybook.vue-ds.fr/?path=/docs/composants-dsfrbacktotop--docs)
2121

22-
## Aperçu
23-
24-
`DsfrBackToTop` est un composant simple mais chic, permettant d'ajouter un lien de retour en haut de la page dans vos applications Vue. Il intègre un style distinctif et des options de positionnement pour s'adapter parfaitement à votre mise en page.
25-
2622
## 🛠️ Props
2723

2824
Notre composant est assez flexible et comprend les props suivantes :
@@ -45,7 +41,7 @@ Afin de le faire fonctionner correctement, il est nécessaire d’ajouter l’at
4541

4642
:::
4743

48-
## Exemple d'Utilisation
44+
## 📝 Exemple
4945

5046
Voici un petit exemple pour vous montrer comment utiliser `DsfrBackToTop` dans votre application :
5147

src/components/DsfrBadge/DsfrBadge.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Badges - `DsfrBadge`
22

3-
## 🌟 Introduction
3+
## 🌟 Introduction
44

55
Le `DsfrBadge` est le super-héros des petites étiquettes ! Ce composant Vue est idéal pour afficher des informations courtes et importantes, comme des catégories, des étiquettes ou des statuts. C'est comme le fromage sur votre pizza : petit mais essentiel !
66

77
🏅 La documentation sur le badge sur le [DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/badge)
88

99
<VIcon name="vi-file-type-storybook" /> La story sur le badge sur le storybook de [VueDsfr](https://storybook.vue-ds.fr/?path=/docs/composants-dsfrbadge--docs)
1010

11-
## 📐 Structure
11+
## 📐 Structure
1212

1313
- Le composant est un élément `p` avec la classe `fr-badge`.
1414
- Props permettent de modifier l'apparence du badge selon les props : type (), présence d'icône, taille et gestion du texte trop long.

src/components/DsfrBreadcrumb/DsfrBreadcrumb.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Fil d’ariane - `DsfrBreadcrumb`
22

3-
## 🌟 Introduction
3+
## 🌟 Introduction
44

55
Bienvenue à la documentation du composant DsfrBreadcrumb ! Ce composant est un véritable GPS pour vos interfaces utilisateur, guidant les utilisateurs à travers les différents niveaux de votre application avec aisance et élégance. Utilisons TypeScript et Vue pour explorer ses fonctionnalités.
66

@@ -27,15 +27,15 @@ Dans l’ordre, il se compose des éléments suivants :
2727
| navigationLabel | String | `'vous êtes ici :'` | Label affiché sur la balise `nav` du fil d’Ariane. |
2828
| showBreadcrumbLabel | String | `'Voir le fil d’Ariane'` | Label du bouton d'affichage du fil d’Ariane. |
2929

30-
## 📡 Évenements
30+
## 📡Évenements
3131

3232
Ce composant n'émet pas directement d'événements, mais vous pouvez écouter les événements de clic sur les liens individuels si nécessaire.
3333

34-
## 🧩 Slots
34+
## 🧩 Slots
3535

3636
Pas de slots définis pour `DsfrBreadcrumb`. Le contenu est entièrement géré via les props.
3737

38-
## 📝 Exemples
38+
## 📝 Exemples
3939

4040
Voici un exemple d'utilisation de DsfrBreadcrumb  :
4141

src/components/DsfrButton/DsfrButton.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# DsfrButton
22

3-
## 🌟 Introduction
3+
## 🌟 Introduction
44

55
Le bouton est un élément d’interaction avec l’interface permettant à l’utilisateur d’effectuer une action.
66

@@ -26,19 +26,19 @@ Les boutons sont composés de :
2626
| `label` | `string` | `undefined`| | Étiquette textuelle du bouton. Si le label est laissé à undefined, le slot par défaut doit contenir du texte ! |
2727
| `onClick` | `Function` | `() => {}` | | Fonction appelée lors du clic sur le bouton. |
2828

29-
## 📡 Évenements
29+
## 📡Évenements
3030

3131
- `click` : Émis lorsque le bouton est cliqué.
3232

33-
## 🧩 Slots
33+
## 🧩 Slots
3434

3535
- `default` : Emplacement pour le contenu personnalisé du bouton. Inséré dans `<button class="fr-btn"><span">`.
3636

37-
## Les groupes de boutons
37+
##  Les groupes de boutons
3838

3939
Cf. [documentation dédiée](/composants/DsfrButtonGroup)
4040

41-
## 📝 Exemples
41+
## 📝 Exemples
4242

4343
Un bouton large avec une icône 'maison' à gauche et le texte 'Accueil' :
4444

0 commit comments

Comments
 (0)