GC Design System Components is a monorepo managing the web components of the GC Design System. Web components are encapsulated, reusable custom elements you can use within your web sites/apps. Along with the gcds-components packages, there are additional packages for React and Angular to ease integration into those popular frameworks.
We are using Stencil.js to build our web components.
You can find the full documentation for GC Design System Components on https://design-system.alpha.canada.ca/.
- Clone the repo
git clone https://github.com/cds-snc/gcds-components. - Run
npm installto install all Node.js dependencies. - Run
npm run buildto compile all three packages (web components, react and angular).
You can test the Angular and React packages locally as this repository is setup using lerna which uses npm workspaces under the hood. Npm workspaces automatically handles the linking of dependent packages on npm install so there is no need to manually use npm link.
In the root directory, run npm run build. All five packages will be compiled.
| Package | Description | Docs |
|---|---|---|
| @cdssnc/gcds-components | GC Design System Components | Docs |
| @cdssnc/gcds-components-react | GC Design System Components – React | Docs |
| @cdssnc/gcds-components-angular | GC Design System Components – Angular | Docs |
| @cdssnc/gcds-components-vue | GC Design System Components – Vue | Docs |
| @cdssnc/gcds-components-react-ssr | GC Design System Components – React SSR | Docs |
If you are interested in contributing to GC Design System Components, please read our contributing guidelines.
Code released under the MIT License.
« GC Design System Components » (Composants de Système de design GC) est un référentiel unique qui gère les composants Web de Système de design GC. Les composants Web sont des éléments personnalisés, encapsulés et réutilisables pouvant être utilisés dans vos sites et applications Web. En plus des paquets gcds-components, il existe des paquets supplémentaires pour React et Angular qui favorisent l’intégration de ceux-ci dans les infrastructures populaires.
Nous utilisons Stencil.js pour créer nos composants Web.
Toute la documentation sur les composants de Système de design GC est accessible à l’adresse https://systeme-design.alpha.canada.ca/.
- Copiez le référentiel
git clone https://github.com/cds-snc/gcds-components. - Exécutez ensuite
npm installpour installer toutes les dépendances Node.js. - Finalement, exécutez
npm run buildpour compiler les trois paquets (composants Web, React et Angular).
Vous pouvez tester localement les paquets Angular et React puisque ce référentiel est configuré à l’aide de lerna, qui utilise npm workspaces à la base. Npm workspaces gère automatiquement la liaison de paquets dépendants à l’exécution de npm install, donc nul besoin d’exécuter manuellement npm link.
Dans le répertoire racine, exécutez npm run build. Les cinq paquets seront alors compilés.
| Paquet | Description | Docs |
|---|---|---|
| @cdssnc/gcds-components | Composants de Système de design GC | Docs |
| @cdssnc/gcds-components-react | Composants de Système de design GC — React | Docs |
| @cdssnc/gcds-components-angular | Composants de Système de design GC — Angular | Docs |
| @cdssnc/gcds-components-vue | Composants de Système de design GC — Vue | Docs |
| @cdssnc/gcds-components-react-ssr | Composants de Système de design GC – React SSR | Docs |
Si vous souhaitez contribuer aux unités de style de Système de design GC, veuillez lire nos lignes directrices sur la contribution.
Code publié en vertu de la licence MIT (en anglais).