2025 AntV X6 文档意见收集(倾听你的诉求)
X6文档将迎来升级以及优化改动,欢迎各位来提出自己对于文档的意见和建议👏,以及欢迎大家进行吐槽💬,把使用文档过程中觉得不方便的地方记录下来,帮助我们改进!
也更欢迎大家参与OSCP,直接把发现的问题提PR进行解决,还能有积分奖励兑换奖品: https://github.com/antvis/X6/issues/4772
文档标题缺少api名称,不利于查找
sanbox跳转后case失效,原因为默认root创建方式未更新到react19的新方式
mvc中的api文档不易理解
遇到的问题:
- 文档太乱,找东西像捉迷藏跳来跳去,体验不好。
- 文档 FAQ?有问题得翻 Issues,麻烦。
- 链接桩校验这块,文档说不清楚,案例也不多。
- 核心API没图,理解慢,G2、G6 做的就不错。
- 自定义事件这块,文档写得太模糊 trigger、emit g2、g6、x6 设计上各有各的风格?
我的建议:
- 加个视频教程吧放在B站上,快速上手部分放个外链视频,这样学起来更直观。
- 首页多放点好企业实践案例,这样我能更快知道 antv X6 能干啥。
- 快速上手的例子要好看点,特别是链接桩的部分,做得吸引人一点。
- 做个卡片切换功能,让不同框架使用展现的更好(React/Vue)。
- 多加点实际场景的例子,特别是链接桩和节点间校验的案例,这样更实用。
- 默认支持的边样式太丑,要做改进。
- 我们做技术实现业务方案时,常会通过搜索引擎查找资料,而掘金、知乎、GitHub等社区就成为关键参考来源。没有基于X6的技术实践案例,可以适当推送相关文章,帮助用户更清晰地进行技术选型。
x6文档其实缺少关于插件部分的内容,可以加一些介绍x6插件系统或如何自定义开发x6插件之类的内容
history 插件问题很多,特别是针对父子节点的历史记录,得自己勇batch处理
history 插件问题很多,特别是针对父子节点的历史记录,得自己勇batch处理
有没有兴趣提 PR,来一起维护呀。
导出相关文档指引不明确: https://github.com/antvis/X6/issues/4800
关于 plugin export 的文档说明不够完整,存在遗漏的部分。
文档中相关 plugin 工具 导入方式可以修改为从 @antv/x6 引入。
https://x6.antv.antgroup.com/api/mvc/view#onportrendered 这里的示例提供的有问题,ReactDOM.render 第二参数类型和 container 参数类型对应不上。
看到一张图觉得不错 @q32757468 可以针对 X6 能力画一张全面的纳入官网上。
https://juejin.cn/post/7356892796613115916?searchId=20251010152524AD39561C719159BD793A
1.现有的功能有导出svg和png等,是否考虑加一个导出pdf功能 2.是否考虑实现定位搜索的节点到画布中心的功能
1.现有的功能有导出svg和png等,是否考虑加一个导出pdf功能 2.是否考虑实现定位搜索的节点到画布中心的功能
- PDF 导出属于业务层常见需求,但在图编辑引擎中并不算通用的原子能力,建议基于现有的 SVG/PNG 导出接口在上层自行封装实现。