README.md

OmniMagicCube 无界魔方

文档中心

商用请保留版权信息

演示网址

这是一个支持VUE3主流UI组件库的可视化框架
问题交流请加QQ群：685018059

使用说明

• 注意下方内容默认采用TDeisnVue组件库作为示例。其他UI库请按照实际名称进行替换

集成到项目中

首先安装必备的依赖项

npm install @vueuse/core ace-builds dexie vue3-colorpicker sass vite-plugin-svg-icons

其次ts项目应为项目配置运行js

{
  "compilerOptions":{
    "allowJs":true
  }
}

1.复制components中的molian到自己的项目中,并对vite.config进行以下配置

import { resolve } from 'node:path'
export default defineConfig({
  plugins: [
    ...您的内容
    createSvgIconsPlugin({
      // Specify the icon folder to be cached
      iconDirs: [resolve(process.cwd(), 'src/components/molian/assets/icons')],
      // Specify symbolId format
      symbolId: 'icon-[dir]-[name]',
    })
    // 如果已经存在该插件仅需在iconDirs中加入我们的路径
  ],
  resolve: {
    alias: {
      "@": resolve(__dirname, 'src'), // 路径别名
      "@molian": resolve(__dirname, 'src/components/molian'),
      "@molianComps": resolve(__dirname, 'src/components/molian/components'),
    }
  },

})

2.main.js

import plug from '@molian/utils/plug' // 我们需要引入plug进行配置
// 我们需要获取全局组件message以及notify，传入plug中,它将给予我们提示能力
// TDesign
import TDesign, {MessagePlugin, NotifyPlugin} from 'tdesign-vue-next';

// ...UI框架引入,注意一定要在其他UI库引入完成后在对我们的组件进行引入。因为它首先会获取所有的全局组件进行配置
app.use(plug, {
    compsConfig: {
        globalComps:{
            message:MessagePlugin,
            notify:NotifyPlugin
        }
    },
});

3.修改配置

我们需要在 utils/UIMap中修改我们的配置,其中UIMap可以将我们系统中所使用的组件换成我们所需要的UI库。 目前配置有5个组件库。其他适配请参照该文件自行配置。因组件还在开发阶段该内容暂不过多赘述。

4.最后在需要使用我们的组件的地方引入即可

<script setup>
import designer from '@molianComps/Designer/index.vue'
</script>

<template>
  <designer width="100vw" height="100vh" />
</template>

<style>
body{
  background: #F9F9F9;
  overflow: hidden;
}
</style>