git clone https://github.com/wanglin2/mind-map.git
cd simple-mind-map
npm i
npm link
cd ..
cd web
npm i
npm link simple-mind-map
npm run serve
自0.2.0版本开始增加了对核心库simple-mind-map的打包,复用了示例项目web的打包工具。
cd web
npm run buildLibrary
simple-mind-map库的package.json文件提供了两个导出字段:
{
"module": "index.js",
"main": "./dist/simpleMindMap.umd.min.js",
}
支持module字段的环境会以index.js为入口,否则会以打包后的simpleMindMap.umd.min.js为入口。
cd web
npm run buildDoc
cd web
npm run build
会自动把index.html移动到根目录。
npm i simple-mind-map
0.2.0版本之前的注意事项:
注意:本项目为源码直接发布,并未进行打包,如果出现编译失败的情况,Vue CLI创建的项目可以在vue.config.js文件中增加如下配置来让babel-loader编译本依赖:
module.exports = { transpileDependencies: ['simple-mind-map'] }其他项目请自行修改打包配置。
本仓库的
web目录提供了一个基于Vue2的完整项目,如果你遇到了一些使用上的疑惑,可以参考该项目的实现。
<div id="mindMapContainer"></div>
import MindMap from "simple-mind-map";
const mindMap = new MindMap({
el: document.getElementById('mindMapContainer'),
data: {
"data": {
"text": "根节点"
},
"children": []
}
});
默认引入的是未打包的ES模块,且只包含核心功能,不包含未注册的插件内容,能有效减小体积,不过你需要在你的项目中配置babel编译simple-mind-map,防止一些较新的js语法部分浏览器不支持。
如果你需要umd模块格式的文件,比如以CDN的方式在浏览器上使用,那么你可以从/simple-mind-map/dist/目录中找到simpleMindMap.umd.min.js文件,复制到你的项目中,然后在页面中引入:
<script scr="simpleMindMap.umd.min.js"></script>
会创建一个全局变量window.simpleMindMap。
这种方式的缺点是会包含所有的内容,包括你没有注册的插件,所以整体体积会比较大。
解决方法:使用如下引入方式:
import MindMap from "simple-mind-map/dist/simpleMindMap.umd.min"
simple-mind-map包提供未打包的入口字段module,依赖的xml-js包需要引入node环境下的包,所以在Vite中获取不到会报错,所以指定引入打包后的入口,相关包都已打包进产物,所以不会报错。
如果需要二次开发,也就是必须要使用未打包代码的话,如果你不需要解析xmind文件的话,可以去除xmind模块,如果需要的话那么可以尝试换成其他的解析xml为json的库。
Getting bbox of element "text" is not possible: TypeError: Cannot read properties of undefined (reading 'apply')原因为安装的@svgdotjs/svg.js版本太高,手动降到3.0.16版本即可。