# Find & Replace

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

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

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

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

---

#### Package metadata

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

Find & Replace searches literal text in the current document body, including tables. It supports case-sensitive and whole-word matching, navigating matches, and replacing one or all matches.

> [!INFO]
> Headers, footers, comments, drawings, regular expressions, formatting search, and special characters are not supported.

## Plugin Mode

### Installation

#### npm

```bash
npm install @univerjs/find-replace @univerjs/docs-find-replace
```

#### pnpm

```bash
pnpm add @univerjs/find-replace @univerjs/docs-find-replace
```

#### yarn

```bash
yarn add @univerjs/find-replace @univerjs/docs-find-replace
```

#### bun

```bash
bun add @univerjs/find-replace @univerjs/docs-find-replace
```

### Usage

```typescript
import { LocaleType, mergeLocales, Univer } from '@univerjs/core'
import { UniverDocsFindReplacePlugin } from '@univerjs/docs-find-replace'
import FindReplaceEnUS from '@univerjs/find-replace/locale/en-US'

import '@univerjs/find-replace/lib/index.css'

const univer = new Univer({
  locale: LocaleType.EN_US,
  locales: {
    [LocaleType.EN_US]: mergeLocales(FindReplaceEnUS),
  },
})

univer.registerPlugin(UniverDocsFindReplacePlugin)
```

## Keyboard Shortcuts

* `Ctrl/Cmd + F`: open find
* `Ctrl/Cmd + H`: open replace
* `Enter` / `Shift + Enter`: next / previous match
* `Escape`: return focus to the document