Skip to content

SpellcheckMode

A way an input decides whether it is spell-checked.

The spellcheck attribute is the whole mechanism: Obsidian never calls Electron’s setSpellCheckerEnabled, it only sets the attribute per element. So AlwaysOn really does spell-check with Editor > Spellcheck off, and what it invokes is Chromium’s built-in checker.

Import:

import type { SpellcheckMode } from 'obsidian-dev-utils/obsidian/obsidian-settings';

Signature:

export enum SpellcheckMode

Members:

MemberValueDescription
AlwaysOn'AlwaysOn'Always spell-check the input, whatever Editor > Spellcheck says.
FollowObsidianSetting'FollowObsidianSetting'Follow Editor > Spellcheck, the way Obsidian’s own name-entry surfaces do — the inline note title, the file explorer’s inline rename, the properties fields.
Off'Off'Never spell-check the input, whatever Editor > Spellcheck says.

Links to this page: