Class EditorExtensionRegistry

CodeMirror extensions registry

Implements

IEditorExtensionRegistry

Index

Constructors

Properties

configurationBuilder configurationSchema defaultOptions handlers immutableExtensions

Accessors

baseConfiguration defaultConfiguration settingsSchema

Methods

addExtension createNew

Constructors

constructor

new EditorExtensionRegistry(): EditorExtensionRegistry
Returns EditorExtensionRegistry

Properties

`Protected`configurationBuilder

configurationBuilder: Map<string, IEditorExtensionFactory<unknown>> = ...

`Protected`configurationSchema

configurationSchema: Record<string, ReadonlyJSONObject & { default?: unknown }> = {}

`Protected`defaultOptions

defaultOptions: Record<string, unknown> = {}

`Protected`handlers

handlers: Set<ExtensionsHandler> = ...

`Protected`immutableExtensions

immutableExtensions: Set<string> = ...

Accessors

baseConfiguration

get baseConfiguration(): Record<string, unknown>
Base editor configuration

This is the default configuration optionally modified by the user; e.g. through user settings.

Returns Record<string, unknown>
Implementation of IEditorExtensionRegistry.baseConfiguration
- Defined in packages/codemirror/src/extension.ts:386
set baseConfiguration(v: Record<string, unknown>): void
Base editor configuration

This is the default configuration.
Parameters
- v: Record<string, unknown>
Returns void
Implementation of IEditorExtensionRegistry.baseConfiguration
- Defined in packages/codemirror/src/extension.ts:389

defaultConfiguration

get defaultConfiguration(): Record<string, unknown>
Default editor configuration

This is the default configuration as defined when extensions are registered.

Returns Record<string, unknown>
- Defined in packages/codemirror/src/extension.ts:409

settingsSchema

get settingsSchema(): ReadonlyJSONObject
Editor configuration JSON schema

Returns ReadonlyJSONObject
- Defined in packages/codemirror/src/extension.ts:418

Methods

addExtension

addExtension<T>(factory: IEditorExtensionFactory<T>): void
Add a default editor extension
Type Parameters
- T
  Extension parameter type
Parameters
- factory: IEditorExtensionFactory<T>
  Extension factory
Returns void
Implementation of IEditorExtensionRegistry.addExtension
- Defined in packages/codemirror/src/extension.ts:432

createNew

createNew(
    options: IEditorExtensionFactory.IOptions & {
        config?: Record<string, unknown>;
    },
): IExtensionsHandler
Create a new extensions handler for an editor
Parameters
- options: IEditorExtensionFactory.IOptions & { config?: Record<string, unknown> }
  Extensions options and initial editor configuration
  - Optionalconfig?: Record<string, unknown>
    The configuration options for the editor.
Returns IExtensionsHandler
Implementation of IEditorExtensionRegistry.createNew
- Defined in packages/codemirror/src/extension.ts:456