-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
contextplugin.ts
79 lines (69 loc) · 2.31 KB
/
contextplugin.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/**
* @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
*/
/**
* @module core/contextplugin
*/
import {
ObservableMixin,
type Collection,
type Config,
type Locale,
type LocaleTranslate
} from '@ckeditor/ckeditor5-utils';
import type Editor from './editor/editor.js';
import type { EditorConfig } from './editor/editorconfig.js';
import type Context from './context.js';
import type { PluginDependencies, PluginInterface } from './plugin.js';
import type PluginCollection from './plugincollection.js';
/**
* The base class for {@link module:core/context~Context} plugin classes.
*
* A context plugin can either be initialized for an {@link module:core/editor/editor~Editor editor} or for
* a {@link module:core/context~Context context}. In other words, it can either
* work within one editor instance or with one or more editor instances that use a single context.
* It is the context plugin's role to implement handling for both modes.
*
* There are a few rules for interaction between the editor plugins and context plugins:
*
* * A context plugin can require another context plugin.
* * An {@link module:core/plugin~Plugin editor plugin} can require a context plugin.
* * A context plugin MUST NOT require an {@link module:core/plugin~Plugin editor plugin}.
*/
export default class ContextPlugin extends ObservableMixin() implements PluginInterface {
/**
* The context or editor instance.
*/
public readonly context: ContextInterface;
/**
* Creates a new plugin instance.
*/
constructor( context: Context | Editor ) {
super();
this.context = context as ContextInterface;
}
/**
* @inheritDoc
*/
public destroy(): void {
this.stopListening();
}
/**
* @inheritDoc
*/
public static get isContextPlugin(): true {
return true;
}
}
/**
* The common interface of {@link module:core/context~Context} and {@link module:core/editor/editor~Editor}.
*/
export interface ContextInterface {
config: Config<Omit<EditorConfig, 'plugins' | 'substitutePlugins' | 'removePlugins' | 'extraPlugins'>>;
plugins: PluginCollection<Context | Editor>;
locale: Locale;
t: LocaleTranslate;
editors?: Collection<Editor>;
}
export type ContextPluginDependencies = PluginDependencies<Context | Editor>;