# 增强列表

- Human documentation: [https://docs.univer.ai/zh-CN/guides/docs/features/list](https://docs.univer.ai/zh-CN/guides/docs/features/list)

- Agent Markdown: [https://docs.univer.ai/zh-CN/guides/docs/features/list.md](https://docs.univer.ai/zh-CN/guides/docs/features/list.md)

- Requested language: `zh-CN`

- Content language: `zh-CN`

- Documentation version: `1.0.0-rc.0`

- Source: [docs/features/list.zh-CN.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/docs/features/list.zh-CN.mdx)

---

#### Package metadata

```json
{
  "plugins": [
    {
      "client": "@univerjs-pro/docs-list",
      "facade": "@univerjs-pro/docs-list/facade"
    },
    {
      "client": "@univerjs-pro/docs-list-ui",
      "locale": "@univerjs-pro/docs-list-ui/locale/zh-CN",
      "style": "@univerjs-pro/docs-list-ui/lib/index.css"
    }
  ],
  "license": true,
  "server": false
}
```

增强列表功能为 Univer Docs 提供了高级列表能力，包括嵌套列表、自定义符号和灵活的列表操作。

## 介绍

在 Univer Docs 中，增强列表使您能够：

* **创建嵌套列表**：构建多级列表层次结构。
* **自定义符号**：使用不同的项目符号和编号样式。
* **操作列表结构**：提升、降级和重新排序列表项。

## 插件模式

### 安装

#### npm

```bash
npm install @univerjs-pro/docs-list @univerjs-pro/docs-list-ui
```

#### pnpm

```bash
pnpm add @univerjs-pro/docs-list @univerjs-pro/docs-list-ui
```

#### yarn

```bash
yarn add @univerjs-pro/docs-list @univerjs-pro/docs-list-ui
```

#### bun

```bash
bun add @univerjs-pro/docs-list @univerjs-pro/docs-list-ui
```

### 使用

```typescript
import { UniverDocsListPlugin } from '@univerjs-pro/docs-list' // [!code ++]
import { UniverDocsListUIPlugin } from '@univerjs-pro/docs-list-ui' // [!code ++]
import DocsListUIZhCN from '@univerjs-pro/docs-list-ui/locale/zh-CN' // [!code ++]
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'

import '@univerjs-pro/docs-list-ui/lib/index.css' // [!code ++]

const univer = new Univer({
  locale: LocaleType.ZH_CN,
  locales: {
    [LocaleType.ZH_CN]: mergeLocales(
      DocsListUIZhCN, // [!code ++]
    ),
  },
})

univer.registerPlugin(UniverDocsListPlugin) // [!code ++]
univer.registerPlugin(UniverDocsListUIPlugin) // [!code ++]
```

如果您拥有 Univer 商业许可证，请参阅[在客户端使用许可证](https://docs.univer.ai/zh-CN/guides/license.md#in-plugin-mode)进行配置。

## Facade API

使用 API 前请确保已导入 facade：

```typescript
import '@univerjs-pro/docs-list/facade'
```

### 插入列表

```typescript
import { PresetListType } from '@univerjs/core'

const doc = univerAPI.getActiveDocument()
doc?.insertList({
  startOffset: 0,
  endOffset: 10,
  listType: PresetListType.BULLET_LIST,
})
```

### 获取所有列表

```typescript
const doc = univerAPI.getActiveDocument()
const lists = doc?.getLists() ?? []
```

### 设置列表符号类型

```typescript
const doc = univerAPI.getActiveDocument()
doc?.setListGlyphType(0, ListGlyphType.DECIMAL)
```

### 设置列表级别

```typescript
const doc = univerAPI.getActiveDocument()
doc?.setListLevel(0, 1)
```