Garden 使用说明组件参考
组件参考
12 个内置组件的全部字段、默认值、取值限制和报错代码,每个组件一页。
每页左边是代码,右边是同一段代码渲染出的真实效果;窄屏下用「效果 / 代码」切换。用法和什么时候用,见各组件的用法页。
所有组件通用:YAML 语法错误,或顶层出现不支持的键名,整块报 garden-yaml;围栏名写错报 garden-name。
| 组件 | 用途 |
|---|---|
card | 介绍一篇论文、一个项目或一组值得参考的公开工具。 |
stat | 把 2~4 个关键数字、单位与一句说明并排摆出来。 |
compare | 把两三种方案左右并列,或把不好的做法与更好的做法上下对照。 |
timeline | 按时间或阶段顺序排开版本演进、排查经过或关键节点。 |
chart | 把一组算好的数字画成比例条形图,下方自带可展开的数据表。 |
figure | 一张带切换按钮的结构图,点到哪个部分就高亮并显示对应说明。 |
html | 在沙盒中运行一段独立的网页小工具、画布动画或演示。 |
interactive | 让读者拖动滑杆或切换选项,实时看到公式和图表的计算结果。 |
file | 给读者提供一份或一组可下载的文件,支持在当前页展开预览。 |
relations | 把三到六个要素排成环或中心辐射结构,画出谁影响谁、哪些是双向的。 |
list | 用线条图标配短句列出几条并列动作,或带小标题列出分步做法。 |
choice | 给出两三个具体选项卡片,读者点选后看到对应的回应。 |