# 拡張リスト

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

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

- Requested language: `ja-JP`

- Content language: `ja-JP`

- Documentation version: `1.1.0`

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

---

#### Package metadata

```json
{
  "mobile": true,
  "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/ja-JP",
      "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 DocsListUIJaJP from '@univerjs-pro/docs-list-ui/locale/ja-JP' // [!code ++]
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'

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

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

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

Univer の商用ライセンスをお持ちの場合は、[クライアントでのライセンス使用](https://docs.univer.ai/ja-JP/server/license.md#in-plugin-mode)を参照してください。

## モバイル対応

まず[モバイルエディター](https://docs.univer.ai/ja-JP/guides/docs/getting-started/installation.md#mobile-support)を設定します。このページのプラグインモードの初期化コードで、以下のデスクトップ登録を同じパッケージのモバイル版に置き換え、**文書を開く前に**完了してください。モデル、スタイル、言語ファイル、Facade は維持し、両方を同時に登録しないでください。

| パッケージ                        | デスクトップの登録                | モバイルの登録                        |
| ---------------------------- | ------------------------ | ------------------------------ |
| `@univerjs-pro/docs-list-ui` | `UniverDocsListUIPlugin` | `UniverDocsListMobileUIPlugin` |

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