# Code Block

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

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

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

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

---

#### Package metadata

```json
{
  "plugins": [
    {
      "client": "@univerjs-pro/docs-code",
      "facade": "@univerjs-pro/docs-code/facade"
    },
    {
      "client": "@univerjs-pro/docs-code-ui",
      "locale": "@univerjs-pro/docs-code-ui/locale/en-US",
      "style": "@univerjs-pro/docs-code-ui/lib/index.css"
    }
  ],
  "server": false
}
```

The code block feature allows you to insert and display formatted code snippets within a document, with syntax highlighting powered by Prism.js.

## Introduction

In Univer Docs, code blocks enable you to:

* **Insert code snippets**: Add formatted code blocks anywhere in your document.
* **Syntax highlighting**: Automatically highlight code based on language.
* **Exit and cancel**: Easily exit or cancel code formatting from empty paragraphs.

## Plugin Mode

### Installation

#### npm

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

#### pnpm

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

#### yarn

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

#### bun

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

### Usage

```typescript
import { UniverDocsCodePlugin } from '@univerjs-pro/docs-code' // [!code ++]
import { UniverDocsCodeUIPlugin } from '@univerjs-pro/docs-code-ui' // [!code ++]
import DocsCodeUIEnUS from '@univerjs-pro/docs-code-ui/locale/en-US' // [!code ++]
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'

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

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

univer.registerPlugin(UniverDocsCodePlugin) // [!code ++]
univer.registerPlugin(UniverDocsCodeUIPlugin) // [!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-code/facade'
```

### Get All Code Blocks

```typescript
const doc = univerAPI.getActiveDocument()
const codes = doc?.getCodes() ?? []
```

### Insert a Code Block

```typescript
const doc = univerAPI.getActiveDocument()
const code = doc?.insertCode({
  startOffset: 12,
  endOffset: 35,
})
```

### Exit a Code Block

```typescript
const doc = univerAPI.getActiveDocument()
doc?.exitCode()
```

### Cancel Empty Code Paragraph

```typescript
const doc = univerAPI.getActiveDocument()
doc?.cancelEmptyCodeParagraph()
```