Jamdesk Documentation logo

表格

将数据整理为行和列,支持 Markdown 表格和具备排序、高亮及跨行跨列功能的 Table 组件。

表格用于将数据整理为行和列。Jamdesk 支持两种方式:使用 Markdown 表格快速创建简单表格,或使用 Table 组件实现高亮和对齐等增强功能。

用法

<Table>
  <Row header>
    <Cell>Name</Cell>
    <Cell>Type</Cell>
  </Row>
  <Row>
    <Cell>id</Cell>
    <Cell>string</Cell>
  </Row>
</Table>

Markdown 表格

创建表格最快的方法。使用竖线(|)分隔列,并使用连字符(-)创建表头行:

| Name | Type | Description |
|------|------|-------------|
| id | string | Unique identifier |
| email | string | User email address |
名称类型描述
idstring唯一标识符
emailstring用户电子邮件地址

Markdown 表格适合简单的参考数据。当需要高亮、对齐或视觉强调时,Table 组件可以提供更多控制。

Table 组件

如需更多控制,请使用 <Table><Row><Cell> 组件:

<Table>
  <Row header>
    <Cell>Name</Cell>
    <Cell>Type</Cell>
    <Cell>Description</Cell>
  </Row>
  <Row>
    <Cell>id</Cell>
    <Cell>string</Cell>
    <Cell>Unique identifier</Cell>
  </Row>
  <Row>
    <Cell>email</Cell>
    <Cell>string</Cell>
    <Cell>User email address</Cell>
  </Row>
</Table>
名称类型描述
idstring唯一标识符
emailstring用户电子邮件地址

斑马纹行

添加交替的行背景色,提升可读性:

<Table striped>
  <Row header>
    <Cell>Parameter</Cell>
    <Cell>Value</Cell>
  </Row>
  <Row><Cell>timeout</Cell><Cell>30s</Cell></Row>
  <Row><Cell>retries</Cell><Cell>3</Cell></Row>
  <Row><Cell>backoff</Cell><Cell>exponential</Cell></Row>
  <Row><Cell>maxDelay</Cell><Cell>60s</Cell></Row>
</Table>
参数
timeout30s
retries3
backoffexponential
maxDelay60s

边框与紧凑布局

在单元格之间添加边框并减少内边距:

<Table bordered compact>
  <Row header>
    <Cell>A</Cell>
    <Cell>B</Cell>
    <Cell>C</Cell>
  </Row>
  <Row>
    <Cell>1</Cell>
    <Cell>2</Cell>
    <Cell>3</Cell>
  </Row>
</Table>
ABC
123

高亮行

高亮整行以吸引注意:

<Table>
  <Row header>
    <Cell>Field</Cell>
    <Cell>Required</Cell>
    <Cell>Description</Cell>
  </Row>
  <Row highlight highlightColor="warning">
    <Cell>api_key</Cell>
    <Cell>Yes</Cell>
    <Cell>Your API authentication key</Cell>
  </Row>
  <Row>
    <Cell>limit</Cell>
    <Cell>No</Cell>
    <Cell>Maximum results (default: 100)</Cell>
  </Row>
</Table>
字段必填描述
api_key您的 API 身份验证密钥
limit最大结果数(默认值:100)

可用的高亮颜色:primarysuccesswarningerrorinfo

高亮单元格

高亮单个单元格以显示状态指示:

<Table>
  <Row header>
    <Cell>Service</Cell>
    <Cell>Status</Cell>
  </Row>
  <Row>
    <Cell>API</Cell>
    <Cell highlight highlightColor="success">Operational</Cell>
  </Row>
  <Row>
    <Cell>Database</Cell>
    <Cell highlight highlightColor="warning">Degraded</Cell>
  </Row>
  <Row>
    <Cell>Storage</Cell>
    <Cell highlight highlightColor="error">Outage</Cell>
  </Row>
</Table>
服务状态
API正常运行
数据库性能下降
存储中断

单元格对齐

控制每个单元格的文本对齐方式:

