Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: 📝 création de la documentation vitepress pour dsfrconsent #714

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ const composants = [
text: 'DsfrCard',
link: '/composants/DsfrCard.md',
},
{
text: 'DsfrConsent',
link: '/composants/DsfrConsent.md',
},
{
text: 'DsfrRange',
link: '/composants/DsfrRange.md',
Expand Down
70 changes: 70 additions & 0 deletions src/components/DsfrConsent/DsfrConsent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# Gestionnaire de consentement - `DsfrConsent`

## 🌟 Introduction

Le gestionnaire de consentement permet à l'utilisateur de définir ses préférences sur l'utilisation de ses données personnelles, notamment le dépôt de cookies non fonctionnels dans son navigateur.

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

<VIcon name="vi-file-type-storybook" /> La story du gestionnaire de consentement sur le storybook de [VueDsfr](https://vue-dsfr.netlify.app/?path=/docs/composants-dsfrconsent--docs)

## 📐 Structure

Le gestionnaire de consentement est constitué des éléments suivants :

- une description, le composant en propose une générique et le `slot` par défaut permet d'en personnaliser une et de contenir tout type d'élément,
- un lien (prop **`url`**, de type `string`), correspondant au chemin menant aux "Données personnelles et cookies" de votre site ou application.

## 🛠️ Les props

| nom | type | défaut | obligatoire |
| ----------------------- | --------- | ---------------- | -------- |
| `url` | *`string`* | `''` | |

## 📡 Les événements

`DsfrConsent` dispose de trois boutons qui déclenchent chacun un évènement spécifique au clic permettant à l'utilisateur de l'attraper afin de déclencher une fonction correspondante.

| nom | donnée (*payload*) | détail de la donnée |
| ---------------------- | -------------------- | -------------------- |
| `'accept-all'` | | |
| `'refuse-all'` | | |
| `'customize'` | | |

## 🧩 Les slots

`DsfrConsent` possède un slot par défaut pour laisser la possibilité à l'utilisateur d'ajouter une description personnalisée.

```vue{6,15,16,25,26}
<template>
<DsfrConsent>
<p>
Nous avons recours à plusieurs cookies afin d'améliorer votre
expérience sur cette application. Vos données vous appartiennent
et ce bandeau vous permet de sélectionner les cookies que vous
souhaitez activer. Pour plus d'informations, consultez notre page
<a :href="url">Données personnelles et cookies</a>.
</p>
</DsfrConsent>
</template>
```

Cf. la [documentation Vue](https://vuejs.org/guide/essentials/event-handling.html#accessing-event-argument-in-inline-handlers) pour plus de détails.

## 📝 Un exemple complet

::: code-group

<Story data-title="Démo" min-h="200px">
<DsfrConsentDemo />
</Story>

<<< docs-demo/DsfrConsentDemo.vue [Code de la démo]

<<< DsfrConsent.vue

:::

<script setup lang="ts">
import DsfrConsentDemo from './docs-demo/DsfrConsentDemo.vue'
</script>
2 changes: 1 addition & 1 deletion src/components/DsfrConsent/DsfrConsent.stories.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export default {
},
url: {
control: 'text',
description: '',
description: 'Url de la page concernant les "Données personnelles et cookies" sur votre site ou application.',
},
'accept-all': {
description: 'Évenement émis lors du clic sur le bouton \'Tout accepter\'',
Expand Down
24 changes: 24 additions & 0 deletions src/components/DsfrConsent/docs-demo/DsfrConsentDemo.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<script lang="ts" setup>
import DsfrConsent from '../DsfrConsent.vue'

const AcceptAllCookies = () => {}
const RefuseAllCookies = () => {}
const CustomizeCookies = () => {}

</script>

<template>
<DsfrConsent
@accept-all="AcceptAllCookies()"
@refuse-all="RefuseAllCookies()"
@customize="CustomizeCookies()"
>
<p>
Nous avons recours à plusieurs cookies afin d'améliorer votre
expérience sur cette application. Vos données vous appartiennent
et ce bandeau vous permet de sélectionner les cookies que vous
souhaitez activer. Pour plus d'informations, consultez notre page
<a href="/donnees">Données personnelles et cookies</a>.
</p>
</DsfrConsent>
</template>
Loading