website: better gaufre docs for mobile usage
This commit is contained in:
6
website/package-lock.json
generated
6
website/package-lock.json
generated
@@ -1478,9 +1478,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@gouvfr-lasuite/integration": {
|
"node_modules/@gouvfr-lasuite/integration": {
|
||||||
"version": "0.1.6",
|
"version": "0.1.8",
|
||||||
"resolved": "https://registry.npmjs.org/@gouvfr-lasuite/integration/-/integration-0.1.6.tgz",
|
"resolved": "https://registry.npmjs.org/@gouvfr-lasuite/integration/-/integration-0.1.8.tgz",
|
||||||
"integrity": "sha512-0VEmnpVgGlJazcEzqR3zIY7j3jCotNIh8vb5g9bG6X9ZEUNYt59ydgNfoGXKIOY8aOY7VPreRIY3q9uEx8l3tA==",
|
"integrity": "sha512-zB4bIrXpHUbx9hihbP3WxHVFm5HijErSXg1I9XAIu82PVssbMFvkwR/tH+yPUC+52zZP4pQUHsWM+yoJ1yykOA==",
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"@types/react": "*",
|
"@types/react": "*",
|
||||||
"@types/react-dom": "*",
|
"@types/react-dom": "*",
|
||||||
|
|||||||
@@ -20,7 +20,7 @@
|
|||||||
"@astrojs/starlight": "^0.21.5",
|
"@astrojs/starlight": "^0.21.5",
|
||||||
"@fastify/cors": "^9.0.1",
|
"@fastify/cors": "^9.0.1",
|
||||||
"@fastify/static": "^7.0.3",
|
"@fastify/static": "^7.0.3",
|
||||||
"@gouvfr-lasuite/integration": "^0.1.6",
|
"@gouvfr-lasuite/integration": "^0.1.8",
|
||||||
"@types/prismjs": "^1.26.3",
|
"@types/prismjs": "^1.26.3",
|
||||||
"@types/react": "^18.3.1",
|
"@types/react": "^18.3.1",
|
||||||
"@types/react-dom": "^18.3.0",
|
"@types/react-dom": "^18.3.0",
|
||||||
|
|||||||
BIN
website/src/content/docs/guides/dsfr-gaufre.png
Normal file
BIN
website/src/content/docs/guides/dsfr-gaufre.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 10 KiB |
@@ -32,6 +32,16 @@ Ce guide est à suivre pour intégrer la Gaufre sur toute page autre que
|
|||||||
Le bouton Gaufre est destiné à être présent dans le coin supérieur droit de la page de votre page
|
Le bouton Gaufre est destiné à être présent dans le coin supérieur droit de la page de votre page
|
||||||
web afin d'être toujours placé au même endroit quelque soit le service.
|
web afin d'être toujours placé au même endroit quelque soit le service.
|
||||||
|
|
||||||
|
### Sur écran mobile/tablette
|
||||||
|
|
||||||
|
Sur petit écran, il est préférable d'afficher le bouton Gaufre en dehors d'un potentiel menu burger
|
||||||
|
existant, à gauche du menu burger :
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Si pour quelconque raison ceci n'est pas possible, rajoutez un élément dans votre menu burger pour
|
||||||
|
accéder aux services de La Suite (voir section [bouton customisé](#bouton-customisé)).
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### 1. HTML
|
### 1. HTML
|
||||||
@@ -48,6 +58,12 @@ function MonComposant() {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Vous pouvez passer une prop `variant` au composant Gaufre pour changer l'affichage du bouton :
|
||||||
|
|
||||||
|
- `variant="responsive"` : le bouton s'affiche plus petit sur écran mobile/tablette
|
||||||
|
- `variant="small"` : le bouton s'affiche plus petit, tout le temps. **Ceci est la variante
|
||||||
|
recommandée si vous utilisez une entête DSFR**.
|
||||||
|
|
||||||
:::note
|
:::note
|
||||||
|
|
||||||
Même en utilisant React, vous devrez charger le CSS et le JS manuellement. Ce petit travail
|
Même en utilisant React, vous devrez charger le CSS et le JS manuellement. Ce petit travail
|
||||||
@@ -62,6 +78,23 @@ Si vous n'utilisez pas React, utilisez le HTML présent dans le paquet :
|
|||||||
|
|
||||||
<Code code={gaufreHtml} lang="html" title="@gouvfr-lasuite/integration/dist/html/gaufre.html" />
|
<Code code={gaufreHtml} lang="html" title="@gouvfr-lasuite/integration/dist/html/gaufre.html" />
|
||||||
|
|
||||||
|
- ajouter une classe `lasuite-gaufre-btn--responsive` pour afficher le bouton plus petit sur écran
|
||||||
|
mobile/tablette
|
||||||
|
- ajouter une classe `lasuite-gaufre-btn--small` pour afficher le bouton plus petit, tout le temps.
|
||||||
|
**Ceci est recommandé si vous utilisez une entête DSFR**.
|
||||||
|
|
||||||
|
#### Dans une entête DSFR
|
||||||
|
|
||||||
|
Si vous intégrez le bouton Gaufre dans un projet suivant le DSFR :
|
||||||
|
|
||||||
|
- rajoutez le bouton en 1er enfant de `div.fr-header__navbar` pour que le bouton s'affiche à gauche
|
||||||
|
du menu burger sur petit écran,
|
||||||
|
- puis en dernier élément de la liste `.fr-header__tools > .fr-header__tools-links > .fr-btns-group`
|
||||||
|
pour que le bouton s'affiche en haut à droite de l'écran sur grand écran.
|
||||||
|
|
||||||
|
N'oubliez pas d'utiliser la classe `lasuite-gaufre-btn--small` pour que la taille du bouton
|
||||||
|
corresponde avec le reste de l'entête.
|
||||||
|
|
||||||
### 2. CSS
|
### 2. CSS
|
||||||
|
|
||||||
Le CSS nécessaire est présent dans `@gouvfr-lasuite/integration/dist/css/gaufre.css`. Il est à
|
Le CSS nécessaire est présent dans `@gouvfr-lasuite/integration/dist/css/gaufre.css`. Il est à
|
||||||
@@ -102,6 +135,23 @@ l'enlevez pas en copiant l'exemple !
|
|||||||
|
|
||||||
:::
|
:::
|
||||||
|
|
||||||
|
## Bouton customisé
|
||||||
|
|
||||||
|
Si vous ne voulez pas utiliser le bouton Gaufre standard, vous pouvez créer votre propre bouton avec
|
||||||
|
vos propres styles.
|
||||||
|
|
||||||
|
Cela est nécessaire si vous voulez par exemple avoir une ligne "Services de La Suite" dans un menu
|
||||||
|
burger : aucun HTML n'est proposé pour ça, tant il dépend de votre site.
|
||||||
|
|
||||||
|
- ⚠ pour que le bouton fonctionne, il doit avoir une classe `js-lasuite-gaufre-btn` pour que le
|
||||||
|
JavaScript d'initialisation détecte votre bouton,
|
||||||
|
- parmi les classes CSS fournis, vous pouvez réutiliser `lasuite-gaufre-mask-element` ou
|
||||||
|
`lasuite-gaufre-mask` qui appliquent l'icône de la Gaufre via un `mask-image` à l'instar des
|
||||||
|
icones dans le DSFR,
|
||||||
|
- ℹ le bouton standard ne s'affiche que si le script de la Gaufre a réussi à charger. Pour avoir le
|
||||||
|
même comportement sur votre propre implémentation, vous pouvez vous appuyer sur la présence de la
|
||||||
|
classe `lasuite--gaufre-loaded` sur la balise `html`.
|
||||||
|
|
||||||
## Exemple
|
## Exemple
|
||||||
|
|
||||||
[La Gaufre : exemple HTML](/examples/gaufre/html).
|
[La Gaufre : exemple HTML](/examples/gaufre/html).
|
||||||
|
|||||||
Binary file not shown.
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 22 KiB |
Reference in New Issue
Block a user