# LaTeX Formula

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

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

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

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

---

#### Package metadata

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

The LaTeX formula feature lets Docs store editable formula source in the document model and render it in the browser editor.

## Plugin Mode

### Installation

#### npm

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

#### pnpm

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

#### yarn

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

#### bun

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

### Usage

```typescript
import { UniverDocsLatexPlugin } from '@univerjs-pro/docs-latex' // [!code ++]
import { UniverDocsLatexUIPlugin } from '@univerjs-pro/docs-latex-ui' // [!code ++]
import DocsLatexUIEnUS from '@univerjs-pro/docs-latex-ui/locale/en-US' // [!code ++]
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'

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

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

univer.registerPlugin(UniverDocsLatexPlugin) // [!code ++]
univer.registerPlugin(UniverDocsLatexUIPlugin) // [!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

Import the facade entry before calling LaTeX APIs:

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

Insert a formula into the active document:

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

const formula = doc?.insertLatexFormula({
  latex: 'E=mc^2',
  index: 12,
})
```

Read and update formulas:

```typescript
const formulas = doc?.getLatexFormulas() ?? []
const firstFormula = doc?.findLatexFormulaByText('mc')

firstFormula?.update({
  latex: '\\frac{a}{b}',
})
```

You can also query by range id or by document data-stream offset:

```typescript
const byId = doc?.getLatexFormula('formula-range-id')
const atOffset = doc?.getLatexFormulaAt(42)

console.log(byId?.describe(), atOffset?.getLatex())
```