Skip to content

Commit 1710a5f

Browse files
authored
Merge pull request #1104 from dnum-mi/docs/improve-docs
docs/improve docs
2 parents 81aa680 + e72773d commit 1710a5f

File tree

5 files changed

+42
-22
lines changed

5 files changed

+42
-22
lines changed

src/components/DsfrDataTable/DsfrDataTable.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
## 🌟 Introduction
44

5-
Le composant `DsfrDataTable` est un élément puissant et polyvalent pour afficher des données sous forme de tableaux dans vos applications Vue. Utilisant une combinaison de slots, de props, et d'événements personnalisés, ce composant offre une flexibilité remarquable. Plongeons dans les détails !
5+
Le composant `DsfrDataTable` est un élément puissant et polyvalent pour afficher des données sous forme de tableaux dans vos applications Vue avec une intégration facile du **tri** et de la **pagination**, entre autres. Utilisant une combinaison de slots, de props, et d'événements personnalisés, ce composant offre une flexibilité remarquable. Plongeons dans les détails !
66

77
::: warning Prudence
88

9-
Ce composant est tout neuf et a besoin de vos retours. Son API ne devrait pas changer, elle devrait s’étoffer dans les prochaines semaines ou les prochains mois.
9+
Ce composant est complexe. Son API ne devrait pas changer, elle devrait s’étoffer dans les prochaines semaines ou les prochains mois.
1010

1111
Si vous avez des propositions, veuillez lancer une [**discussion**](https://github.com/dnum-mi/vue-dsfr/discussions) avant d’ouvrir une issue.
1212

src/components/DsfrFooter/DsfrFooter.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ Aucun événement spécifique pour ce composant.
7676

7777
1. `footer-link-lists` : Permet de personnaliser les listes de liens dans la partie supérieure du pied de page.
7878
2. `description` : Pour personnaliser la description dans le corps du pied de page.
79+
3. `footer-partners` : Pour personnaliser les liens vers les partenaires, par défaut est généré grâce à la prop `partners`.
7980

8081
## 📝 Exemple
8182

src/components/DsfrFooter/DsfrFooter.vue

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ const props = withDefaults(defineProps<DsfrFooterProps>(), {
8787
defineSlots<{
8888
'footer-link-lists': () => VNode
8989
description: () => VNode
90+
'footer-partners': () => VNode
9091
}>()
9192
9293
const allLinks = computed(() => {
@@ -218,10 +219,13 @@ const externalOperatorLink = computed(() => {
218219
</ul>
219220
</div>
220221
</div>
221-
<DsfrFooterPartners
222-
v-if="partners"
223-
v-bind="partners"
224-
/>
222+
<!-- @slot Slot #description pour le contenu de la description du footer. Sera dans `<p class="fr-footer__content-desc">` -->
223+
<slot name="footer-partners">
224+
<DsfrFooterPartners
225+
v-if="partners"
226+
v-bind="partners"
227+
/>
228+
</slot>
225229
<div class="fr-footer__bottom">
226230
<ul class="fr-footer__bottom-list">
227231
<li

src/components/DsfrFooter/docs-demo/DsfrFooterDemo.vue

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -40,18 +40,22 @@ const ecosystemLinks = [
4040
{
4141
label: 'legifrance.gouv.fr',
4242
href: 'https://legifrance.gouv.fr',
43+
title: 'Légifrance, nouvelle fenêtre',
4344
},
4445
{
4546
label: 'info.gouv.fr',
4647
href: 'https://info.gouv.fr',
48+
title: 'Informations gouvernementales, nouvelle fenêtre',
4749
},
4850
{
4951
label: 'service-public.fr',
5052
href: 'https://service-public.fr',
53+
title: 'Informations et démarches administratives, nouvelle fenêtre',
5154
},
5255
{
5356
label: 'data.gouv.fr',
5457
href: 'https://data.gouv.fr',
58+
title: 'Plateforme des données publiques, nouvelle fenêtre',
5559
},
5660
]
5761
@@ -71,24 +75,35 @@ app?.appContext.app.use(
7175
],
7276
}),
7377
).component('VIcon', VIcon)
78+
79+
const partners = {
80+
titleTag: 'h5',
81+
title: 'Partenaires',
82+
mainPartner: {
83+
name: 'Partenaire 1',
84+
href: '/partenaire-1',
85+
logo: 'https://loremflickr.com/100/100/cat?random=1',
86+
},
87+
}
7488
</script>
7589

7690
<template>
7791
<DsfrFooter
78-
:before-mandatory-links="beforeMandatoryLinks"
79-
:after-mandatory-links="afterMandatoryLinks"
80-
:a11y-compliance="a11yCompliance"
81-
:logo-text="logoText"
82-
:legal-link="legalLink"
83-
:personal-data-link="personalDataLink"
84-
:cookies-link="cookiesLink"
85-
:a11y-compliance-link="a11yComplianceLink"
86-
:desc-text="descText"
87-
:home-link="homeLink"
88-
:licence-text="licenceText"
89-
:licence-to="licenceTo"
90-
:licence-name="licenceName"
91-
:licence-link-props="licenceLinkProps"
92-
:ecosystem-links="ecosystemLinks"
92+
:before-mandatory-links
93+
:after-mandatory-links
94+
:a11y-compliance
95+
:logo-text
96+
:legal-link
97+
:personal-data-link
98+
:cookies-link
99+
:a11y-compliance-link
100+
:desc-text
101+
:home-link
102+
:licence-text
103+
:licence-to
104+
:licence-name
105+
:licence-link-props
106+
:ecosystem-links
107+
:partners
93108
/>
94109
</template>

src/components/DsfrTable/DsfrTable.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Le composant `DsfrTable` est un élément puissant et polyvalent pour afficher d
88

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

11-
::: warning
11+
::: warning CONSEIL
1212

1313
Pour des tableaux complexes, nous vous recommandons d’utiliser [DsfrDataTable](/composants/DsfrDataTable)
1414

0 commit comments

Comments
 (0)