Skip to content

Commit 66561de

Browse files
committed
docs: 📝 ajoute info importantes pour OhVueIcon et DSFR
- ajoute l’addon storybook pour l’accessibilité
1 parent c592a41 commit 66561de

File tree

5 files changed

+87
-32
lines changed

5 files changed

+87
-32
lines changed

.storybook/main.ts

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,18 @@
1-
import type { StorybookConfig } from "@storybook/vue3-vite";
1+
import type { StorybookConfig } from '@storybook/vue3-vite';
22

33
const config: StorybookConfig = {
4-
stories: ["../src/**/*.mdx", "../src/**/*.stories.@(js|jsx|mjs|ts|tsx)"],
4+
stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
55
addons: [
6-
"@storybook/addon-links",
7-
"@storybook/addon-essentials",
8-
"@storybook/addon-interactions",
9-
"@storybook/addon-themes",
10-
"@storybook/addon-styling",
11-
{
12-
name: '@storybook/addon-postcss',
13-
options: {
14-
postcssLoaderOptions: {
15-
implementation: require('postcss'),
16-
}
17-
}
18-
},
6+
'@storybook/addon-links',
7+
'@storybook/addon-essentials',
8+
'@storybook/addon-interactions',
9+
'@storybook/addon-themes',
10+
'@storybook/addon-a11y',
11+
'@storybook/addon-styling',
1912
],
2013
staticsDir: ['../public'],
2114
framework: {
22-
name: "@storybook/vue3-vite",
15+
name: '@storybook/vue3-vite',
2316
options: {},
2417
},
2518
docs: {

package-lock.json

Lines changed: 60 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@
7878
"@cypress/vite-dev-server": "^5.0.6",
7979
"@cypress/vue": "^6.0.0",
8080
"@rushstack/eslint-patch": "^1.3.3",
81+
"@storybook/addon-a11y": "^7.5.3",
8182
"@storybook/addon-essentials": "^7.5.3",
8283
"@storybook/addon-interactions": "^7.5.3",
8384
"@storybook/addon-links": "^7.5.3",

src/components/DsfrAccordion/DsfrAccordion.stories.ts

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -256,25 +256,24 @@ export const AccordeonAvecCheckbox = (args) => ({
256256
},
257257

258258
template: `
259-
<dsfr-accordions-group>
259+
<DsfrAccordionsGroup>
260260
<li
261261
v-for="(accordion, name) in accordions"
262262
:id="\`accordion_${name}\`"
263263
:key="name"
264264
>
265-
<dsfr-accordion
265+
<DsfrAccordion
266266
:id="name"
267267
:title="name"
268268
:expanded-id="expandedId"
269269
@expand="id => expandedId = id"
270270
>
271-
<dsfr-checkbox-set
271+
<DsfrCheckboxSet
272272
:options="accordion.options"
273-
small
274273
/>
275-
</dsfr-accordion>
274+
</DsfrAccordion>
276275
</li>
277-
</dsfr-accordions-group>
276+
</DsfrAccordionsGroup>
278277
`,
279278
})
280279
AccordeonAvecCheckbox.args = {

src/stories/docs/02-guide.stories.mdx

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { Meta } from '@storybook/addon-docs';
1+
import { Meta } from '@storybook/addon-docs'
22

33
<Meta title="Docs/2. Guide d’utilisation" />
44

@@ -39,22 +39,22 @@ Et suivez le guide !
3939

4040
#### Utiliser la bibliothèque en tant que plugin
4141

42-
| Notes : |
43-
|:---------------------------|
44-
| Pour utiliser cette bibliothèque, il vous faudra **[Vue 3](https://v3.vuejs.org/)** (et **[Vue-Router 4](https://next.router.vuejs.org/)**). Par conséquent, si vous utilisez Nuxt, il vous faut **[Nuxt 3](https://v3.nuxtjs.org/)** (plus de détails plus loin). |
45-
| Il est fortement conseillé d’utiliser **[Vite](https://vitejs.dev)** plutôt que Vue-CLI. |
42+
<div class="fr-alert fr-alert--sm fr-alert--info"><p style={{margin: 0}}><strong>Note :</strong> Pour utiliser cette bibliothèque, il vous faudra **[Vue 3](https://v3.vuejs.org/)** (et **[Vue-Router 4](https://next.router.vuejs.org/)**). Par conséquent, si vous utilisez Nuxt, il vous faut **[Nuxt 3](https://v3.nuxtjs.org/)** (plus de détails plus loin).</p></div>
4643

47-
#### Installer la bibliothèque en tant que dépendance du projet
44+
#### Installer les bibliothèques en tant que dépendances du projet
4845

4946
Afin d'installer la bibliothèque, taper cette commande dans votre console au sein du répertoire du projet :
5047

5148
```shell
52-
npm install @gouvminint/vue-dsfr
49+
npm install @gouvfr/dsfr @gouvminint/vue-dsfr
5350
```
5451

55-
#### Ajouter le plugin
52+
<div class="fr-alert fr-alert--sm fr-alert--info" style={{'margin-bottom': '1rem'}}><p style={{margin: 0}}><strong>Note :</strong> La bibliothèque VueDsfr utilise le CSS de `@gouvfr/dsfr`, c’est pourquoi il est nécessaire de l’installer.</p></div>
5653

57-
##### Dans une application Vite (recommandé) ou Vue-CLI
54+
55+
##### Ajouter le plugin
56+
57+
###### Dans une application Vite
5858

5959
À partir d'un fichier `main.js` simple comme celui-ci :
6060

@@ -82,7 +82,7 @@ const app = createApp(App)
8282
.mount('#app')
8383
```
8484

85-
##### Dans nuxt 3
85+
###### Dans nuxt 3
8686

8787
La bibliothèque VueDsfr fournit bien plusieurs build (esm et umd entre autres) et Nuxt3 sait lequel choisir.
8888

@@ -131,6 +131,7 @@ import {
131131
DsfrCard,
132132
} from '@gouvminint/vue-dsfr' // Imports nommés de la bibliothèque
133133

134+
import { OhVueIcon } from 'oh-vue-icons' // Import de OhVueIcon, dont dépendent certains composants de VueDsfr
134135
import '@gouvfr/dsfr/dist/dsfr.min.css' // Import des styles du DSFR
135136
import '@gouvminint/vue-dsfr/styles' // Import des styles propres à la bibliothèque VueDSFR
136137

@@ -139,6 +140,7 @@ const app = createApp(App)
139140
.component('DsfrButton', DsfrButton) // Enregistrement global du composant DsfrButton
140141
.component('DsfrBreadcrumb', DsfrBreadcrumb) // Enregistrement global du composant DsfrBreadcrumb
141142
.component('DsfrCard', DsfrCard) // Enregistrement global du composant DsfrCard
143+
.component('VIcon', OhVueIcon) // Enregistrement global du composant VIcon, dont dépendent certains composants de VueDsfr
142144
.mount('#app')
143145
```
144146

0 commit comments

Comments
 (0)