@gemeente-denhaag/descriptionlist

中文文档
4.1.2发布于 2026/09/23EUPL-1.2TypeScriptESM + CJS构建来源已验证近 30 天下载 3428

描述列表组件

中文使用文档
文档目录15 节
  1. 何时使用
  2. 替代品和相关构成部分
  3. 解剖学
  4. (互动)状态
  5. 设计属性
  6. 类型
  7. 颜色
  8. 结构
  9. 无障碍
  10. 内容准则
  11. 自定义页眉宽度
  12. 最佳做法
  13. 这样做
  14. 不要这样
  15. 参考资料

数据列表

数据列表组织和显示信息为行.

何时使用

使用数据列表显示旨在便于扫描和比较的数据.

  • 使用列表创建链接到细节页面的相关项目的可操作列表,例如客户列表.
  • 使用表格将数据集的信息显示为行和列.

解剖学

数据清单包括:

  • 说明(可选):描述表格.
  • 列表标题:行标题的标题.
  • 列表行:数据.

(互动)状态

无.

设计属性

类型

  • 说明:TheMix/xl/700
  • 列表标题: The Sans/ md/700
  • 列表行: Sans/ md/ 400

颜色

  • 说明:文字颜色为黑色
  • 列表标题:文本颜色 Grey/4, 边框颜色 Grey/2
  • 列表行: 文本颜色 Grey/4, 边框颜色 Grey/2

结构

桌面

  • 列表头: 贴出 16px, 边距- 顶端 24px
  • 列表行: 刻入 16px

移动

  • 列表页眉:上行-上行-上行-上行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-行-行-下行-行-下行-行-行-行-行-行-下行-行-上行-行-行-行-行-行-行-行-行-行-行-行-行-行-行-行
  • 列表行:上行-上行-上行-上行-上行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行-下行

无障碍

  • 使用数据列表进行布局.
  • 大力鼓励使用标题元素。 摘要属性在HTML5中被贬值.

内容准则

  • 保持标题信息化、描述性和简洁性,以便一目了然地阅读.
  • 确保信头以大写字母开头, 不要用逗号、分号或全站结束 .
  • 确保内容以大写字母开头,而不包括计量单位.
  • 将内容取而代之。 因为如果行标题从同一个词开始.
  • 持续使用小数.

自定义页眉宽度

使用基于每个相应列下数据预期长度的自定义宽度. 默认情况下,数据列表是全宽的,但数据列表可以和网格一起使用,以占用页面上所期望的水平空间.

最佳做法

这样做

数据清单应:

  • 显示结构化数据的集合 .
  • 有逻辑行头.
  • 使用一个标题来描述一个列表, 与您使用标题的方式相同 。 标题帮助用户查找、导航和理解列表.
  • 将所有信头和数据对齐到左边 .

不要这样

数据清单应:

  • 当需要更复杂的显示数据或相互作用时,不使用.
  • 当表格上方已有说明数据的标题时,并不一定需要标题.
  • 不将信头和数据居中 .

参考资料

版本与发布记录

@gemeente-denhaag/descriptionlist 共发布 342 个版本,首次发布于 2022/02/10;过去 12 个月发布了 4 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
4.1.2latest2026/09/231 个月前
4.1.12026/07/273 个月前
4.1.02026/06/294 个月前
4.0.32026/05/185 个月前
4.0.22025/09/231.1 年前
4.0.12025/09/151.2 年前

关于 @gemeente-denhaag/descriptionlist 的常见问题

@gemeente-denhaag/descriptionlist 是什么?

描述列表组件

如何安装 @gemeente-denhaag/descriptionlist?

在项目目录运行 npm install @gemeente-denhaag/descriptionlist,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(18 || 19)、react-dom(18 || 19)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@gemeente-denhaag/descriptionlist 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gemeente-denhaag/descriptionlist 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@gemeente-denhaag/descriptionlist 可以商用吗?

@gemeente-denhaag/descriptionlist 使用 EUPL-1.2 许可。声明的许可为 EUPL-1.2,请阅读许可原文确认使用条件。以上为概括,不构成法律意见,请以许可原文为准。

@gemeente-denhaag/descriptionlist 的下载量有多少?

根据 npm 官方下载统计,@gemeente-denhaag/descriptionlist 在 2026/10/16 – 2026/11/14 这 30 天内被下载 3,428 次,日均约 114 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gemeente-denhaag/descriptionlist 还在维护吗?

最新版本 4.1.2 发布于 2026/09/23(1 个月前);至今共发布 342 个版本,其中过去 12 个月发布了 4 个;首次发布于 2022/02/10。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。