# Enhanced List

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

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

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

- Source: [docs/features/list.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/docs/features/list.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/en-US",
      "style": "@univerjs-pro/docs-list-ui/lib/index.css"
    }
  ],
  "server": false
}
```

The enhanced list feature provides advanced list capabilities for Univer Docs, including nested lists, custom glyphs, and flexible list manipulation.

## Introduction

In Univer Docs, enhanced lists enable you to:

* **Create nested lists**: Build multi-level list hierarchies.
* **Customize glyphs**: Use different bullet symbols and numbering styles.
* **Manipulate list structure**: Promote, demote, and reorder list items.

## Plugin Mode

### Installation

#### 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
```

### Usage

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

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

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

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

If you have a commercial license for Univer, please refer to [Using License in Client](https://docs.univer.ai/server/license.md#in-plugin-mode) for configuration.

## Facade API

Make sure to import the facade before using the API:

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

### Insert a List

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

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

### Get All Lists

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

### Set List Glyph Type

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

### Set List Level

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