增强列表

插件信息

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

介绍

在 Univer Docs 中,增强列表使您能够:

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

插件模式

安装

Shell
pnpm add @univerjs-pro/docs-list @univerjs-pro/docs-list-ui

使用

TypeScript
import { UniverDocsListPlugin } from '@univerjs-pro/docs-list'import { UniverDocsListUIPlugin } from '@univerjs-pro/docs-list-ui'import DocsListUIZhCN from '@univerjs-pro/docs-list-ui/locale/zh-CN'import { LocaleType, mergeLocales, Univer } from '@univerjs/core'import '@univerjs-pro/docs-list-ui/lib/index.css'const univer = new Univer({  locale: LocaleType.ZH_CN,  locales: {    [LocaleType.ZH_CN]: mergeLocales(      DocsListUIZhCN,     ),  },})univer.registerPlugin(UniverDocsListPlugin)univer.registerPlugin(UniverDocsListUIPlugin)

如果您拥有 Univer 商业许可证,请参阅在客户端使用许可证进行配置。

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)

你觉得这篇文档如何?

© 2026 DreamNum Co., Ltd.