前一阵的一直用Quasar + Naive UI组件库开发, 近期发现一个同样优质的开源组件库 ArcoVue, 它是字节出品, 美观易用, 体验很不错, 打算加入项目中. 这里梳理一下, 新增组件库的配置流程.
1. 利用 unplugin-vue-components 插件, 实现组件库的注册
vite的配置中, 有个 plugins属性, 可以注册插件. 而 unplugin-vue-components 插件能够提供常见组件库的解析器.
import VueMacros from 'unplugin-vue-macros/vite';
// 插件提供了 NaiveUi 和 ArcoVue的解析器
import { NaiveUiResolver, ArcoResolver } from 'unplugin-vue-components/resolvers';
// https://vitejs.dev/config/
export default defineConfig({
plugins: [
VueMacros({}),
Components({
// 插件能够在下述目录自动生成组件的类型声明
dts: 'src/typings/components.d.ts',
resolvers: [
ArcoResolver({
sideEffect: true
})
]
})
]
})
2. 利用 vite-plugin-style-import插件, 实现样式的按需自动加载.
上面步骤1有一个缺点:即不会处理用户在 script 中手动导入的组件，比如 Message 组件，用户仍需要手动导入组件对应的样式文件，例如 @arco-design/web-vue/es/message/style/css.js。
如果不想手动导入, 那么可以选择 vite-plugin-style-import插件, 自己写js脚本定义样式导入规则. 这个脚本编写要根据组件库的文件组成特点, 来量身编写样式加载的路径.
import { createStyleImportPlugin } from 'vite-plugin-style-import';
interface ReplaceList {
'avatar-group': string;
'cascader-panel': string;
'checkbox-group': string;
'dropdown-button': string;
'image-preview': string;
'image-preview-group': string;
'input-group': string;
'input-password': string;
'input-search': string;
'layout-content': string;
'layout-footer': string;
'layout-header': string;
'layout-sider': string;
'month-picker': string;
'radio-group': string;
'range-picker': string;
row: string;
col: string;
'typography-link': string;
'typography-paragraph': string;
'typography-text': string;
'typography-title': string;
'week-picker': string;
}
export default () => {
// 需要映射引入样式的组件列表
const replaceList: ReplaceList = {
'typography-text': 'typography',
'typography-title': 'typography',
'typography-paragraph': 'typography',
'typography-link': 'typography',
'dropdown-button': 'dropdown',
'input-password': 'input',
'input-search': 'input',
'input-group': 'input',
'radio-group': 'radio',
'checkbox-group': 'checkbox',
'layout-sider': 'layout',
'layout-content': 'layout',
'layout-footer': 'layout',
'layout-header': 'layout',
'month-picker': 'date-picker',
'range-picker': 'date-picker',
'week-picker': 'date-picker',
row: 'grid', // 'grid/row.less'
col: 'grid', // 'grid/col.less'
'avatar-group': 'avatar',
'image-preview': 'image',
'image-preview-group': 'image',
'cascader-panel': 'cascader'
};
// 这部分组件的使用必须依赖父级，所以直接忽略即可。
const ignoreList = [
'config-provider',
'anchor-link',
'sub-menu',
'menu-item',
'menu-item-group',
'breadcrumb-item',
'form-item',
'step',
'card-grid',
'card-meta',
'collapse-panel',
'collapse-item',
'descriptions-item',
'list-item',
'list-item-meta',
'table-column',
'table-column-group',
'tab-pane',
'tab-content',
'timeline-item',
'tree-node',
'skeleton-line',
'skeleton-shape',
'grid-item',
'carousel-item',
'doption',
'option',
'optgroup',
'icon'
];
return createStyleImportPlugin({
libs: [
{
libraryName: '@arco-design/web-vue',
esModule: true,
resolveStyle: (name: string) => {
// List of components that need to map imported styles
if (ignoreList.includes(name)) return '';
// eslint-disable-next-line no-prototype-builtins
return replaceList.hasOwnProperty(name)
? `@arco-design/web-vue/es/${replaceList[name as keyof ReplaceList]}/style/css.js`
: `@arco-design/web-vue/es/${name}/style/css.js`;
// less
// return `@arco-design/web-vue/es/${name}/style/index.js`;
}
}
]
});
};
3. 统一配色.
前两个步骤完成之后, 工程中就能够实现多个组件库混用了. 但为了美观, 这里应该对组件库的主题色进行统一, 包括深浅色的统一切换.
总结
可以看出, 前端工程化已经能够为前端开发提供很多提升生产力的小工具, 作为开发者, 不能迷失在工具的配置使用上, 而应该看清工具的本质, 理解其原理, 才能有的放矢, 物为己用.
