Icons Components

目 录 结 构

docs // vitePress 文档配置目录
resources // svg资源目录
lib // 组件编译输出目录
scripts // 处理resources资源生成组件到packages的脚本和模板
types // 组件源码自动生成的定义文件
packages // 组件源码
  - index.ts //组件入口
  - svg // 处理过后的svg资源（resources中的svg去除宽高熟悉）
    -- index.d.ts 
    -- action // svg分类文件夹, 由代码生成
  - demo // 组件文档
  -components
    -- IconA.vue // 分类为common，名称为A的icon 组件, 由代码生成
    -- IconB.vue // 分类为other，名称为B的icon 组件, 由代码生成
    -- index.ts // components入口文件, 由代码生成
    -- index.less // icon的默认样式
    -- icons-categories.json // 组件的分类json, 由代码生成

使用

前置条件

文档说明

安装

yarn add tcwicons

全局引入

// main.ts
import { createApp } from 'vue'
import App from './App.vue'
import Icons from 'tcwicons';

const app = createApp(App);
app.use(Icons);
app.mount('#app');

// demo.vue
<template>
  <IconHome />
</template>

局部引入

<template>
  <IconHome />
</template>

<script setup lang="ts">
import {IconHome} from 'tcwicons';
</script>

构建 & 发布

将需要纳入组件库的icon svg文件放到resources对应的目录，确保svg的文件名在整个resources中是唯一的。添加commit并push到远程仓库，项目就会自动CI/CD。
在push到远程仓库之前可以本地yarn run build检查是否可以编译成功.
项目构建使用 semantic-release 自动发布，参考Publish npm packages to the GitHub Package Registry using semantic-release

发布过程为：

• yarn 安装依赖包
• yarn run build 执行构建（本项目通过配置 scripts: {"prepare": "npm run build"}实现）
• yarn run release 版本更新并发布【注意：由于是通过github actions 发布到 npm，需要配置对应的NPM_TOKEN秘钥】

组件文档

yarn run docs:dev 打开控制台中的地址即可