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 :
- Prospect (
Apollo) pour le B2C, les applications exposées aux prospect (AXA.Fr) - Client (
Look & Feel) pour le B2C, les applications exposées aux clients (Espace client) - Collab-Distrib (
Slash) pour le B2B, les applications internes
Si vous utilisez @axa-fr/react-toolkit et que vous souhaitez migrer vers
@axa-fr/design-system, vous pouvez suivre notre
guide de migration.
Pour tous les univers, les packages sont découpés en deux parties : la partie
-react qui contient les composants React et la partie -css qui contient les
fichiers CSS.
Installation latest
npm install @axa-fr/canopee-react@latest @axa-fr/canopee-css@latestInstallation next
npm install @axa-fr/canopee-react@next @axa-fr/canopee-css@nextDocumentation
Utilisation des nouveaux packages :
import { Button } from '@axa-fr/canopee-react/distributeur';Only CSS :
import '@axa-fr/canopee-css/distributeur/button.css';Documentation
Utilisation des nouveaux packages :
import { Button } from '@axa-fr/canopee-react/prospect';Only CSS :
import '@axa-fr/canopee-css/client/buttonApollo.css';Documentation
Utilisation des nouveaux packages :
import { Button } from '@axa-fr/canopee-react/client';Only CSS :
import '@axa-fr/canopee-css/client/buttonLF.css';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
Les composants Client et Prospect 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.
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 :
packages/canopee-css/src/distributeurpackages/canopee-css/src/prospect-clientpackages/canopee-react/src/distributeurpackages/canopee-react/src/prospect-client
Pour démarrer toutes les parties du projet, il faudra lancer la commande npm run dev.
Pour démarrer la partie Collab-Distrib du projet, il faudra lancer la commande npm run dev:distributeur.
Pour démarrer la partie Client du projet, il faudra lancer la commande npm run dev:client.
Pour démarrer la partie Prospect du projet, il faudra lancer la commande npm run dev:prospect.
Ces commandes démarrent automatiquement les différentes étapes nécessaires au 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.
Et pour build une partie spécifique du projet, vous pouvez lancer npm run build:(partie)
(npm run build:distributeur, npm run build:client ou npm run build:prospect).
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/canopee-react/distributeur';
const App = () => {
return <Svg src={home} />;
};Il suffit d'importer le fichier des tokens dans votre application.
Pour Univers Client :
import '@axa-fr/canopee-css/client/common/tokensLF.css';Pour Univers Prospect :
import '@axa-fr/canopee-css/prospect/common/tokens.css';Pour Univers Collab-Distrib :
import '@axa-fr/canopee-css/distributeur/common/tokens.css';