Skip to content

defineMode<T>

Unofficial

Registers a new editor mode.

Import:

import type { defineMode } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

function defineMode(name: string, modeFactory: Cm5ModeFactory<T>, dependencies: string[]): void

Parameters:

ParameterTypeDescription
namestringThe mode name.
modeFactoryCm5ModeFactory<T>The factory function that creates the mode.
dependenciesstring[]The names of the modes this mode is built on top of.

Returns: void