Skip to content

Commit 495479b

Browse files
committed
docs: 📝 égaye et homogénéise la doc de DsfrCard
1 parent a1501e3 commit 495479b

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed
Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
# Carte - `DsfrCard`
22

3+
## 🌟 Introduction
4+
35
La carte c'est tout simplement l'indispensable pour agrémenter vos sites et applications d'amuse-bouches esthétiques vers des contenus proposés. Il s'agit d'un composant permettant un aperçu d'une page et un lien vers cette dernière. Elle fait généralement partie d'une liste menant vers des contenus similaires.
46

57
La carte existe en trois tailles (LG, MD, SM) et deux formats (horizontal et vertical) déclinés sur deux supports (desktop et mobile), vous trouverez forcément votre bonheur ! Les cartes horizontales sont réservées au desktop (en mobile, une carte horizontale devient verticale).
68

7-
## Structure
9+
🏅 La documentation sur la carte sur le [DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/carte)
10+
11+
<VIcon name="vi-file-type-storybook" /> La story sur la carte sur le storybook de [VueDsfr](https://vue-dsfr.netlify.app/?path=/docs/composants-dsfrcard--docs)
12+
13+
## 📐 Structure
814

915
Une carte digne de ce nom se compose des éléments suivants :
1016

@@ -14,7 +20,7 @@ Une carte digne de ce nom se compose des éléments suivants :
1420
- une zone destinée à d'éventuels détails (prop **`detail`**, de type `string`).
1521
- une description (prop **`description`**, de type `string`), de 5 lignes maximum (tronquée au-delà).
1622
- une icône illustrative (par défaut, une flèche) - optionnelle peut se désactiver (prop **`noArrow`**, de type `boolean`).
17-
- une zone d’action, composée de boutons (prop **`buttons`**, un tableau d'objets pouvant contenir les props à passer à chaque bouton (cf le composant `DsfrButton` afin de connaître les props à passer)).
23+
- une zone d’action, composée de boutons (prop **`buttons`**, un tableau d'objets pouvant contenir les props à passer à chaque bouton (cf. le composant [`DsfrButton`](/composants/DsfrButton) afin de connaître les props à passer)).
1824
- une zone d’action, composée de liens (prop **`linksGroup`**, un tableau d'objets composé de la propriété **`label`** (`string`),et de **`link`** (`string`) s'il s'agit d'un lien interne au site ou à l'application, ou de **`href`** (`string`) s'il s'agit d'un lien externe).
1925

2026
Autres props :
@@ -24,24 +30,24 @@ Autres props :
2430
- l'orientation de la carte (verticale par défaut) (prop **`horizontal`**, de type `boolean`) pour la basculer à l'horizontal.
2531
- une variante de carte indiquant que l’évènement de clic lancera un téléchargement (prop **`download`**, de type `boolean`).
2632

27-
## Les props
33+
## 🛠️ Les props
2834

2935
| nom | type | défaut | obligatoire |
3036
| ---------------------- | --------- | --------------- | ------------------ |
3137
| `altImg` | *`string`* | `''` | |
3238
| `buttons` | *`object`* | `[]` | |
3339
| `detail` | *`string`* | `''` | |
34-
| `description` | *`string`* | `''` | :white_check_mark: |
40+
| `description` | *`string`* | | |
3541
| `download` | *`boolean`* | `false` | |
3642
| `horizontal` | *`boolean`* | `false` | |
3743
| `imgSrc` | *`string`* | `''` | |
3844
| `link` | *`string`* | `''` | |
3945
| `linksGroup` | *`object`* | `[]` | |
4046
| `size` | *`string`* | `'md'` | |
41-
| `title` | *`string`* | `''` | :white_check_mark: |
47+
| `title` | *`string`* | | |
4248
| `titleTag` | [*`TitleTag`*](/docs/types.md#title-tag "'h1' \| 'h2' \| 'h3' \| 'h4' \| 'h5' \| 'h6'") | `'h3'` | |
4349

44-
## Un exemple complet
50+
## 📝 Un exemple complet
4551

4652
<Story data-title="Démo" min-h="530px">
4753
<DsfrCardDemo />
@@ -51,4 +57,4 @@ Autres props :
5157

5258
<script setup lang="ts">
5359
import DsfrCardDemo from './docs-demo/DsfrCardDemo.vue'
54-
</script>
60+
</script>

0 commit comments

Comments
 (0)