Class EditorExtensionRegistry

CodeMirror extensions registry

Hierarchy

EditorExtensionRegistry

Implements

IEditorExtensionRegistry

Index

Constructors

Properties

_baseConfiguration configurationBuilder configurationSchema defaultOptions handlers immutableExtensions

Accessors

baseConfiguration defaultConfiguration settingsSchema

Methods

addExtension createNew

Constructors

constructor

new EditorExtensionRegistry(): EditorExtensionRegistry
Returns EditorExtensionRegistry

Properties

`Private` _baseConfiguration

_baseConfiguration: any

`Protected` configurationBuilder

configurationBuilder: Map<string, IEditorExtensionFactory<any>>

`Protected` configurationSchema

configurationSchema: Record<string, any>

`Protected` defaultOptions

defaultOptions: Record<string, any>

`Protected` handlers

handlers: Set<ExtensionsHandler>

`Protected` immutableExtensions

immutableExtensions: Set<string>

Accessors

baseConfiguration

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

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

Returns Record<string, any>
Implementation of IEditorExtensionRegistry.baseConfiguration
- Defined in packages/codemirror/lib/extension.d.ts:162
set baseConfiguration(v): void
Parameters
- v: Record<string, any>
Returns void
Implementation of IEditorExtensionRegistry.baseConfiguration
- Defined in packages/codemirror/lib/extension.d.ts:163

defaultConfiguration

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

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

Returns Record<string, any>
- Defined in packages/codemirror/lib/extension.d.ts:170

settingsSchema

get settingsSchema(): ReadonlyJSONObject
Editor configuration JSON schema

Returns ReadonlyJSONObject
- Defined in packages/codemirror/lib/extension.d.ts:174

Methods

addExtension

addExtension<T>(factory): 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/lib/extension.d.ts:181

createNew

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

Generated using TypeDoc