exploria-ui

Exploria UI

《探索UI》是一套基于 Vue 3 的 UI 组件库，包含组件、指令、插件、工具四大模块，使用 TypeScript 编写，仅提供 ESM 具名导出，支持按需引入。

特性

• 基于 Vue 3 <script setup> + TypeScript，组件 Props / 事件均带类型
• 全部为具名导出，构建时可按需 tree-shaking
• 组件、指令、插件、工具四类能力，API 命名参考 Element Plus
• 内置 MCP Server，可被 AI IDE 直接读取组件源码与 API

环境要求

• vue >= 3.5
• three >= 0.184.0（peerDependency，仅在使用几何 / 3D 组件如 ECube 时需要）
• Node.js >= 20（开发、构建、本地预览时）

安装

pnpm add exploria-ui
# 若使用几何 / 3D 组件，请一并安装 three
pnpm add three

也支持 npm / yarn，命令相应替换即可。

快速开始

// main.ts
import { createApp } from 'vue';
import App from './App.vue';
import { EButton } from 'exploria-ui';
import 'exploria-ui/dist/index.css';

const app = createApp(App);
app.component('EButton', EButton); // 全局注册；也可在业务组件内局部注册
app.mount('#app');

<!-- App.vue -->
<template>
  <EButton type="primary">按钮</EButton>
</template>

样式需单独引入 exploria-ui/dist/index.css（当前为全量样式，未拆分到单组件）。

按需引入

所有导出均为具名导出，未使用的模块不会被打进产物：

import { EButton, EInput, ETable } from 'exploria-ui';          // 组件
import { EDrag, ESizeOb, ESlideIn } from 'exploria-ui/directives'; // 指令
import { ESvgSpriteBuilder } from 'exploria-ui/plugins';       // 插件
import { ETimeUtil, EJSONUtil } from 'exploria-ui/utils';      // 工具

指令与插件通常这样注册：

import { createApp } from 'vue';
import { EDrag } from 'exploria-ui/directives';
import { ESvgSpriteBuilder } from 'exploria-ui/plugins';

app.directive('drag', EDrag);
app.use(ESvgSpriteBuilder, { /* 配置项 */ });

模块与组件总览

完整的属性、事件、插槽与示例见在线文档：http://exploria-ui.zzrkyd.cn/

组件（按分类）

指令 / 插件 / 工具

• 指令：v-edrag（拖拽）、v-esize-ob（尺寸观察）、v-eslide-in（视口滑入动画）
• 插件：ESvgSpriteBuilder（SVG 精灵图构建）、EPreloadImageBuilder（图片预加载）、ESvgPolyfill（SVG 兼容）
• 工具：EDomUtil · EAnimateCSSUtil · EEchartsUtil · EEventBus · ELocalStorageUtil · ETimeUtil · EUUIDUtil · EImageUtil · EThreeUtil · EClipboardUtil · EJSONUtil · EMediaQueryUtil · EStringUtil

MCP 源码读取

本库内置 MCP Server（exploria-ui-mcp-server），AI IDE 可通过 HTTP 直接读取组件源码与 API，便于智能补全与代码生成。配置与端点说明见在线文档（搜索 "MCP"）。

浏览器支持

链接

• 在线文档：http://exploria-ui.zzrkyd.cn/
• 源码仓库：https://gitee.com/exploria-team/exploria-ui-document
• 许可证：MIT