# @cleartrip/ct-design-bulleted-list 中文文档

规范地址：https://npmcn.com/package/%40cleartrip/ct-design-bulleted-list/

版本：5\.32\.0
npm 元数据更新时间：2026-11-16T13:03:34.286Z
中文译文更新时间：2026-11-16T13:10:15.158Z
软件包许可：ISC

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cleartrip/ct-design-bulleted-list
原文对照：https://npmcn.com/package/%40cleartrip/ct-design-bulleted-list/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：39.3 kB，27 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：react \>=16\.8\.0，react-dom \>=16\.8\.0，react-native \>=0\.68\.0
- 首次发布：2026-04-29T14:00:22.523Z
- 最新版本发布：2026-11-16T13:03:33.837Z
- 近 30 天下载量：8275（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：317（近 12 个月 317 个）

## 中文简介

BulletedList 组件——已订购(ol)和未订购(ul)列表渲染器.

## 安装

```sh
npm install @cleartrip/ct-design-bulleted-list
```

也可以使用：`pnpm add @cleartrip/ct-design-bulleted-list`、`yarn add @cleartrip/ct-design-bulleted-list`、`bun add @cleartrip/ct-design-bulleted-list`

## README

# 符号列表

中弹 列表将列出一个具有自定义标记(标注或数字)和灵活渲染的项目.

* * *

## 安装

```bash
npm install @cleartrip/ct-design-bulleted-list
# or
pnpm add @cleartrip/ct-design-bulleted-list
```

### 同伴依赖关系

```bash
# Required for all targets
npm install react

# Web only
npm install react-dom

# React Native only
npm install react-native
```

* * *

## 使用量

### 基本命令列表

```tsx
import { BulletedList } from '@cleartrip/ct-design-bulleted-list';

const items = [
  { id: '1', title: 'First Item', content: 'Description here' },
  { id: '2', title: 'Second Item', content: 'Another description' },
  { id: '3', title: 'Third Item', content: 'More content' },
];

function Example() {
  return (
    <BulletedList
      list={items}
      listType="ol"
      renderItem={(item, index) => (
        <div>
          <strong>{item.title}</strong>
          <p>{item.content}</p>
        </div>
      )}
    />
  );
}
```

### 项目列表( 未排序)

```tsx
<BulletedList
  list={items}
  listType="ul"
  renderItem={(item) => <span>{item.title}</span>}
/>
```

### 样式覆盖

```tsx
<BulletedList
  list={items}
  listType="ol"
  renderItem={(item) => <span>{item.title}</span>}
  styleConfig={{
    itemWrapper: [{ padding: 12, borderBottom: '1px solid #eee' }],
    marker: [{ color: '#007bff', fontWeight: 'bold' }],
  }}
/>
```

* * *

## 道具

| Prop | 类型 | 默认 | 需求 | 说明 |
| --- | --- | --- | --- | --- |
| `list` | `T[]` | —— 说 | 对 | 清单中需要提出的项目 |
| `renderItem` | `(item: T, index: number) => ReactNode` | —— 说 | 对 | 将每个列表项调回 |
| `listType` | `'ol' | 'ul'` | `'ol'` | 没有 | 要显示的标记类型 |
| `styleConfig` | `IBulletedListStyleConfig` | —— 说 | 没有 | 样式配置覆盖 |

* * *

## 列表类型

-   `'ol'` - 编号名单(1.2.3.)
-   `'ul'` - 子弹清单(-)

* * *

## 样式

这个 `styleConfig` 界面允许精细的样式定制 :

```ts
interface IBulletedListStyleConfig {
  itemWrapper?: Styles[];
  placeHolder?: Styles[];
  itemContent?: Styles[];
  marker?: Styles[];
}
```

### 槽数

| 槽 | 说明 |
| --- | --- |
| `itemWrapper` | 每个列表项外行容器的样式 |
| `placeHolder` | 标记容器的样式(弹夹/数字占位符区域) |
| `itemContent` | 显示项目输出的内容容器样式 |
| `marker` | 标记行的样式( 命令列表中的数字+点) |

* * *

## 项目密钥

-   有下列项目: `id` 属性将它作为反应密钥
-   无项目 `id` 使用数组索引作为密钥
-   为了取得最佳业绩,提供独特的 `id` 每个项目的值

* * *

## 无障碍

-   顺序列表使用语义 `<ol>` 要素
-   无序列表使用语义 `<ul>` 要素
-   每件东西都被包裹在 `<li>` 用于正确屏幕阅读器支持的元素
-   考虑为复杂的列表项目添加 ARIA 标签

* * *

## 移徙

如果从上一版本迁移:

```diff
- import { BulletedList } from 'old-package';
+ import { BulletedList } from '@cleartrip/ct-design-bulleted-list';
```

## 常见问题

### @cleartrip/ct-design-bulleted-list 是什么？

BulletedList 组件——已订购\(ol\)和未订购\(ul\)列表渲染器\.

### 如何安装 @cleartrip/ct-design-bulleted-list？

在项目目录运行 npm install @cleartrip/ct-design-bulleted-list，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（\>=16\.8\.0）、react-dom（\>=16\.8\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @cleartrip/ct-design-bulleted-list 支持 TypeScript 吗？

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

### @cleartrip/ct-design-bulleted-list 支持 ESM 还是 CommonJS？

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

### @cleartrip/ct-design-bulleted-list 可以商用吗？

@cleartrip/ct-design-bulleted-list 使用 ISC 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cleartrip/ct-design-bulleted-list 的下载量有多少？

根据 npm 官方下载统计，@cleartrip/ct-design-bulleted-list 在 2026/10/10 – 2026/11/08 这 30 天内被下载 8,275 次，日均约 276 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cleartrip/ct-design-bulleted-list 还在维护吗？

最新版本 5\.32\.0 发布于 2026/11/16（今天）；至今共发布 317 个版本，其中过去 12 个月发布了 317 个；首次发布于 2026/04/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

