search

ant-design / ant-design-icons

⭐ Ant Design SVG Icons
https://ant.design/components/icon/
MIT License
939 stars 577 forks source link

feat: JsDoc supports preview #635

Closed Wxh16144 closed 3 months ago

Wxh16144 commented 3 months ago

参考 lucide 在 jsdoc 中添加 svg preview：

效果图：

image
afc163 commented 3 months ago

有点屌啊！

yoyo837 commented 3 months ago

有没有办法直接读svg来预览，data-url 需要多维护一层，容易脱钩

Wxh16144 commented 3 months ago

有没有办法直接读svg来预览，data-url 需要多维护一层，容易脱钩

貌似不太行，不过这个 base64 塞进来感觉文件会变大很多🤔

crazyair commented 3 months ago

vscode 插件，自己根据 icon 名，去渲染一个 html 显示出来？

Wxh16144 commented 3 months ago

vscode 插件，自己根据 icon 名，去渲染一个 html 显示出来？

话说 jsDoc 在 ws 里面能不能正常渲染啊🤔

Wxh16144 commented 3 months ago

image

afc163 commented 3 months ago

https://www.npmjs.com/package/lucide-react 整体 install size 是 22MB，看上去还好。

afc163 commented 3 months ago

7.55 MB => 11.3MB 感觉能接受

Wxh16144 commented 3 months ago

vscode 插件，自己根据 icon 名，去渲染一个 html 显示出来？

话说 jsDoc 在 ws 里面能不能正常渲染啊🤔

看起来ws不支持 https://youtrack.jetbrains.com/issue/WEB-52274/JSDoc-tooltip-doesnt-support-svg-data-urls-for-icon-preview

Wxh16144 commented 3 months ago

https://github.com/ant-design/ant-design-icons/assets/32004925/cb8ffac1-d2ab-4dff-9309-5913156bdf83

Wxh16144 commented 3 months ago

vscode 插件，自己根据 icon 名，去渲染一个 html 显示出来？

话说 jsDoc 在 ws 里面能不能正常渲染啊🤔

看起来ws不支持 https://youtrack.jetbrains.com/issue/WEB-52274/JSDoc-tooltip-doesnt-support-svg-data-urls-for-icon-preview

或者可以在 jsDoc 中用 cdn 显示svg https://github.com/ant-design/ant-design-icons/pull/635#issuecomment-2013025535 🤔

Wxh16144 commented 3 months ago

cdn 形式还是算了，预览也有问题，并且还需要考虑版本问题。

image

思考一下， src/xxx.tsx 内容都是用 ./scripts/generate.ts 脚本根据模板生成的，不存在手动修改维护的情况。 至于更多的内容提交到了 git 仓库，先前想法是写 feather 插件实现，但是有一定门槛，精力不足以去研究了，pr 先挂这里了～

Wxh16144 commented 3 months ago

7.55 MB => 11.3MB 感觉能接受

大多数用户不会在意 node_modules 在本地占用，生产环境也不会把注释构建进去。 唯一担心的是用户在意可能因为网络原因导致安装依赖失败或导致 CI/CD 时间变长 🤔

afc163 commented 3 months ago

先合了，有问题再说。

hellohejinyu commented 3 months ago

今天更新完依赖用的时候就看到了这个 feature，赶紧来看看是哪位大佬的杰作。牛逼的👍