Skip to content

Commit 0438598

Browse files
committed
docs: 📝 ajoute la doc vitepress de composants
- DsfrShare - DsfrSkipLinks - DsfrStepper - DsfrSummary - DsfrQuote - DsfrHighlight - DsfrCallout
1 parent dacae0b commit 0438598

File tree

17 files changed

+659
-18
lines changed

17 files changed

+659
-18
lines changed

.vitepress/config.ts

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,10 @@ const composants = [
266266
text: 'DsfrPicture',
267267
link: '/composants/DsfrPicture.md',
268268
},
269+
{
270+
text: 'DsfrQuote',
271+
link: '/composants/DsfrQuote.md',
272+
},
269273
{
270274
text: 'DsfrRadioButton',
271275
link: '/composants/DsfrRadioButton.md',
@@ -298,6 +302,22 @@ const composants = [
298302
text: 'DsfrSelect',
299303
link: '/composants/DsfrSelect.md',
300304
},
305+
{
306+
text: 'DsfrSkipLinks',
307+
link: '/composants/DsfrSkipLinks.md',
308+
},
309+
{
310+
text: 'DsfrShare',
311+
link: '/composants/DsfrShare.md',
312+
},
313+
{
314+
text: 'DsfrStepper',
315+
link: '/composants/DsfrStepper.md',
316+
},
317+
{
318+
text: 'DsfrSummary',
319+
link: '/composants/DsfrSummary.md',
320+
},
301321
{
302322
text: 'DsfrTable',
303323
link: '/composants/DsfrTable.md',

.vitepress/theme/style.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,10 @@
199199
width: 100%;
200200
}
201201

202+
.w-90 {
203+
width: 90%;
204+
}
205+
202206
.h-full {
203207
width: 100%;
204208
}

docs/composants.md

Lines changed: 63 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ Le storybook est toujours disponible [ici](https://storybook.vue-ds.fr)
1818
- [DsfrBadge](./composants/DsfrBadge)
1919
- [DsfrTag](./composants/DsfrTag)
2020

21+
## Barre de recherche
22+
23+
- [DsfrSearchBar](./composants/DsfrSearchBar)
24+
2125
## Boutons et contrôles segmentés
2226

2327
- [DsfrButton](./composants/DsfrButton)
@@ -30,58 +34,107 @@ Le storybook est toujours disponible [ici](https://storybook.vue-ds.fr)
3034
- [DsfrCard](./composants/DsfrCard)
3135
- [DsfrTile](./composants/DsfrTile)
3236

37+
## Citation
38+
39+
- [DsfrQuote](./composants/DsfrQuote)
40+
3341
## Consentement
3442

3543
- [DsfrConsent](./composants/DsfrConsent)
3644

37-
## En-tête de page
45+
## Étapier (indicateur d’étape)
46+
47+
- [DsfrStepper](./composants/DsfrStepper)
48+
49+
## En-tête, pied de page et logo
3850

3951
- [DsfrHeader](./composants/DsfrHeader)
4052
- [DsfrHeaderMenuLink](./composants/DsfrHeaderMenuLink)
4153
- [DsfrLanguageSelector](./composants/DsfrLanguageSelector)
54+
- [DsfrFooter](./composants/DsfrFooter)
55+
- [DsfrFooterLink](./composants/DsfrFooterLink)
56+
- [DsfrLogo](./composants/DsfrLogo)
4257

4358
## Fil d’ariane
4459

4560
- [DsfrBreadcrumb](./composants/DsfrBreadcrumb)
4661

4762
## Formulaire (éléments de)
4863

64+
- [DsfrCheckbox](./composants/DsfrCheckbox)
65+
- [DsfrCheckboxSet](./composants/DsfrCheckboxSet)
66+
- [DsfrFieldset](./composants/DsfrFieldset)
4967
- [DsfrFileUpload](./composants/DsfrFileUpload)
5068
- [DsfrFileDownload](./composants/DsfrFileDownload)
5169
- [DsfrInput](./composants/DsfrInput)
70+
- [DsfrInputGroup](./composants/DsfrInputGroup)
5271
- [DsfrRadioButton](./composants/DsfrRadioButton)
5372
- [DsfrRadioButtonSet](./composants/DsfrRadioButtonSet)
54-
- [DsfrCheckbox](./composants/DsfrCheckbox)
55-
- [DsfrCheckboxSet](./composants/DsfrCheckboxSet)
56-
- [DsfrInputGroup](./composants/DsfrInputGroup)
5773
- [DsfrRange](./composants/DsfrRange)
58-
- [DsfrFieldset](./composants/DsfrFieldset)
74+
- [DsfrToggleSwitch](./composants/DsfrToggleSwitch)
75+
76+
## Icône
77+
78+
- [VIcon](./composants/VIcon)
79+
80+
## Image et vidéos
81+
82+
- [DsfrPicture](./composants/DsfrPicture)
83+
- [DsfrVideo](./composants/DsfrVideo)
84+
- [DsfrTranscription](./composants/DsfrTranscription)
5985

6086
## Infobulle (Information contextuelle)
6187

6288
- [DsfrTooltip](./composants/DsfrTooltip)
6389

90+
## Liens d’évitement
91+
92+
- [DsfrSkipLinks](./composants/DsfrSkipLinks)
93+
94+
## Mise en avant et mise en exergue
95+
96+
- [DsfrCallout](./composants/DsfrCallout)
97+
- [DsfrHighlight](./composants/DsfrHighlight)
98+
6499
## Modale
65100

66101
- [DsfrModal](./composants/DsfrModal)
67102

103+
## Notice
104+
105+
- [DsfrNotice](./composants/DsfrNotice)
106+
68107
## Onglets
69108

70109
- [DsfrTabs](./composants/DsfrTabs)
71110

72-
## Pages d’erreurs
111+
## Partage et réseaux sociaux
73112

74-
- [DsfrErrorPage](./composants/DsfrErrorPage)
113+
- [DsfrFollow](./composants/DsfrFollow)
114+
- [DsfrNewsLetter](./composants/DsfrNewsLetter)
115+
- [DsfrSocialNetworks](./composants/DsfrSocialNetworks)
116+
- [DsfrShare](./composants/DsfrShare)
75117

76-
## Pied de page
118+
## Pagination
77119

78-
- [DsfrFooter](./composants/DsfrFooter)
79-
- [DsfrFooterLink](./composants/DsfrFooterLink)
120+
- [DsfrPagination](./composants/DsfrPagination)
121+
122+
## Pages d’erreurs
123+
124+
- [DsfrErrorPage](./composants/DsfrErrorPage)
80125

81126
## Retour en haut de page
82127

83128
- [DsfrBackToTop](./composants/DsfrBackToTop)
84129

130+
## Sommaire
131+
132+
- [DsfrSummary](./composants/DsfrSummary)
133+
134+
## Sélecteur de langage
135+
136+
- [DsfrLanguageSelector](./composants/DsfrLanguageSelector)
137+
85138
## Tableau
86139

87140
Conseillé pour des tableaux complexes :

src/components/DsfrCallout/DsfrCallout.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,20 +30,26 @@ Ce composant ne déclenche pas d'événements personnalisés.
3030

3131
- `default` : Contenu additionnel à afficher à l'intérieur de l'encadré. Ce slot est intégré dans la structure principale du composant et s'affiche sous le texte principal.
3232

33+
## 📝 Exemples
34+
3335
::: code-group
3436

35-
<Story data-title="Démo" min-h="200px">
37+
<Story data-title="Démo" min-h="420px">
3638
<DsfrCalloutDemo />
3739
</Story>
3840

3941
<<< docs-demo/DsfrCalloutDemo.vue [Code de la démo]
42+
:::
43+
44+
## ⚙️ Code source du composant
45+
46+
::: code-group
4047

4148
<<< DsfrCallout.vue
49+
<<< DsfrCallout.types.ts
4250

4351
:::
4452

4553
<script setup lang="ts">
4654
import DsfrCalloutDemo from './docs-demo/DsfrCalloutDemo.vue'
4755
</script>
48-
49-
## ⚙️ Code source du composant

src/components/DsfrHighlight/DsfrHighlight.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Highlight - `DsfrHighlight`
1+
# Mise en exergue - `DsfrHighlight`
22

33
## 🌟 Introduction
44

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Citation - `DsfrQuote`
2+
3+
## 🌟 Introduction
4+
5+
Le composant `DsfrQuote` permet d’afficher une citation stylisée, accompagnée d’un auteur, d’une source, et éventuellement d’une image illustrative. Ce composant respecte les standards du [Design System de l'État Français (DSFR)](https://www.systeme-de-design.gouv.fr/) pour offrir une présentation élégante et accessible.
6+
7+
🏅 La documentation sur les liens d’évitement le [DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/citation)
8+
9+
<VIcon name="vi-file-type-storybook" /> La story sur les liens d’évitement sur le storybook de [VueDsfr](https://storybook.vue-ds.fr/?path=/docs/composants-dsfrquote--docs)
10+
11+
## 📐 Structure
12+
13+
Le composant affiche :
14+
15+
- Une citation (`<blockquote>`) avec un lien optionnel vers la source.
16+
- Une légende (`<figcaption>`) contenant :
17+
- Le nom de l’auteur.
18+
- La source de la citation, accompagnée d’un lien ou de détails supplémentaires.
19+
- Une image optionnelle, destinée à illustrer visuellement la citation.
20+
21+
## 🛠️ Props
22+
23+
| Nom | Type | Défaut | Description |
24+
|--------------|-----------------------------------|--------------|-----------------------------------------------------------------------------|
25+
| `quote` | `string` | `undefined` | Texte de la citation. |
26+
| `author` | `string` | `undefined` | Nom de l’auteur de la citation. |
27+
| `details` | `{ label: string, url: string }[]`| `[]` | Détails supplémentaires sous forme de liste (liens ou texte). |
28+
| `source` | `string` | `''` | Nom de la source de la citation. |
29+
| `sourceUrl` | `string` | `''` | URL de la source, utilisée pour l’attribut `cite` du bloc de citation. |
30+
| `quoteImage` | `string` | `''` | URL de l’image illustrative associée à la citation. |
31+
32+
## 📡 Événements
33+
34+
Aucun événement spécifique n'est émis par ce composant.
35+
36+
## 🧩 Slots
37+
38+
Aucun slot disponible pour ce composant.
39+
40+
## 📝 Exemples
41+
42+
### Exemple de base
43+
44+
```vue
45+
<DsfrQuote
46+
quote="L'accessibilité numérique est un droit fondamental."
47+
author="Tim Berners-Lee"
48+
source="W3C"
49+
sourceUrl="https://www.w3.org/"
50+
:details="[
51+
{ label: 'Voir le site officiel', url: 'https://www.w3.org/' }
52+
]"
53+
quoteImage="https://www.example.com/image.jpg"
54+
/>
55+
```
56+
57+
### Exemple complet
58+
59+
::: code-group
60+
61+
<Story data-title="Démo" min-h="120px">
62+
<DsfrQuoteDemo />
63+
</Story>
64+
65+
<<< docs-demo/DsfrQuoteDemo.vue [Code de la démo]
66+
67+
:::
68+
69+
## ⚙️ Code source du composant
70+
71+
::: code-group
72+
73+
<<< DsfrQuote.vue
74+
<<< DsfrQuote.types.ts
75+
76+
:::
77+
78+
<script setup lang="ts">
79+
import DsfrQuoteDemo from './docs-demo/DsfrQuoteDemo.vue'
80+
</script>
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<script lang="ts" setup>
2+
import DsfrQuote from '../DsfrQuote.vue'
3+
4+
const quote = 'LA citation'
5+
const author = 'Pierre-Louis EGAUD'
6+
const details = [
7+
{
8+
url: 'https://www.wikipedia.fr',
9+
label: 'wikipedia',
10+
},
11+
]
12+
const source = 'Duckduckgo'
13+
const sourceUrl = 'https://www.duckduckgo.com'
14+
const quoteImage = 'https://loremflickr.com/g/150/150/cat?random=1'
15+
</script>
16+
17+
<template>
18+
<DsfrQuote
19+
:quote="quote"
20+
:author="author"
21+
:details="details"
22+
:source="source"
23+
:source-url="sourceUrl"
24+
:quote-image="quoteImage"
25+
/>
26+
</template>

0 commit comments

Comments
 (0)