<Table>
  <Row header>
    <Cell align="left">Left</Cell>
    <Cell align="center">Center</Cell>
    <Cell align="right">Right</Cell>
  </Row>
  <Row>
    <Cell align="left">Text</Cell>
    <Cell align="center">Text</Cell>
    <Cell align="right">$99.99</Cell>
  </Row>
</Table>
左对齐居中右对齐
文本文本$99.99

跨列与跨行

合并跨列或跨行的单元格:

<Table bordered>
  <Row header>
    <Cell>Category</Cell>
    <Cell>Item</Cell>
    <Cell>Price</Cell>
  </Row>
  <Row>
    <Cell rowSpan={2}>Fruits</Cell>
    <Cell>Apple</Cell>
    <Cell>$1.00</Cell>
  </Row>
  <Row>
    <Cell>Banana</Cell>
    <Cell>$0.50</Cell>
  </Row>
  <Row>
    <Cell colSpan={2}>Subtotal</Cell>
    <Cell>$1.50</Cell>
  </Row>
</Table>
类别商品价格
水果苹果$1.00
香蕉$0.50
小计$1.50

可见标题

在表格上方显示无障碍表格标题:

<Table caption="Monthly Revenue by Region" captionVisible>
  <Row header>
    <Cell>Region</Cell>
    <Cell align="right">Revenue</Cell>
  </Row>
  <Row>
    <Cell>North America</Cell>
    <Cell align="right">$1.2M</Cell>
  </Row>
</Table>
按地区统计的月收入
地区收入
北美洲$1.2M

可排序列

使用 sortable 属性启用交互式列排序。用户可以点击列标题进行排序:

<Table sortable>
  <Row header>
    <Cell>Name</Cell>
    <Cell>Price</Cell>
    <Cell>Stock</Cell>
  </Row>
  <Row><Cell>Widget A</Cell><Cell>$29.99</Cell><Cell>150</Cell></Row>
  <Row><Cell>Gadget B</Cell><Cell>$49.99</Cell><Cell>75</Cell></Row>
  <Row><Cell>Tool C</Cell><Cell>$19.99</Cell><Cell>200</Cell></Row>
  <Row><Cell>Device D</Cell><Cell>$99.99</Cell><Cell>25</Cell></Row>
</Table>
名称价格库存
Widget A$29.99150
Gadget B$49.9975
Tool C$19.99200
Device D$99.9925

点击列标题一次按升序排序,再次点击按降序排序,第三次点击重置排序。数字按数值排序,文本按字母顺序排序。

可排序功能可以与斑马纹行等其他功能结合使用:

<Table sortable striped>
  <Row header>
    <Cell>Team</Cell>
    <Cell>Wins</Cell>
    <Cell>Losses</Cell>
  </Row>
  <Row><Cell>Eagles</Cell><Cell>12</Cell><Cell>4</Cell></Row>
  <Row><Cell>Bears</Cell><Cell>8</Cell><Cell>8</Cell></Row>
  <Row><Cell>Lions</Cell><Cell>10</Cell><Cell>6</Cell></Row>
</Table>
队伍胜场负场
Eagles124
Bears88
Lions106

属性

Table

属性类型默认值描述
stripedbooleanfalse交替的行背景色
borderedbooleanfalse所有单元格之间的边框
compactbooleanfalse减少单元格内边距
fullWidthbooleantrue表格占满全部宽度
captionstring-表格标题文本
captionVisiblebooleanfalse以视觉方式显示标题(默认仅屏幕阅读器可见)
stickyHeaderbooleanfalse滚动时保持表头可见
sortablebooleanfalse启用点击列标题排序

Row

属性类型默认值描述
headerbooleanfalse渲染为表头行
highlightbooleanfalse高亮该行
highlightColorstringprimary颜色:primary、success、warning、error、info

Cell

属性类型默认值描述
alignstringleft文本对齐方式:left、center、right
colSpannumber-要跨越的列数
rowSpannumber-要跨越的行数
highlightbooleanfalse高亮该单元格
highlightColorstringprimary颜色:primary、success、warning、error、info
headerbooleanfalse强制使用表头样式

下一步

组件概览

浏览所有可用组件

MDX 基础

了解如何在 MDX 中使用组件