@cleartrip/ct-design-bulleted-list

中文文档
5.32.0发布于 2026/11/16ISCTypeScriptESM + CJS近 30 天下载 8275

BulletedList Component — ordered (ol) and unordered (ul) list renderer.

原始使用文档
文档目录13 节
  1. Installation
  2. Peer dependencies
  3. Usage
  4. Basic ordered list
  5. Bullet list (unordered)
  6. Style overrides
  7. Props
  8. List Types
  9. styleConfig
  10. Slots
  11. Item Keys
  12. Accessibility
  13. Migration

BulletedList

BulletedList renders a list of items with customizable markers (bullets or numbers) and flexible item rendering.


Installation

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

Peer dependencies

# Required for all targets
npm install react

# Web only
npm install react-dom

# React Native only
npm install react-native

Usage

Basic ordered list

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>
      )}
    />
  );
}

Bullet list (unordered)

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

Style overrides

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

Props

PropTypeDefaultRequiredDescription
listT[]—YesItems to render in the list
renderItem(item: T, index: number) => ReactNode—YesCallback that renders each list item
listType'ol' | 'ul''ol'NoType of marker to display
styleConfigIBulletedListStyleConfig—NoStyle configuration overrides

List Types

  • 'ol' — Numbered list (1. 2. 3.)
  • 'ul' — Bullet list (•)

styleConfig

The styleConfig interface allows fine-grained style customization:

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

Slots

SlotDescription
itemWrapperStyles for the outer row container wrapping each list item
placeHolderStyles for the marker container (bullet/number placeholder area)
itemContentStyles for the content container where renderItem output is displayed
markerStyles for the marker row (number + dot on ordered lists)

Item Keys

  • Items with an id property use that as the React key
  • Items without id use the array index as the key
  • For optimal performance, provide unique id values for each item

Accessibility

  • Ordered lists use semantic <ol> elements
  • Unordered lists use semantic <ul> elements
  • Each item is wrapped in <li> elements for proper screen reader support
  • Consider adding ARIA labels for complex list items

Migration

If migrating from a previous version:

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

版本与发布记录

@cleartrip/ct-design-bulleted-list 共发布 317 个版本,首次发布于 2026/04/29;过去 12 个月发布了 317 个版本。

版本发布日期距今
5.32.0latest2026/11/16今天
5.32.0-SNAPSHOT-5.32.0-SNAPSHOT-bs-height-check-161120161537.02026/11/16今天
5.32.0-SNAPSHOT-bs-height-check-151120162243.02026/11/16今天
5.32.0-SNAPSHOT-biztrip-rn-sme-snapshot-11-11-26.02026/11/115 天前
5.32.0-SNAPSHOT-native-main.22026/11/115 天前
5.32.0-SNAPSHOT-native-main.02026/11/0313 天前

其他发布通道:SNAPSHOT-test → 4.0.0-SNAPSHOT-test.0,SNAPSHOT-rnfinaltest → 4.0.0-SNAPSHOT-rnfinaltest.0,SNAPSHOT-rnfinaltest2 → 4.0.0-SNAPSHOT-rnfinaltest2.0,SNAPSHOT-rnfinaltest3 → 4.0.0-SNAPSHOT-rnfinaltest3.0,SNAPSHOT-rnfinaltest4 → 4.0.0-SNAPSHOT-rnfinaltest4.0,SNAPSHOT-rnfinaltest5 → 4.0.0-SNAPSHOT-rnfinaltest5.0。

关于 @cleartrip/ct-design-bulleted-list 的常见问题

@cleartrip/ct-design-bulleted-list 是什么?

BulletedList Component — ordered (ol) and unordered (ul) list renderer.

如何安装 @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 和提交记录判断。