@lab-anssi/ui-kit 1.37.2 → 1.38.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -29,7 +29,7 @@ Le projet s’appuie sur des outils modernes tels que SvelteKit, Vite, Storybook
|
|
|
29
29
|
- Svelte (version recommandée : >= 5.37.3)
|
|
30
30
|
- Vite (version recommandée : >= 7.0.6)
|
|
31
31
|
- Storybook (version recommandée : >= 9.1.1)
|
|
32
|
-
-
|
|
32
|
+
- pnpm (voir la version exacte spécifiée dans le `package.json`)
|
|
33
33
|
|
|
34
34
|
### Développement en local
|
|
35
35
|
|
|
@@ -38,7 +38,7 @@ Clonez le dépôt puis installez les dépendances :
|
|
|
38
38
|
```bash
|
|
39
39
|
git clone https://github.com/betagouv/lab-anssi-ui-kit.git
|
|
40
40
|
cd lab-anssi-ui-kit
|
|
41
|
-
|
|
41
|
+
pnpm install
|
|
42
42
|
```
|
|
43
43
|
|
|
44
44
|
### Documentation interactive
|
|
@@ -49,7 +49,7 @@ Les stories sont regroupées dans le dossier `stories/` et sont écrites en resp
|
|
|
49
49
|
Pour explorer et tester les composants en local, lancez Storybook à l'aide de la commande :
|
|
50
50
|
|
|
51
51
|
```bash
|
|
52
|
-
|
|
52
|
+
pnpm run storybook:dev
|
|
53
53
|
```
|
|
54
54
|
|
|
55
55
|
Suite à l'exécution de cette commande, Storybook se lancera automatiquement en ouvrant une fenêtre de votre navigateur par défaut vers l'url [http://localhost:6006](http://localhost:6006).
|
|
@@ -60,12 +60,12 @@ Suite à l'exécution de cette commande, Storybook se lancera automatiquement en
|
|
|
60
60
|
## Usage
|
|
61
61
|
|
|
62
62
|
L'intégralité des composants présents dans ce dépôts sont publiés sur NPM afin qu'ils puissent être consommés dans différents environnements front-end.<br/>
|
|
63
|
-
La bibliothèque expose ses composants dans un dossier `dist/` qui est construit à l'aide de la commande `
|
|
63
|
+
La bibliothèque expose ses composants dans un dossier `dist/` qui est construit à l'aide de la commande `pnpm run build`.
|
|
64
64
|
|
|
65
65
|
Ainsi, pour pouvoir consommer les éléments de cette librairie dans votre projet, vous devrez commencer par installer le package à l'aide de cette commande :
|
|
66
66
|
|
|
67
67
|
```bash
|
|
68
|
-
|
|
68
|
+
pnpm add -D @lab-anssi/ui-kit@latest
|
|
69
69
|
```
|
|
70
70
|
|
|
71
71
|
Vous pouvez ensuite importer les composants dans vos projets **Svelte** ou utiliser les **WebComponents** générés dans n’importe quelle application web.
|
|
@@ -93,7 +93,7 @@ Une fois cet import effectué, les WebComponents sont prêts à être consommés
|
|
|
93
93
|
## Release
|
|
94
94
|
|
|
95
95
|
- Mettre à jour le `package.json` avec la nouvelle version
|
|
96
|
-
- Exécuter `
|
|
96
|
+
- Exécuter `pnpm install`
|
|
97
97
|
- Faire un commit et une PR `[VERSION] Passe à la version X.X.X`
|
|
98
98
|
- Valider la PR puis la merger
|
|
99
99
|
- Dans `GitHub > Release` cliquer sur le bouton `Draft a new release`
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
function noOp() { }
|