Skip to content

Latest commit

 

History

History
101 lines (70 loc) · 8.35 KB

README.md

File metadata and controls

101 lines (70 loc) · 8.35 KB

AXA France Design System

Le projet design system AXA France a pour objectif de proposer un point d'entrée unique pour utiliser le design system AXA France au sein de vos projets.

Il propose d'utiliser les deux designs systems principaux :

  • Look & Feel pour le B2C, les applications exposées aux clients
  • Slash pour le B2B, les applications internes

Migration depuis @axa-fr/react-toolkit

Si vous utilisez @axa-fr/react-toolkit et que vous souhaitez migrer vers @axa-fr/design-system, vous pouvez suivre notre guide de migration.

Packages

name Storybook npm Documentation UI et UX
@axa-fr/design-system-slash-css Storybook Lien vers npm ZeroHeight Figma
@axa-fr/design-system-slash-react Storybook Lien vers npm ZeroHeight Figma
@axa-fr/design-system-look-and-feel-css Storybook Lien vers npm ZeroHeight Figma
@axa-fr/design-system-look-and-feel-react Storybook Lien vers npm ZeroHeight Figma

Build status

Sonarcloud Quality metrics

Code Smells Reliability Rating Bugs Coverage Technical Debt Security Rating Maintainability Rating

Composants Slash

L'ensemble des composants Slash ont été migrés depuis l'ancien repository Slash, nous vous invitons à migrer vos projets vers ce nouveau package. Vous pouvez consulter notre guide de migration

Composants Look & Feel

Les composants Look & Feel sont également utilisables pour vos projets client mais peuvent être amenés à évoluer. Tous les composants n'ont pas encore été développés, si votre projet a besoin d'un composant non développé, nous vous invitons à créer un issue et à contribuer au Design System.

Vous pouvez suivre son avancement à travers les issues.

Si vous souhaitez contribuer, le fichier CONTRIBUTING.md est là pour vous aiguiller. Vous pouvez également consulter notre Code de conduite.

Structure du projet

Le projet proposera d'utiliser des composants React ou juste la partie CSS avec l'implémentation HTML (ou autres frameworks que vous souhaitez). Vous pouvez retrouver ces deux implémentations dans les dossiers /slash/css et /slash/react.

Démarrer le projet

La commande npm start démarrent automatiquement les différentes étapes nécessaire aux développement du projet, notamment le build CSS et le storybook react.

La commande npm run build permet de générer un build qui vous permettra de tester votre nouveau composant.

Utilisation des icones

Nous vous recommandons d’utiliser la librairie @material-symbols/svg-400, mais n’importe quelle librairie qui exporte les svg de Google Material Symbols, ou vos propres svg fonctionnera.

Exemple :

import home from "@material-symbols/svg-400/outlined/home.svg";
import { Svg } from "@axa-fr/design-system-slash-react/client";

const App = () => {
    return (
        <Svg src={home} />
    )
}

Utilisation des CSS variables (dispo uniquement pour L&F)

Il suffit d'importer le fichier des tokens dans votre application.

Exemple :

import "@axa-fr/design-system-look-and-feel-css/dist/common/tokens.scss";