# AutoCorrect

Applies replacement-table and sentence-capitalization rules during input, with optional host persistence.

Applies replacement-table and sentence-capitalization rules during input, with optional host persistence.

`@quirekit/extensions` · **MIT**

## Editor compatibility
Layer：**Shared document capability**
| Editor | Status | Assembly and boundaries |
| --- | --- | --- |
| Classic | Supported | [createClassicWordPreset](/en/plugins/reference/create-classic-word-preset) — Use createClassicWordPreset for Word models, layout and product integration. Controls, flags, host services and file support follow this page. Full comment, revision and content-control authoring UI additionally requires Pro. |
| Block | Requires integration | Connect the services, targets and lifecycle described on this page and validate the selected View and document model. Core contracts are reusable, but there is no universal product installation without host ports. |

“Supported” means the product assembly above exists; interaction, host services and file formats retain their own conditions. See [status and integration rules](/en/plugins/compatibility). Licensing is shown separately.

## Installation

```sh
pnpm add @quirekit/extensions@alpha
```

Install in Editor extensions. The host supplies a view, container and persistence; see [Quick start](/en/guide/quick-start).

```ts
import { AutoCorrect } from '@quirekit/extensions'
```

Use compatible versions available from your distribution source. This site uses the Alpha workspace. License labels come from package metadata; see [support and licensing](/en/support).

## Integration by editor

These snippets use an existing host element named element. The host owns container sizing and persistence; call instance.destroy() on teardown. Avoid duplicating preset capabilities and supply required host ports before installation.

### Classic

Use createClassicWordPreset for Word models, layout and product integration. Controls, flags, host services and file support follow this page. Full comment, revision and content-control authoring UI additionally requires Pro.

[createClassicWordPreset](/en/plugins/reference/create-classic-word-preset)

```ts
import { createClassicEditor } from '@quirekit/classic-editor'
import '@quirekit/classic-editor/styles.css'
import { createClassicWordDefaultDocument, createClassicWordPreset } from '@quirekit/classic-docx'
import '@quirekit/classic-docx/styles.css'

const instance = createClassicEditor({
  element,
  preset: createClassicWordPreset(),
  document: createClassicWordDefaultDocument(),
})
```

### Block

Connect the services, targets and lifecycle described on this page and validate the selected View and document model. Core contracts are reusable, but there is no universal product installation without host ports.

## Configuration

These are extension-level defaults. Presets can override them; they are distinct from current document attributes. See [configuration](/en/plugins/configuration).

### defaults

Settings used when the store has none.

Type：`AutoCorrectSettings`

Default：See default below

```ts
{ replaceText: true, capitalizeSentences: true, entries: Object.freeze([ { from: "(c)", to: "©" }, { from: "(e)", to: "€" }, { from: "(r)", to: "®" }, { from: "(tm)", to: "™" }, { from: "...", to: "…" }, { from: "-->", to: "→" }, { from: "<--", to: "←" }, { from: "==>", to: "⇒" }, { from: "<==", to: "⇐" }, { from: "<=>", to: "⇔" }, { from: ":)", to: "☺" }, { from: ":-)", to: "☺" }, { from: ":(", to: "☹" }, { from: ":-(", to: "☹" }, { from: ":|", to: "😐" }, { from: ":-|", to: "😐" } ]) }
```

### firstLetterExceptions

Abbreviations after which the next word is not capitalized, such as "e.g.".

Type：`readonly string[]`

Default：See default below

```ts
Object.freeze([ "a.", "abbr.", "approx.", "apr.", "assn.", "assoc.", "asst.", "aug.", "ave.", "avg.", "bldg.", "blvd.", "bros.", "ca.", "cf.", "cm.", "co.", "corp.", "dec.", "dept.", "dr.", "e.g.", "eq.", "esp.", "est.", "etc.", "feb.", "fig.", "fri.", "ft.", "gov.", "govt.", "hr.", "hrs.", "i.e.", "inc.", "incl.", "jan.", "jr.", "jul.", "jun.", "kg.", "km.", "lb.", "ltd.", "mar.", "max.", "min.", "misc.", "mon.", "mr.", "mrs.", "ms.", "mt.", "no.", "nov.", "oct.", "p.", "pp.", "prof.", "rd.", "sat.", "sep.", "sept.", "sr.", "st.", "sun.", "thu.", "tue.", "vol.", "vs.", "wed." ])
```

### store

Optional persistence.

Type：`AutoCorrectSettingsStore | null`

Default：`null`

## Commands and runtime

These commands are supplied directly by this extension. Availability depends on the installed schema, selection and protection policy; query editor.can() first.

| Command | Parameter signature |
| --- | --- |
| `setAutoCorrectSettings` | `setAutoCorrectSettings(settings: AutoCorrectSettings)` |

These are parameter signatures. See [commands and controls](/en/build/commands) to connect UI while retaining one transaction/history authority.

## Next steps

Return to [all plugins](/en/plugins), or read [configuration](/en/plugins/configuration) to distinguish options, attributes and commands.

See [extension development](/en/build/extension) for custom capabilities and [Build a product](/en/build) for complete hosting.