typeTable() 渲染 Props、REST 参数与配置项的结构化契约表格：等宽类型标签、 必填星标、废弃标记与可折叠详情。行折叠用原生 <details> 元素实现， 不依赖任何 JavaScript。

实况预览

typeTable()

参数类型

label*string

按钮文案。

variant'solid' | 'outline' | 'ghost'

视觉变体。

默认值'solid'

sizedeprecated'sm' | 'md' | 'lg'

默认值'md'

typeTable(
  {
    label: { type: 'string', required: true, description: '按钮文案。' },
    variant: { type: "'solid' | 'outline' | 'ghost'", default: "'solid'", description: '视觉变体。' },
    size: { type: "'sm' | 'md' | 'lg'", default: "'md'", deprecated: true },
  },
  { prop: '参数', type: '类型', default: '默认值' },
);

参数

构建器接收契约数据与可选标签。中文页面传入中文表头标签； <PropsTable> 包装组件将两者原样透传。

参数类型

type*Record

契约数据 —— 每个参数一项，以参数名为键。

labelsTypeTableLabels

表头与键值行标签（本地化页面用）。

默认值{}

TypeNode.type*string

摘要行展示的短类型签名。

TypeNode.descriptionstring

字段说明（允许行内 HTML）。

TypeNode.typeDescriptionstring

展开后显示的完整类型签名。

TypeNode.typeDescriptionLinkstring

附着在完整类型签名上的可选链接。

TypeNode.defaultstring

展开后显示的默认值。

TypeNode.requiredboolean

在名字后渲染必填星标。

默认值false

TypeNode.deprecatedboolean

名字加删除线并渲染废弃徽标。

默认值false

注意

• typeTable() 是纯构建器：可用 set:html 注入、包在 <Preview> 里做实况 演示，或在 MDX 中直接使用 <PropsTable> 包装组件。
• 行折叠由原生 <details> 完成 —— 无 data-cpd-* 钩子，无运行时开销。
• 颜色继承 --cpd-* 令牌，深浅色自动适配。