@gcds-core/components

中文文档
1.7.0发布于 2026/10/22MITTypeScriptESM + CJS构建来源已验证近 30 天下载 1.5万

Web components for the GCDS

原始使用文档
文档目录36 节
  1. Documentation
  2. Npm installation instructions
  3. 1. Install the package
  4. 2. Include GC Design System in your project
  5. 3. Start building
  6. CDN installation instructions
  7. 1. Select how to receive updates
  8. 2. Start building
  9. Supported frameworks
  10. React
  11. Angular
  12. Vue
  13. Editor support
  14. VS Code
  15. WebStorm and other JetBrains IDEs
  16. Other tools
  17. How to contribute
  18. License
  19. Documentation
  20. Instructions d’installation avec npm
  21. 1. Installer le paquet
  22. 2. Inclure Système de design GC dans votre projet
  23. 3. Commencez à créer
  24. Instructions d’installation avec CDN
  25. 1. Sélectionner comment recevoir des mises à jour
  26. 2. Commencez à créer
  27. Cadres d'application pris en charge
  28. React
  29. Angular
  30. Vue
  31. Prise en charge des éditeurs
  32. VS Code
  33. WebStorm et autres environnements de développement JetBrains
  34. Autres outils
  35. Apportez votre contribution
  36. Licence

La version française suit.

GC Design System Components

Use GC Design System web components directly in HTML. These components are framework-agnostic and behave similarly to native HTML elements.

Use this option for:

  • Static sites
  • CMS platforms
  • Node.js
  • Java
  • Svelte
  • .NET

If you’re using React, Angular, or Vue frameworks, browse the installation page for framework-specific options.

Documentation

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

Npm installation instructions

1. Install the package

Navigate to your project’s root folder and run the following command:

npm install @gcds-core/components

2. Include GC Design System in your project

Add the following link tags inside the head tag of your HTML files to load GC Design System:

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

3. Start building

Once you've installed the design system, start building! Browse our available components and templates to pull the code you need into your project.

CDN installation instructions

1. Select how to receive updates

You have two options to receive updates from the CDN:

  1. Use pinned version for stability (recommended).
  2. Use `@latest` to get automatic updates.

It’s highly recommended to use this option to ensure stability and predictability in your project.

Add the following code to the head tag of your HTML files to load GC Design System. Make sure the current version is listed.

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

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

Going forward

The code will remain unchanged until you manually update the version in the CDN URLs. This is ideal for production environments.

Check for new GC Design System versions regularly to update the latest pinned version.

Use @latest version

Use the @latest tag to pull the most recent version of GC Design System into your project. Put this tag in place of the version number.

While it removes the need to manually update versions, it adds the risk of introducing breaking changes to the codebase as new versions are automatically applied.

2. Start building

Once you've installed the design system, start building! Browse our available components and templates to pull the code you need into your project.

Supported frameworks

The gcds-component library works in multiple frameworks.

React

Please reference GC Design System Components – React

Angular

Please reference GC Design System Components – Angular

Vue

Please reference GC Design System Components – Vue

Editor support

The package includes data files that give your code editor autocomplete and inline documentation for GC Design System components: tag names, attributes, allowed values and descriptions. Required attributes are marked (required).

VS Code

Add the following to .vscode/settings.json in your project, then reload the window (Cmd/Ctrl+Shift+P → Developer: Reload Window):

{
  "html.customData": ["./node_modules/@gcds-core/components/specs/vscode-data.json"]
}

The path is relative to the folder you open in VS Code. This works in HTML files.

WebStorm and other JetBrains IDEs

No setup needed. JetBrains IDEs (WebStorm, IntelliJ IDEA, PhpStorm and others) detect the components automatically once the package is installed. If suggestions don't appear, right-click node_modules/@gcds-core/components and select Reload from Disk.

Other tools

The package includes a Custom Elements Manifest at specs/custom-elements.json, referenced by the customElements field in package.json. Tools that support the manifest, such as Storybook, linters and language servers, can use it to read the components' API.

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

Utilisez les composants Web de Système de design GC directement dans un projet HTML. Ces composants s’adaptent à tout cadriciel et ont un comportement similaire aux éléments HTML natifs.

Utilisez cette option pour les situations suivantes :

  • Sites statiques
  • Plateformes CMS
  • Node.js
  • Java
  • Svelte
  • .NET

Si vous utilisez les cadres React, Angular ou Vue, consultez la page d’installation pour connaître les options propres à chaque cadre.

Documentation

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

Instructions d’installation avec npm

1. Installer le paquet

Naviguez vers le dossier racine de votre projet et exécutez la commande suivante :

npm install @gcds-core/components

