Skip to content

Commit

Permalink
fix(DsfrTranscription): importe DsfrModal
Browse files Browse the repository at this point in the history
Sans cet import, il faut que le développeur import lui-même DsfrModal et l’enregistre globalement.
  • Loading branch information
laruiss committed Sep 15, 2024
1 parent c987386 commit 54bddcf
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,10 @@ const composants = [
text: 'DsfrTooltip',
link: '/composants/DsfrTooltip.md',
},
{
text: 'DsfrTranscription',
link: '/composants/DsfrTranscription.md',
},
{
text: 'DsfrVideo',
link: '/composants/DsfrVideo.md',
Expand Down
58 changes: 58 additions & 0 deletions src/components/DsfrTranscription/DsfrTranscription.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Transcription - `DsfrTranscription`

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

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

## 🌟 Introduction

Le composant `DsfrTranscription` est conçu pour afficher la transcription du contenu d'une vidéo. Il permet aux utilisateurs d'accéder facilement au texte de la vidéo, offrant ainsi une meilleure accessibilité. Le composant peut afficher la transcription dans une section extensible ou dans une fenêtre modale pour une lecture plus confortable.

Le `DsfrTranscription` peut afficher la transcription dans une section extensible ou la charger dans une fenêtre modale grâce à l'utilisation du composant `DsfrModal` et du `Teleport` pour un rendu à l'extérieur de la hiérarchie DOM parent.

## 📐 Structure

- `<DsfrTranscription>` : Le composant principal.
- Contient un bouton pour afficher ou masquer la transcription.
- Affiche la transcription dans une section extensible ou une fenêtre modale.

## 🛠️ Props

| Propriété | Type | Description | Valeur par défaut |
|-----------|----------|------------------------------------------------------------|-------------------------------------|
| `id` | `string` | ID unique pour le composant, utilisé pour l'accessibilité. | `getRandomId('transcription')` |
| `title` | `string` | Titre de la transcription. | `'Titre de la vidéo'` |
| `content` | `string` | Contenu de la transcription. | `'Transcription du contenu de la vidéo'` |

## 📡 Événements

Ce composant ne déclenche pas d'événements spécifiques.

## 🧩 Slots

- `default` : Slot pour insérer du contenu personnalisé à la place de la transcription par défaut.

## 📝 Exemples

::: code-group

<Story data-title="Démo" min-h="400px">
<DsfrTranscriptionDemo />
</Story>

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

:::

## ⚙️ Code source du composant

::: code-group

<<< DsfrTranscription.vue
<<< DsfrTranscription.types.ts

:::

<script setup lang="ts">
import DsfrTranscriptionDemo from './docs-demo/DsfrTranscriptionDemo.vue'
</script>
2 changes: 2 additions & 0 deletions src/components/DsfrTranscription/DsfrTranscription.vue
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import { computed, ref, watch } from 'vue'
import { useCollapsable } from '../../composables'
import { getRandomId } from '../../utils/random-utils'
import DsfrModal from '../DsfrModal/DsfrModal.vue'
import type { DsfrTranscriptionProps } from './DsfrTranscription.types'
export type { DsfrTranscriptionProps }
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<script lang="ts" setup>
import DsfrTranscription from '../DsfrTranscription.vue'
const title = 'Titre de la transcription'
const content = 'Contenu de la transcription'
</script>

<template>
<DsfrTranscription
:title="title"
:content="content"
/>
</template>

0 comments on commit 54bddcf

Please sign in to comment.