Skip to content

Commit dacae0b

Browse files
committed
docs: 📝 ajoute de la documentation pour logo
1 parent 5c3c371 commit dacae0b

File tree

3 files changed

+95
-0
lines changed

3 files changed

+95
-0
lines changed

.vitepress/config.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,10 @@ const composants = [
242242
text: 'DsfrLanguageSelector',
243243
link: '/composants/DsfrLanguageSelector.md',
244244
},
245+
{
246+
text: 'DsfrLogo',
247+
link: '/composants/DsfrLogo.md',
248+
},
245249
{
246250
text: 'DsfrModal',
247251
link: '/composants/DsfrModal.md',
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Logo - `DsfrLogo`
2+
3+
## 🌟 Introduction
4+
5+
Le composant `DsfrLogo` est utilisé pour afficher le logo institutionnel du Gouvernement français, en respectant les spécifications du [Design System de l'État Français (DSFR)](https://www.systeme-de-design.gouv.fr/). Ce composant permet d'afficher un texte simple ou multi-lignes représentant le logo, avec des options pour ajuster la taille.
6+
7+
<VIcon name="vi-file-type-storybook" /> La story sur Logo sur le storybook de [VueDsfr](https://storybook.vue-ds.fr/?path=/docs/composants-dsfrlogo--docs)
8+
9+
## 📐 Structure
10+
11+
Le composant affiche un élément `<p>` avec la classe CSS `fr-logo`, et des classes supplémentaires pour les variations de taille. Le texte du logo peut être personnalisé pour répondre à vos besoins.
12+
13+
## 🛠️ Props
14+
15+
| Nom | Type | Défaut | Description |
16+
|-------------|---------------------|-----------------|-----------------------------------------------------------------------------|
17+
| `small` | `boolean` | `false` | Affiche le logo en petite taille (`fr-logo--sm`). |
18+
| `large` | `boolean` | `false` | Affiche le logo en grande taille (`fr-logo--lg`). |
19+
| `logoText` | `string | string[]` | `'Gouvernement'` | Texte ou tableau de textes à afficher comme logo. Les éléments du tableau sont séparés par un saut de ligne (`<br>`). |
20+
21+
## 📡 Événements
22+
23+
Aucun événement spécifique n'est émis par ce composant.
24+
25+
## 🧩 Slots
26+
27+
Aucun slot disponible pour ce composant.
28+
29+
## 📝 Exemples
30+
31+
### Exemple de base
32+
33+
```vue
34+
<DsfrLogo />
35+
```
36+
37+
Résultat : Affiche le texte "Gouvernement" avec le style par défaut.
38+
39+
### Exemple avec un texte personnalisé
40+
41+
```vue
42+
<DsfrLogo logoText="République Française" />
43+
```
44+
45+
Résultat : Affiche le texte "République Française".
46+
47+
### Exemple avec un texte sur plusieurs lignes
48+
49+
```vue
50+
<DsfrLogo :logoText="['Ministère de', 'l\'Éducation Nationale']" />
51+
```
52+
53+
### Exemple complet
54+
55+
::: code-group
56+
57+
<Story data-title="Démo" min-h="150px">
58+
<DsfrLogoDemo />
59+
</Story>
60+
61+
<<< docs-demo/DsfrLogoDemo.vue [Code de la démo]
62+
63+
:::
64+
65+
## ⚙️ Code source du composant
66+
67+
::: code-group
68+
69+
<<< DsfrLogo.vue
70+
<<< DsfrLogo.types.ts
71+
72+
:::
73+
74+
<script setup lang="ts">
75+
import DsfrLogoDemo from './docs-demo/DsfrLogoDemo.vue'
76+
</script>
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<script lang="ts" setup>
2+
import DsfrLogo from '../DsfrLogo.vue'
3+
4+
const logoText = ['République', 'Française']
5+
const small = false
6+
const large = false
7+
</script>
8+
9+
<template>
10+
<DsfrLogo
11+
:small="small"
12+
:large="large"
13+
:logo-text="logoText"
14+
/>
15+
</template>

0 commit comments

Comments
 (0)