跳到主要内容

按需引入与 Resolver ​

Web 端提供 @ruanno-ui/resolver:unplugin-vue-components 的 resolver + unplugin-auto-import 的预设,对齐 Element Plus 生态的按需引入体验,零运行时依赖。

安装 ​

bash
pnpm add -D @ruanno-ui/resolver unplugin-vue-components unplugin-auto-import

Vite 配置 ​

ts
// vite.config.ts
import { defineConfig } from "vite";
import Components from "unplugin-vue-components/vite";
import AutoImport from "unplugin-auto-import/vite";
import { RuannoUIResolver, RuannoUIAutoImports } from "@ruanno-ui/resolver";

export default defineConfig({
  plugins: [
    AutoImport({
      imports: [RuannoUIAutoImports],
    }),
    Components({
      resolvers: [RuannoUIResolver()],
    }),
  ],
});

配置完成后,模板里直接使用组件,无需手写 import:

vue
<template>
  <Button variant="primary" @click="showToast('已保存')">保存</Button>
</template>
  • <Button> 被解析为 import { Button } from "ruanno-ui";
  • showToast 等服务函数由 auto-import 自动注入;
  • 样式 ruanno-ui/style.css 作为 sideEffect 自动带入,无需手动引入。

Resolver 行为 ​

组件名命中库内清单(构建期从 packages/ui/src/components 静态生成)时返回:

js
{ name: "Button", from: "ruanno-ui", sideEffects: "ruanno-ui/style.css" }

未命中返回 undefined,交给链上的下一个 resolver。关闭样式自动带入:

ts
Components({ resolvers: [RuannoUIResolver({ importStyle: false })] });

Auto-imports 预设覆盖范围 ​

RuannoUIAutoImports 覆盖 ruanno-ui 的服务函数与组合式 API:

  • 服务:showToast / closeAllToasts / showAlert / showConfirm / showPrompt / showNotification / closeAllNotifications / showImagePreview
  • 主题:setRnTheme / getRnTheme
  • 组合式:useBreakpoint / useLocale

Webpack / Rspack ​

unplugin-vue-components 与 unplugin-auto-import 同样提供 webpack 插件入口,配置方式一致:

js
// webpack.config.js
const Components = require("unplugin-vue-components/webpack").default;
const AutoImport = require("unplugin-auto-import/webpack").default;
const { RuannoUIResolver, RuannoUIAutoImports } = require("@ruanno-ui/resolver");

module.exports = {
  plugins: [
    AutoImport({ imports: [RuannoUIAutoImports] }),
    Components({ resolvers: [RuannoUIResolver()] }),
  ],
};

手动按需引入 ​

不使用 unplugin 时,直接具名导入即可:

ts
import { Button, Dialog, showToast } from "ruanno-ui";
import "ruanno-ui/style.css"; // 全局引入一次

uni-app 端的按需引入 ​

@ruanno-ui/uniapp 面向小程序 / App 的构建体系,按需引入方式为直接具名导入:

vue
<script setup lang="ts">
import { Button, Cell, NavBar } from "@ruanno-ui/uniapp";
</script>

uni-app 编译器的 tree-shaking 会处理未使用组件;样式通过 @import "@ruanno-ui/uniapp/styles" 一次性引入。详见 uni-app 快速开始。