@tdesign/uniapp 图标瘦身

1. 背景

随着 tdesign-icons 图标的不断丰富,@tdesign/uniapp 包的图标文件大小也不断变大。但是普通业务一般并不需要同时使用这么多图标,并且小程序等场景图标只能使用 iconfont 等,不支持动态加载,所以需要一种方式减包、瘦身。

2. 解决方案

不同于原生小程序,@tdesign/uniapp 在上传前有构建一步,可以利用插件来减包。

可以使用postcss-plugin-remove-selector 来在构建时进行无用图标的删减。

点此查看文档。

3. 如何使用

安装

bash 复制代码
pnpm add @novlan/postcss-plugin-remove-selector -D

3.1. 简化模式(推荐)

通过 mode 指定预设,只需关注 used/unused,无需手动配置 file 和 selectorPattern:

ts 复制代码
import { defineConfig } from 'vite';
import { postcssPluginRemoveSelector } from '@novlan/postcss-plugin-remove-selector';

export default defineConfig({
  css: {
    postcss: {
      plugins: [
        postcssPluginRemoveSelector({
          mode: 'tdesign',
          used: ['home', 'chat', 'user', 'add', 'search', 'close'],
        }),
      ],
    },
  },
});

使用 customUsed / customUnused 可在预设基础上增量追加,不会覆盖预设中已有的列表:

ts 复制代码
postcssPluginRemoveSelector({
  mode: 'tdesign',
  // 在 tdesign 预设默认的 used 列表上,额外追加 'star' 和 'heart'
  customUsed: ['star', 'heart'],
  // 从结果中额外移除 'loading'
  customUnused: ['loading'],
})

3.2. 标准模式

通过 list 数组传入完整配置,适用于需要匹配多个文件的复杂场景:

ts 复制代码
import { defineConfig } from 'vite';
import { postcssPluginRemoveSelector } from '@novlan/postcss-plugin-remove-selector';
import {
  TDESIGN_ICON_REMOVE_SELECTOR
} from '@novlan/postcss-plugin-remove-selector/lib/tdesign-uniapp-icon';


export default defineConfig({
  css: {
    postcss: {
      plugins: [postcssPluginRemoveSelector(TDESIGN_ICON_REMOVE_SELECTOR)],
    },
  },
});

4. 类型

插件支持两种配置方式,传入 SimpleOptions(简化模式)或 Options(标准模式)均可。

4.1. SimpleOptions(简化模式)

属性 类型 是否必填 说明
mode 'tdesign' 否 预设模式,设置后自动使用对应的 file 和 selectorPattern 默认值
file `RegExp string` 否
used string[] 否 正在使用的图标名称列表,这些图标会被保留
unused string[] 否 未使用的图标名称列表,这些图标会被移除
customUsed string[] 否 增量追加到 used 列表(不覆盖预设或已有的 used)
customUnused string[] 否 增量追加到 unused 列表(不覆盖预设或已有的 unused)
selectorPattern RegExp 否 选择器匹配模式。使用 mode 时可省略
debug boolean 否 是否开启调试模式

mode 和 file 至少需要指定一个。当 mode 和 file/selectorPattern 同时指定时,file/selectorPattern 优先。

4.2. Options(标准模式)

属性 类型 是否必填 说明
list FileConfig[] 是 配置列表
debug boolean 否 是否开启调试模式

4.3. FileConfig

属性 类型 是否必填 说明
file `RegExp string` 是
used string[] 否 正在使用的图标名称列表,这些图标会被保留
unused string[] 否 未使用的图标名称列表,这些图标会被移除
customUsed string[] 否 增量追加到 used 列表(不覆盖已有的 used)
customUnused string[] 否 增量追加到 unused 列表(不覆盖已有的 unused)
selectorPattern RegExp 否 选择器匹配模式,只处理匹配该模式的选择器

4.4. 内置预设

mode 说明 默认 file 默认 selectorPattern
tdesign TDesign UniApp 图标减包 `/[@/]tdesign[/]uniapp[/]dist[/]icon[/]icon.[css vue]/`

5. 文档

  1. 文档
  2. 更新日志
  3. 示例项目

6. 效果

以 tdesign-uniapp-starter 为例,使用此插件,可使小程序大小减少138KB,约95.8%。

使用前:

使用后:

相关推荐
Penge66610 分钟前
JavaScript:BOM 详解
前端
Penge66643 分钟前
Vite vs Webpack:前端构建工具原理与实战
前端
Penge6661 小时前
前端包管理工具:npm、Yarn、pnpm 快速入门
前端
Penge6661 小时前
Sass 了解
前端
Penge6661 小时前
Webpack 打包从 0 到 1 实战笔记
前端
Penge6662 小时前
Webpack 入门:是什么、为什么需要、怎么使用?
前端
Penge6662 小时前
Ant Design(Antd)了解
前端
wangruofeng2 小时前
同一行代码,百种渲染:Asuka、React Native 与 Flutter 跨平台渲染机制深度拆解
前端·github
Penge6663 小时前
JavaScript 核心语法速通
前端
wangruofeng4 小时前
写给开发者的〈重构 UI〉实战笔记:从改好一个设置页开始,告别“程序员审美”
前端·aigc