AutoCorrect

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

@quirekit/extensions · MIT

Editor compatibility

Layer：Shared document capability

“Supported” means the product assembly above exists; interaction, host services and file formats retain their own conditions. See status and integration rules. Licensing is shown separately.

Installation

pnpm add @quirekit/extensions@alpha

Install in Editor extensions. The host supplies a view, container and persistence; see Quick start.

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.

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.

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(),
})

Configuration

These are extension-level defaults. Presets can override them; they are distinct from current document attributes. See configuration.

defaults

Settings used when the store has none.

Type：AutoCorrectSettings

Default：See default below

{ 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

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.

These are parameter signatures. See commands and controls to connect UI while retaining one transaction/history authority.

Next steps

Return to all plugins, or read configuration to distinguish options, attributes and commands.

See extension development for custom capabilities and Build a product for complete hosting.