2. Inclure Système de design GC dans votre projet

Ajoutez les balises link suivantes à l’intérieur de la balise head de vos fichiers HTML pour charger Système de design GC :

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

3. Commencez à créer

Une fois le système de design installé, commencez à créer! Parcourez nos composants et modèles pour y trouver le code dont vous avez besoin pour votre projet.

Instructions d’installation avec CDN

1. Sélectionner comment recevoir des mises à jour

Vous avez deux options pour recevoir des mises à jour du CDN :

  1. Utiliser la version épinglée pour la stabilité (recommandé).
  2. Utiliser `@latest` pour obtenir des mises à jour automatiques.

a. Utiliser la version épinglée (recommandé)

Il est fortement recommandé d’utiliser cette option pour garantir la stabilité et la prévisibilité de votre projet.

Ajoutez le code suivant à la balise head de vos fichiers HTML pour charger Système de design GC. Assurez-vous d’indiquer la version actuelle.

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

Remarque : <script type="module"> doit être chargé depuis un serveur. Pour le développement local, utilisez <script nomodule>.

Étapes suivantes

Le code restera inchangé jusqu’à ce que vous mettiez à jour manuellement la version dans les URL CDN, ce qui est idéal pour les environnements de production.

Vérifiez régulièrement s’il y a des nouvelles versions de Système de design GC afin de mettre à jour la dernière version épinglée.

b. Utiliser la version @latest (la dernière version)

Utilisez la balise @latest pour insérer la plus récente version de Système de design GC dans votre projet. Remplacez le numéro de version par cette balise.

Bien que cette approche vous évite la mise à jour manuelle des versions, 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.

2. Commencez à créer

Une fois le système de design installé, commencez à créer! Parcourez nos composants et modèles pour y trouver le code dont vous avez besoin pour votre projet.

Cadres d'application pris en charge

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

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

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

Prise en charge des éditeurs

Le paquet comprend des fichiers de données qui offrent, dans votre éditeur de code, la saisie semi-automatique et la documentation intégrée des composants de Système de design GC : noms des balises, attributs, valeurs permises et descriptions. Les attributs obligatoires sont indiqués par (required).

VS Code

Ajoutez ce qui suit au fichier .vscode/settings.json de votre projet, puis rechargez la fenêtre (Cmd/Ctrl+Maj+P → Developer: Reload Window) :

{
  "html.customData": ["./node_modules/@gcds-core/components/specs/vscode-data.json"]
}

Le chemin est relatif au dossier ouvert dans VS Code. Cette fonctionnalité est offerte dans les fichiers HTML.

WebStorm et autres environnements de développement JetBrains

Aucune configuration n'est nécessaire. Les environnements de développement JetBrains (WebStorm, IntelliJ IDEA, PhpStorm et autres) détectent automatiquement les composants une fois le paquet installé. Si les suggestions ne s'affichent pas, faites un clic droit sur node_modules/@gcds-core/components et sélectionnez Reload from Disk.

Autres outils

Le paquet comprend un manifeste d'éléments personnalisés (en anglais) au chemin specs/custom-elements.json, référencé par le champ customElements du fichier package.json. Les outils qui prennent en charge ce manifeste, comme Storybook, les linters et les serveurs de langage, peuvent l'utiliser pour lire l'API des composants.

Apportez votre contribution

Si vous souhaitez contribuer aux unités de style de Système de design GC, veuillez lire nos lignes directrices sur la contribution.

Licence

Code publié en vertu de la licence MIT (en anglais).

版本与发布记录

@gcds-core/components 共发布 10 个版本,首次发布于 2026/01/28;过去 12 个月发布了 10 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.7.0latest2026/10/2225 天前
1.6.02026/09/092 个月前
1.5.02026/08/133 个月前
1.4.02026/07/283 个月前
1.3.12026/06/095 个月前
1.3.02026/05/285 个月前

其他发布通道:alpha → 0.0.0-alpha。

关于 @gcds-core/components 的常见问题

@gcds-core/components 是什么?

Web components for the GCDS

如何安装 @gcds-core/components?

在项目目录运行 npm install @gcds-core/components,或使用 pnpm add / yarn add / bun add。

@gcds-core/components 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gcds-core/components 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gcds-core/components 可以商用吗?

@gcds-core/components 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gcds-core/components 的下载量有多少?

根据 npm 官方下载统计,@gcds-core/components 在 2026/10/16 – 2026/11/14 这 30 天内被下载 15,496 次,日均约 517 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gcds-core/components 还在维护吗?

最新版本 1.7.0 发布于 2026/10/22(25 天前);至今共发布 10 个版本,其中过去 12 个月发布了 10 个;首次发布于 2026/01/28。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。