◆

腾讯 TDesign 组件库文档体验随笔

2023-02-02 01:370

腾讯的 TDesign 官方文档做的还是挺优秀的。

翻了一圈之后,觉得几个地方值得别的组件库文档参考。

值得学的几点

每个组件的示例是分块独立的。不是把所有用法堆在一个大 demo 里,而是「基础用法」「不同尺寸」「禁用态」「自定义内容」各占一小块,每块下面直接跟着可展开的源码。要抄某个特定形态的写法,扫一眼就能定位到,不用在一大坨代码里找哪几行对应画面上哪个元素。

API 表格标了「版本号」列。哪个属性是 1.2 才加的、哪个已废弃,表里直接写着。这个信息看起来不起眼,但真正省事——项目里锁着老版本时,不用装完才发现文档写的属性根本没有。

支持多技术栈平行文档。Vue、React、小程序各有一套完整文档,不是主推一个、别的挂个链接了事。同一个组件在不同框架下的 API 命名差异也标出来了。

设计规范和代码文档放在一起。什么场景该用 Dialog、什么场景该用 Drawer,间距和字号的取值依据是什么,这些通常散在设计团队的 Figma 里,这边直接写进文档。前端跟设计对齐时能拿它当共同依据。

顺手对比

日常用得最多的是 Element Plus 和 Ant Design Vue。TDesign 在文档组织上确实更细,但生态和第三方轮子还是前两者更多——遇到冷门需求,能搜到的现成方案数量差距明显。

所以选型上我的想法是:新项目如果团队里有设计师配合、需要一套完整的设计规范落地,TDesign 值得考虑;如果是快速搭内部系统、指望遇到问题时能搜到答案,还是 Element Plus 稳妥。

💬留言板0

还没有留言,来发表第一条吧~

PAGE LOAD / LIVE腾讯 TDesign 组件库文档体验随笔加载中