TP_JO2024/home/dist/core/README.md

57 lines
2.4 KiB
Markdown
Raw Permalink Normal View History

2024-03-27 17:19:37 +01:00
# core
Le package core est utilisé comme fondation du Design System, il contient plusieurs éléments fondamentaux.
### Typographie
Les typographies Marianne® et Spectral sont les typographies officielles de la charte de l'État. Leur usage crée une cohérence entre les interfaces et offre une expérience positive à lutilisateur. Leur respect renforce également la reconnaissance de la parole de lÉtat.
### Icônes
Les icônes fonctionnelles sont des symboles visuels qui accompagnent lutilisateur dans ses actions et qui aident à sa compréhension de linterface.
### Icônes de favoris - Favicon
Licône de favoris est un petit icône associé à un site web. Il permet à lutilisateur de repérer quil se trouve sur un site de l'état.
### Medias
Les médias désignent vos contenus photos et vidéos. Lorsquils sont intégré à une page de contenu, il est recommandé de suivre les règles décrites ci-dessous.
### Grille
La grille proposée par le design system vous permet de structurer vos pages et vos contenus simplement.
## Dépendances
```shell
core
└─ legacy
```
## Utilisation
Afin dutiliser le composant `core`, il est nécessaire dajouter les fichiers de styles et de scripts présents dans le dossier dist dans l'ordre suivant :\n
```html
<html>
<head>
<link href="css/core/core.min.css" rel="stylesheet">
</head>
<body>
<script type="text/javascript" nomodule href="js/legacy/legacy.nomodule.min.js" ></script>
<script type="module" href="js/core/core.module.min.js" ></script>
<script type="text/javascript" nomodule href="js/core/core.nomodule.min.js" ></script>
</body>
</html>
```
## Documentation
Consulter [la documentation](https://www.systeme-de-design.gouv.fr/elements-d-interface/fondamentaux-de-l-identite-de-l-etat/typographie/) sur le module Typographie
Consulter [la documentation](https://www.systeme-de-design.gouv.fr/elements-d-interface/fondamentaux-techniques/icones) sur le module Icônes
Consulter [la documentation](https://www.systeme-de-design.gouv.fr/elements-d-interface/fondamentaux-techniques/icone-de-favoris) sur le module Icônes de favoris - Favicon
Consulter [la documentation](https://www.systeme-de-design.gouv.fr/elements-d-interface/fondamentaux-techniques/medias) sur le module Médias fondamentaux
Consulter [la documentation](https://www.systeme-de-design.gouv.fr/elements-d-interface/fondamentaux-techniques/grille-et-points-de-rupture) sur le module Grille