@gcds-core/components-vue

中文文档
1.7.0发布于 2026/10/22MITTypeScriptCommonJS构建来源已验证近 30 天下载 2669

Vue wrapper for GC Design System components

原始使用文档
文档目录18 节
  1. Documentation
  2. Vue installation instructions
  3. 1. Install the package
  4. 2. Import GC Design System
  5. 3. Import GC Design System styles
  6. 4. Start building
  7. Using Vite
  8. How to contribute
  9. License
  10. Documentation
  11. Instructions d’installation dans Vue
  12. 1. Installer le paquet
  13. 2. Importer Système de design GC
  14. 3. Importer les styles de Système de design GC
  15. 4. Commencez à créer
  16. Utilisation de Vite
  17. Apportez votre contribution
  18. Licence

La version française suit.

GC Design System Components – Vue

To make it easier to integrate GC Design System web components into Vue projects, the @gcds-core/components-vue package provides Vue wrappers.

These wrappers make it easier to work with web components in the Vue ecosystem by enabling type checking, integration with Vue Router, and support for v-model with form controls.

The web components inherit native properties and interoperability.

Documentation

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

Vue installation instructions

Follow these steps to install and use GC Design System components in your Vue project.

1. Install the package

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

npm install @gcds-core/components-vue

2. Import GC Design System

In your main.js file, import the GC Design System components plugin and use it:

import { GcdsComponents } from '@gcds-core/components-vue';

createApp(App).use(GcdsComponents).mount('#app');

3. Import GC Design System styles

There are 2 ways to do this:

  • Import style to main.js.
  • Import styles to App.vue.

a. Import the styles to your main.js file, alongside your style.css:

import '@gcds-core/components-vue/gcds.css';
import './style.css';

b. Import the styles to your App.vue using the HTML style tag:

<style src="@gcds-core/components-vue/gcds.css">
  /* global styles */
</style>

4. 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.

Using Vite

If using Vite, additional configuration will need to be added to vite.config.ts to prevent Vue from logging a warning about failing to resolve components (e.g. "Failed to resolve component: gcds-header").

export default defineConfig({
  plugins: [
    vue({
      template: {
        compilerOptions: {
          // treat all tags with a dash as custom elements
          isCustomElement: tag => tag.includes('-'),
        },
      },
    }),
  ],
});

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 — Vue

Pour faciliter l’intégration des composants Web de Système de design GC dans les projets Vue, le paquet @gcds-core/components-vue propose différentes enveloppes Vue.

Ces enveloppes facilitent le travail avec les composants Web dans l’écosystème Vue en permettant la vérification des types, l’intégration avec Vue Router, et la prise en charge de la fonction v-model avec les contrôles de formulaire.

Les composants Web héritent les propriétés et l’interopérabilité natives.

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 dans Vue

Suivez ces étapes pour installer et utiliser les composants de Système de design GC dans votre projet Vue.

1. Installer le paquet

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

npm install @gcds-core/components-vue

2. Importer Système de design GC

Dans votre fichier main.js, importez le plugiciel des composants de Système de design GC et utilisez-le :

import { GcdsComponents } from '@gcds-core/components-vue';

createApp(App).use(GcdsComponents).mount('#app');

3. Importer les styles de Système de design GC

Il y a 2 façons de le faire :

  • Importer le style dans main.js.
  • Importer des styles dans App.vue.

a. Importez les styles dans votre fichier main.js, à côté de votre style.css:

import '@gcds-core/components-vue/gcds.css';
import './style.css';

b. Importez les styles dans fichier App.vue en utilisant la balise HTML style :

<style src="@gcds-core/components-vue/gcds.css">
  /* global styles */
</style>

4. 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.

Utilisation de Vite

Si vous utilisez Vite, il faudra ajouter une configuration additionnelle à 'vite.config.ts' afin d’empêcher que Vue ne signale un avertissement d’échec pour la résolution de composants (p. ex. « Failed to resolve component: gcds-header » [Échec de la résolution du composant : gcds-header]).

export default defineConfig({
  plugins: [
    vue({
      template: {
        compilerOptions: {
          // treat all tags with a dash as custom elements
          isCustomElement: tag => tag.includes('-'),
        },
      },
    }),
  ],
});

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-vue 共发布 10 个版本,首次发布于 2026/02/04;过去 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-vue 的常见问题

@gcds-core/components-vue 是什么?

Vue wrapper for GC Design System components

如何安装 @gcds-core/components-vue?

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

@gcds-core/components-vue 支持 TypeScript 吗?

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

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

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

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

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

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

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

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

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