@cdssnc/gcds-components NPM

GC Design System Components

GC Design System Components are encapsulated reusable custom elements to use within your web sites/apps built using the GC Design System Tokens.

Documentation

You can find the full documentation for GC Design System Components on https://design-system.alpha.canada.ca/.

Installation

Install from npm

npm install @cdssnc/gcds-components

Install with CDN

Add the code

Use the latest version of GC Design System. Pinned versions provide stability and predictability because the code will remain consistent and won't change unexpectedly, which can be crucial for maintaining the stability of an application. However, it requires manual updating of the CDN links whenever a newer version of GC Design System is released.

Place the following code in the <head> element of your site. Replace <version-number> with the latest version number to receive corresponding updates.

<!-- GC Design System -->
<link
  rel="stylesheet"
  href="https://cdn.design-system.alpha.canada.ca/@cdssnc/gcds-components@<version-number>/dist/gcds/gcds.css"
/>
<script
  type="module"
  src="https://cdn.design-system.alpha.canada.ca/@cdssnc/gcds-components@<version-number>/dist/gcds/gcds.esm.js"
></script>

Note: <script type="module"> requires a server to load properly, if developing locally, please use <script nomodule>.

Automatic updates using `@latest`

Use the @latest version of GC Design System to receive automatic updates whenever a new version is released. While it removes the need to manually update the CDN links, it adds the risk of introducing breaking changes to the codebase as new versions are automatically applied.

Supported frameworks

The gcds-component library works in multiple frameworks.

Javascript

Place the following code in the <head> element of your site.

<!-- GC Design System -->
<link
  rel="stylesheet"
  href="/node_modules/@cdssnc/gcds-components/dist/gcds/gcds.css"
/>
<script
  type="module"
  src="/node_modules/@cdssnc/gcds-components/dist/gcds/gcds.esm.js"
></script>

All gcds-components should now be ready to use in your site.

React

Please reference GC Design System Components – React

Angular

Please reference GC Design System Components – Angular

Vue

Place the following code in the main.js file of your app.

import {
  applyPolyfills,
  defineCustomElements,
} from '@cdssnc/gcds-components/loader';
import '@cdssnc/gcds-components/dist/gcds/gcds.css';

applyPolyfills().then(() => {
  defineCustomElements();
});

All gcds-components should now be ready to use in your Vue app.

How to contribute

If you are interested in contributing to GC Design System Components, please read our contributing guidelines.

License

Code released under the MIT License.

Composants de Système de design GC

Composants de Système de design GC fournit des éléments personnalisables, encapsulés et réutilisables. Ils peuvent être employés dans vos sites et applications Web créés à l’aide des unités de style de Système de design GC.

Documentation

Toute la documentation sur les composants de Système de design GC est accessible à l’adresse https://systeme-design.alpha.canada.ca/.

Installation

Installer le paquet avec npm

npm install @cdssnc/gcds-components

Installer le paquet avec CDN

Ajoutez le code

Utilisez la version la plus récente de Système de design GC. Les versions épinglées offrent stabilité et prévisibilité parce que le code ne changera pas de manière inattendue, ce qui peut être crucial pour maintenir la stabilité d'une application. Toutefois, il faut mettre à jour manuellement les liens CDN chaque fois qu'une version plus récente de Système de design GC est publiée.

Insérez le code qui suit à l'intérieur de la balise <head> de votre site. Remplacez <version-number> par le numéro de version le plus récent pour recevoir les mises à jour correspondantes.

<!-- GC Système de design -->
<link
  rel="stylesheet"
  href="https://cdn.design-system.alpha.canada.ca/@cdssnc/gcds-components@<version-number>/dist/gcds/gcds.css"
/>
<script
  type="module"
  src="https://cdn.design-system.alpha.canada.ca/@cdssnc/gcds-components@<version-number>/dist/gcds/gcds.esm.js"
></script>

Remarque : Il faut un serveur pour que <script type="module"> se charge correctement. Si vous développez localement, utilisez plutôt <script nomodule>.

Mises à jour automatiques grâce à `@latest`

Utilisez la version @latest de Système de design GC pour recevoir des mises à jour automatiques chaque fois qu'une nouvelle version est publiée. Bien que cette approche vous évite la mise à jour manuelle des liens CDN, elle court le risque d'introduire des modifications qui entraînent une rupture de compatibilité avec le code base à mesure que les nouvelles versions sont automatiquement appliquées.

Cadres d'application pris en charge

La bibliothèque gcds-components fonctionne sous plusieurs cadres d'application.

JavaScript

Insérez le code qui suit à l'intérieur de la balise <head> de votre site.

<!-- GC Système de design -->
<link
  rel="stylesheet"
  href="/node_modules/gcds-components/dist/gcds/gcds.css"
/>
<script type="module" src="/components/dist/gcds/gcds.esm.js"></script>

Vous devriez maintenant pouvoir utiliser tous les composants de gcds-components sur votre site.

React

Veuillez faire référence Composants de Système de design GC – React

Angular

Veuillez faire référence Composants de Système de design GC – Angular

Vue

Insérez le code qui suit dans le fichier main.js de votre application.

import { applyPolyfills, defineCustomElements } from 'gcds-components/loader';
import 'gcds-components/dist/gcds/gcds.css';

applyPolyfills().then(() => {
  defineCustomElements();
});

Vous devriez maintenant pouvoir utiliser tous les composants de gcds-components dans votre application Vue.