G6 icon indicating copy to clipboard operation
G6 copied to clipboard

feat: migrate annotation plugin from v4

Open k644606347 opened this issue 2 years ago • 8 comments

  • feat: v4 plugin annotation迁移到v5
  • refactor: 拆分annotation/index.ts逻辑,将card的相关代码封装到Card.ts
  • improve: 重写拖拽card的事件,从drag/drop改为mosemove/mouseup,带来更好的体验和更灵活的样式定制;
  • feat: card的预览态增加tabindex,可按tab键聚焦,并支持按回车切换card的预览/编辑态,减少鼠标移动和点击的操作;
  • feat: 增加配置项cardCfg.focusEditOnInit,默认不开启,支持创建card时立即进入编辑态并聚焦到输入框上,可按回车保存,按 Shift + 回车 换行;
  • chore: 优化card样式,增加了.g6-annotation-wrapper-move / .g6-annotation-wrapper-hide / .g6-annotation-wrapper-collapsed / .g6-annotation-wrapper-editable等状态类的样式,方便外部定制样式;

拖拽图示: 👎 v4下的drag实现,在拖拽到容器边缘并松开时,会有奇怪的位移问题,且拖拽时card样式无法定制:_ Large GIF (774x590) 👍 v5下新的mousemove实现: Large GIF (1128x590)

键盘操作图示: Large GIF (1110x574)

breaking change

  • card的默认宽高变更:widthfit-content改为180(感觉固定的宽度更利于布局计算),minHeight60改为120
  • .g6-annotation-wrapperdisplay: block改为display: flex
Checklist
  • [x] npm test passes
  • [x] tests and/or benchmarks are included
  • [x] commit message follows commit guidelines
Description of change

k644606347 avatar Nov 24 '23 06:11 k644606347

此插件代码量较大,我也看了很久🤦,交互及代码按自己想法做了改良和重构,辛苦抽空帮review下~

k644606347 avatar Nov 24 '23 10:11 k644606347

relative issuehunt issue: https://github.com/antvis/G6/issues/4586

Aarebecca avatar Nov 28 '23 02:11 Aarebecca

另外麻烦补充一下对应的文档呢,位于 site/docs/plugins 下 🥰,可以参考其他插件文档的格式

Aarebecca avatar Nov 28 '23 02:11 Aarebecca

另外麻烦补充一下对应的文档呢,位于 site/docs/plugins 下 🥰,可以参考其他插件文档的格式

@Aarebecca 你好,抱歉一直在加班没时间写,现在我文档写好了;但在G6下重新运行pnpm i时一直报错,导致阻塞commit,之前没出现过,不知道有遇到吗?我是否要调整下node版本? 截图: image

环境: macOS 13.0.1 node -v v16.18.1 npm -v 8.19.2 pnpm -v 8.7.6

k644606347 avatar Dec 26 '23 11:12 k644606347

另外麻烦补充一下对应的文档呢,位于 site/docs/plugins 下 🥰,可以参考其他插件文档的格式

@Aarebecca 你好,抱歉一直在加班没时间写,现在我文档写好了;但在G6下重新运行pnpm i时一直报错,导致阻塞commit,之前没出现过,不知道有遇到吗?我是否要调整下node版本? 截图: 

image

环境: macOS 13.0.1 node -v v16.18.1 npm -v 8.19.2 pnpm -v 8.7.6

打扰了,已经解决,我看了下node-sass官方的安装说明,[email protected]+只能在node@14的环境下才能运行,我把node降级到14后,再把pnpm也降级到7.x,总算解决了环境问题😂

k644606347 avatar Dec 26 '23 16:12 k644606347

Large GIF (1018x666)

另外麻烦补充一下对应的文档呢,位于 site/docs/plugins 下 🥰,可以参考其他插件文档的格式

@Aarebecca 已补充文档到site/docs/plugins

k644606347 avatar Dec 27 '23 16:12 k644606347

@Aarebecca 我看到还未合并,需要我再提供什么吗?

k644606347 avatar Jan 16 '24 11:01 k644606347

@Aarebecca 我看到还未合并,需要我再提供什么吗?

暂时不需要,近期正在进行版本调整,需要等调整完成之后再进行合并

Aarebecca avatar Jan 17 '24 02:01 Aarebecca

我看关闭了,未来还会合并吗?

k644606347 avatar Feb 28 '24 15:02 k644606347

我看关闭了,未来还会合并吗?

3 月会重新发布一些插件任务,如果愿意来搞的话,到时候可以来认领,然后在新分支上处理,理论上新分支设计上,写插件会更加简便一些。

hustcc avatar Feb 29 '24 02:02 hustcc