@ckeditor/ckeditor5-basic-styles 36.0.0 → 37.0.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ckeditor/ckeditor5-basic-styles",
3
- "version": "36.0.0",
3
+ "version": "37.0.0-alpha.0",
4
4
  "description": "Basic styles feature for CKEditor 5.",
5
5
  "keywords": [
6
6
  "ckeditor",
@@ -12,18 +12,18 @@
12
12
  ],
13
13
  "main": "src/index.js",
14
14
  "dependencies": {
15
- "ckeditor5": "^36.0.0"
15
+ "ckeditor5": "^37.0.0-alpha.0"
16
16
  },
17
17
  "devDependencies": {
18
- "@ckeditor/ckeditor5-core": "^36.0.0",
19
- "@ckeditor/ckeditor5-dev-utils": "^32.0.0",
20
- "@ckeditor/ckeditor5-editor-classic": "^36.0.0",
21
- "@ckeditor/ckeditor5-engine": "^36.0.0",
22
- "@ckeditor/ckeditor5-essentials": "^36.0.0",
23
- "@ckeditor/ckeditor5-paragraph": "^36.0.0",
24
- "@ckeditor/ckeditor5-theme-lark": "^36.0.0",
25
- "@ckeditor/ckeditor5-ui": "^36.0.0",
26
- "@ckeditor/ckeditor5-utils": "^36.0.0",
18
+ "@ckeditor/ckeditor5-core": "^37.0.0-alpha.0",
19
+ "@ckeditor/ckeditor5-dev-utils": "^34.0.0",
20
+ "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.0",
21
+ "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.0",
22
+ "@ckeditor/ckeditor5-essentials": "^37.0.0-alpha.0",
23
+ "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.0",
24
+ "@ckeditor/ckeditor5-theme-lark": "^37.0.0-alpha.0",
25
+ "@ckeditor/ckeditor5-ui": "^37.0.0-alpha.0",
26
+ "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.0",
27
27
  "typescript": "^4.8.4",
28
28
  "webpack": "^5.58.1",
29
29
  "webpack-cli": "^4.9.0"
@@ -54,5 +54,6 @@
54
54
  "dll:build": "webpack",
55
55
  "build": "tsc -p ./tsconfig.release.json",
56
56
  "postversion": "npm run build"
57
- }
57
+ },
58
+ "types": "src/index.d.ts"
58
59
  }
@@ -0,0 +1,85 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/attributecommand
7
+ */
8
+ import { Command, type Editor } from 'ckeditor5/src/core';
9
+ /**
10
+ * An extension of the base {@link module:core/command~Command} class, which provides utilities for a command
11
+ * that toggles a single attribute on a text or an element.
12
+ *
13
+ * `AttributeCommand` uses {@link module:engine/model/document~Document#selection}
14
+ * to decide which nodes (if any) should be changed, and applies or removes the attribute from them.
15
+ *
16
+ * The command checks the {@link module:engine/model/model~Model#schema} to decide if it can be enabled
17
+ * for the current selection and to which nodes the attribute can be applied.
18
+ */
19
+ export default class AttributeCommand extends Command {
20
+ /**
21
+ * Flag indicating whether the command is active. The command is active when the
22
+ * {@link module:engine/model/selection~Selection#hasAttribute selection has the attribute} which means that:
23
+ *
24
+ * * If the selection is not empty – That the attribute is set on the first node in the selection that allows this attribute.
25
+ * * If the selection is empty – That the selection has the attribute itself (which means that newly typed
26
+ * text will have this attribute, too).
27
+ *
28
+ * @observable
29
+ * @readonly
30
+ */
31
+ value: boolean;
32
+ /**
33
+ * The attribute that will be set by the command.
34
+ */
35
+ readonly attributeKey: string;
36
+ /**
37
+ * @param attributeKey Attribute that will be set by the command.
38
+ */
39
+ constructor(editor: Editor, attributeKey: string);
40
+ /**
41
+ * Updates the command's {@link #value} and {@link #isEnabled} based on the current selection.
42
+ */
43
+ refresh(): void;
44
+ /**
45
+ * Executes the command — applies the attribute to the selection or removes it from the selection.
46
+ *
47
+ * If the command is active (`value == true`), it will remove attributes. Otherwise, it will set attributes.
48
+ *
49
+ * The execution result differs, depending on the {@link module:engine/model/document~Document#selection}:
50
+ *
51
+ * * If the selection is on a range, the command applies the attribute to all nodes in that range
52
+ * (if they are allowed to have this attribute by the {@link module:engine/model/schema~Schema schema}).
53
+ * * If the selection is collapsed in a non-empty node, the command applies the attribute to the
54
+ * {@link module:engine/model/document~Document#selection} itself (note that typed characters copy attributes from the selection).
55
+ * * If the selection is collapsed in an empty node, the command applies the attribute to the parent node of the selection (note
56
+ * that the selection inherits all attributes from a node if it is in an empty node).
57
+ *
58
+ * @fires execute
59
+ * @param options Command options.
60
+ * @param options.forceValue If set, it will force the command behavior. If `true`,
61
+ * the command will apply the attribute, otherwise the command will remove the attribute.
62
+ * If not set, the command will look for its current value to decide what it should do.
63
+ */
64
+ execute(options?: {
65
+ forceValue?: boolean;
66
+ }): void;
67
+ /**
68
+ * Checks the attribute value of the first node in the selection that allows the attribute.
69
+ * For the collapsed selection returns the selection attribute.
70
+ *
71
+ * @returns The attribute value.
72
+ */
73
+ private _getValueFromFirstAllowedNode;
74
+ }
75
+ declare module '@ckeditor/ckeditor5-core' {
76
+ interface CommandsMap {
77
+ bold: AttributeCommand;
78
+ code: AttributeCommand;
79
+ italic: AttributeCommand;
80
+ strikethrough: AttributeCommand;
81
+ subscript: AttributeCommand;
82
+ superscript: AttributeCommand;
83
+ underline: AttributeCommand;
84
+ }
85
+ }
@@ -0,0 +1,29 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/bold/boldediting
7
+ */
8
+ import { Plugin } from 'ckeditor5/src/core';
9
+ /**
10
+ * The bold editing feature.
11
+ *
12
+ * It registers the `'bold'` command and introduces the `bold` attribute in the model which renders to the view
13
+ * as a `<strong>` element.
14
+ */
15
+ export default class BoldEditing extends Plugin {
16
+ /**
17
+ * @inheritDoc
18
+ */
19
+ static get pluginName(): 'BoldEditing';
20
+ /**
21
+ * @inheritDoc
22
+ */
23
+ init(): void;
24
+ }
25
+ declare module '@ckeditor/ckeditor5-core' {
26
+ interface PluginsMap {
27
+ [BoldEditing.pluginName]: BoldEditing;
28
+ }
29
+ }
@@ -0,0 +1,26 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/bold/boldui
7
+ */
8
+ import { Plugin } from 'ckeditor5/src/core';
9
+ /**
10
+ * The bold UI feature. It introduces the Bold button.
11
+ */
12
+ export default class BoldUI extends Plugin {
13
+ /**
14
+ * @inheritDoc
15
+ */
16
+ static get pluginName(): 'BoldUI';
17
+ /**
18
+ * @inheritDoc
19
+ */
20
+ init(): void;
21
+ }
22
+ declare module '@ckeditor/ckeditor5-core' {
23
+ interface PluginsMap {
24
+ [BoldUI.pluginName]: BoldUI;
25
+ }
26
+ }
package/src/bold.d.ts ADDED
@@ -0,0 +1,32 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/bold
7
+ */
8
+ import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
9
+ /**
10
+ * The bold feature.
11
+ *
12
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature} guide
13
+ * and the {@glink api/basic-styles package page}.
14
+ *
15
+ * This is a "glue" plugin which loads the {@link module:basic-styles/bold/boldediting~BoldEditing bold editing feature}
16
+ * and {@link module:basic-styles/bold/boldui~BoldUI bold UI feature}.
17
+ */
18
+ export default class Bold extends Plugin {
19
+ /**
20
+ * @inheritDoc
21
+ */
22
+ static get requires(): PluginDependencies;
23
+ /**
24
+ * @inheritDoc
25
+ */
26
+ static get pluginName(): 'Bold';
27
+ }
28
+ declare module '@ckeditor/ckeditor5-core' {
29
+ interface PluginsMap {
30
+ [Bold.pluginName]: Bold;
31
+ }
32
+ }
package/src/bold.js CHANGED
@@ -11,7 +11,7 @@ import BoldUI from './bold/boldui';
11
11
  /**
12
12
  * The bold feature.
13
13
  *
14
- * For a detailed overview check the {@glink features/basic-styles Basic styles feature documentation}
14
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature} guide
15
15
  * and the {@glink api/basic-styles package page}.
16
16
  *
17
17
  * This is a "glue" plugin which loads the {@link module:basic-styles/bold/boldediting~BoldEditing bold editing feature}
@@ -0,0 +1,33 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/code/codeediting
7
+ */
8
+ import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
9
+ /**
10
+ * The code editing feature.
11
+ *
12
+ * It registers the `'code'` command and introduces the `code` attribute in the model which renders to the view
13
+ * as a `<code>` element.
14
+ */
15
+ export default class CodeEditing extends Plugin {
16
+ /**
17
+ * @inheritDoc
18
+ */
19
+ static get pluginName(): 'CodeEditing';
20
+ /**
21
+ * @inheritDoc
22
+ */
23
+ static get requires(): PluginDependencies;
24
+ /**
25
+ * @inheritDoc
26
+ */
27
+ init(): void;
28
+ }
29
+ declare module '@ckeditor/ckeditor5-core' {
30
+ interface PluginsMap {
31
+ [CodeEditing.pluginName]: CodeEditing;
32
+ }
33
+ }
@@ -0,0 +1,27 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/code/codeui
7
+ */
8
+ import { Plugin } from 'ckeditor5/src/core';
9
+ import '../../theme/code.css';
10
+ /**
11
+ * The code UI feature. It introduces the Code button.
12
+ */
13
+ export default class CodeUI extends Plugin {
14
+ /**
15
+ * @inheritDoc
16
+ */
17
+ static get pluginName(): 'CodeUI';
18
+ /**
19
+ * @inheritDoc
20
+ */
21
+ init(): void;
22
+ }
23
+ declare module '@ckeditor/ckeditor5-core' {
24
+ interface PluginsMap {
25
+ [CodeUI.pluginName]: CodeUI;
26
+ }
27
+ }
package/src/code.d.ts ADDED
@@ -0,0 +1,33 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/code
7
+ */
8
+ import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
9
+ import '../theme/code.css';
10
+ /**
11
+ * The code feature.
12
+ *
13
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature} guide
14
+ * and the {@glink api/basic-styles package page}.
15
+ *
16
+ * This is a "glue" plugin which loads the {@link module:basic-styles/code/codeediting~CodeEditing code editing feature}
17
+ * and {@link module:basic-styles/code/codeui~CodeUI code UI feature}.
18
+ */
19
+ export default class Code extends Plugin {
20
+ /**
21
+ * @inheritDoc
22
+ */
23
+ static get requires(): PluginDependencies;
24
+ /**
25
+ * @inheritDoc
26
+ */
27
+ static get pluginName(): 'Code';
28
+ }
29
+ declare module '@ckeditor/ckeditor5-core' {
30
+ interface PluginsMap {
31
+ [Code.pluginName]: Code;
32
+ }
33
+ }
package/src/code.js CHANGED
@@ -12,7 +12,7 @@ import '../theme/code.css';
12
12
  /**
13
13
  * The code feature.
14
14
  *
15
- * For a detailed overview check the {@glink features/basic-styles Basic styles feature documentation}
15
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature} guide
16
16
  * and the {@glink api/basic-styles package page}.
17
17
  *
18
18
  * This is a "glue" plugin which loads the {@link module:basic-styles/code/codeediting~CodeEditing code editing feature}
package/src/index.d.ts ADDED
@@ -0,0 +1,28 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles
7
+ */
8
+ export { default as Bold } from './bold';
9
+ export { default as BoldEditing } from './bold/boldediting';
10
+ export { default as BoldUI } from './bold/boldui';
11
+ export { default as Code } from './code';
12
+ export { default as CodeEditing } from './code/codeediting';
13
+ export { default as CodeUI } from './code/codeui';
14
+ export { default as Italic } from './italic';
15
+ export { default as ItalicEditing } from './italic/italicediting';
16
+ export { default as ItalicUI } from './italic/italicui';
17
+ export { default as Strikethrough } from './strikethrough';
18
+ export { default as StrikethroughEditing } from './strikethrough/strikethroughediting';
19
+ export { default as StrikethroughUI } from './strikethrough/strikethroughui';
20
+ export { default as Subscript } from './subscript';
21
+ export { default as SubscriptEditing } from './subscript/subscriptediting';
22
+ export { default as SubscriptUI } from './subscript/subscriptui';
23
+ export { default as Superscript } from './superscript';
24
+ export { default as SuperscriptEditing } from './superscript/superscriptediting';
25
+ export { default as SuperscriptUI } from './superscript/superscriptui';
26
+ export { default as Underline } from './underline';
27
+ export { default as UnderlineEditing } from './underline/underlineediting';
28
+ export { default as UnderlineUI } from './underline/underlineui';
@@ -0,0 +1,29 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/italic/italicediting
7
+ */
8
+ import { Plugin } from 'ckeditor5/src/core';
9
+ /**
10
+ * The italic editing feature.
11
+ *
12
+ * It registers the `'italic'` command, the <kbd>Ctrl+I</kbd> keystroke and introduces the `italic` attribute in the model
13
+ * which renders to the view as an `<i>` element.
14
+ */
15
+ export default class ItalicEditing extends Plugin {
16
+ /**
17
+ * @inheritDoc
18
+ */
19
+ static get pluginName(): 'ItalicEditing';
20
+ /**
21
+ * @inheritDoc
22
+ */
23
+ init(): void;
24
+ }
25
+ declare module '@ckeditor/ckeditor5-core' {
26
+ interface PluginsMap {
27
+ [ItalicEditing.pluginName]: ItalicEditing;
28
+ }
29
+ }
@@ -0,0 +1,26 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/italic/italicui
7
+ */
8
+ import { Plugin } from 'ckeditor5/src/core';
9
+ /**
10
+ * The italic UI feature. It introduces the Italic button.
11
+ */
12
+ export default class ItalicUI extends Plugin {
13
+ /**
14
+ * @inheritDoc
15
+ */
16
+ static get pluginName(): 'ItalicUI';
17
+ /**
18
+ * @inheritDoc
19
+ */
20
+ init(): void;
21
+ }
22
+ declare module '@ckeditor/ckeditor5-core' {
23
+ interface PluginsMap {
24
+ [ItalicUI.pluginName]: ItalicUI;
25
+ }
26
+ }
@@ -0,0 +1,32 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/italic
7
+ */
8
+ import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
9
+ /**
10
+ * The italic feature.
11
+ *
12
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature} guide
13
+ * and the {@glink api/basic-styles package page}.
14
+ *
15
+ * This is a "glue" plugin which loads the {@link module:basic-styles/italic/italicediting~ItalicEditing} and
16
+ * {@link module:basic-styles/italic/italicui~ItalicUI} plugins.
17
+ */
18
+ export default class Italic extends Plugin {
19
+ /**
20
+ * @inheritDoc
21
+ */
22
+ static get requires(): PluginDependencies;
23
+ /**
24
+ * @inheritDoc
25
+ */
26
+ static get pluginName(): 'Italic';
27
+ }
28
+ declare module '@ckeditor/ckeditor5-core' {
29
+ interface PluginsMap {
30
+ [Italic.pluginName]: Italic;
31
+ }
32
+ }
package/src/italic.js CHANGED
@@ -11,7 +11,7 @@ import ItalicUI from './italic/italicui';
11
11
  /**
12
12
  * The italic feature.
13
13
  *
14
- * For a detailed overview check the {@glink features/basic-styles Basic styles feature documentation}
14
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature} guide
15
15
  * and the {@glink api/basic-styles package page}.
16
16
  *
17
17
  * This is a "glue" plugin which loads the {@link module:basic-styles/italic/italicediting~ItalicEditing} and
@@ -0,0 +1,30 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/strikethrough/strikethroughediting
7
+ */
8
+ import { Plugin } from 'ckeditor5/src/core';
9
+ /**
10
+ * The strikethrough editing feature.
11
+ *
12
+ * It registers the `'strikethrough'` command, the <kbd>Ctrl+Shift+X</kbd> keystroke and introduces the
13
+ * `strikethroughsthrough` attribute in the model which renders to the view
14
+ * as a `<s>` element.
15
+ */
16
+ export default class StrikethroughEditing extends Plugin {
17
+ /**
18
+ * @inheritDoc
19
+ */
20
+ static get pluginName(): 'StrikethroughEditing';
21
+ /**
22
+ * @inheritDoc
23
+ */
24
+ init(): void;
25
+ }
26
+ declare module '@ckeditor/ckeditor5-core' {
27
+ interface PluginsMap {
28
+ [StrikethroughEditing.pluginName]: StrikethroughEditing;
29
+ }
30
+ }
@@ -0,0 +1,26 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/strikethrough/strikethroughui
7
+ */
8
+ import { Plugin } from 'ckeditor5/src/core';
9
+ /**
10
+ * The strikethrough UI feature. It introduces the Strikethrough button.
11
+ */
12
+ export default class StrikethroughUI extends Plugin {
13
+ /**
14
+ * @inheritDoc
15
+ */
16
+ static get pluginName(): 'StrikethroughUI';
17
+ /**
18
+ * @inheritDoc
19
+ */
20
+ init(): void;
21
+ }
22
+ declare module '@ckeditor/ckeditor5-core' {
23
+ interface PluginsMap {
24
+ [StrikethroughUI.pluginName]: StrikethroughUI;
25
+ }
26
+ }
@@ -0,0 +1,32 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/strikethrough
7
+ */
8
+ import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
9
+ /**
10
+ * The strikethrough feature.
11
+ *
12
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature} guide
13
+ * and the {@glink api/basic-styles package page}.
14
+ *
15
+ * This is a "glue" plugin which loads the {@link module:basic-styles/strikethrough/strikethroughediting~StrikethroughEditing} and
16
+ * {@link module:basic-styles/strikethrough/strikethroughui~StrikethroughUI} plugins.
17
+ */
18
+ export default class Strikethrough extends Plugin {
19
+ /**
20
+ * @inheritDoc
21
+ */
22
+ static get requires(): PluginDependencies;
23
+ /**
24
+ * @inheritDoc
25
+ */
26
+ static get pluginName(): 'Strikethrough';
27
+ }
28
+ declare module '@ckeditor/ckeditor5-core' {
29
+ interface PluginsMap {
30
+ [Strikethrough.pluginName]: Strikethrough;
31
+ }
32
+ }
@@ -11,7 +11,7 @@ import StrikethroughUI from './strikethrough/strikethroughui';
11
11
  /**
12
12
  * The strikethrough feature.
13
13
  *
14
- * For a detailed overview check the {@glink features/basic-styles Basic styles feature documentation}
14
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature} guide
15
15
  * and the {@glink api/basic-styles package page}.
16
16
  *
17
17
  * This is a "glue" plugin which loads the {@link module:basic-styles/strikethrough/strikethroughediting~StrikethroughEditing} and
@@ -0,0 +1,29 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/subscript/subscriptediting
7
+ */
8
+ import { Plugin } from 'ckeditor5/src/core';
9
+ /**
10
+ * The subscript editing feature.
11
+ *
12
+ * It registers the `sub` command and introduces the `sub` attribute in the model which renders to the view
13
+ * as a `<sub>` element.
14
+ */
15
+ export default class SubscriptEditing extends Plugin {
16
+ /**
17
+ * @inheritDoc
18
+ */
19
+ static get pluginName(): 'SubscriptEditing';
20
+ /**
21
+ * @inheritDoc
22
+ */
23
+ init(): void;
24
+ }
25
+ declare module '@ckeditor/ckeditor5-core' {
26
+ interface PluginsMap {
27
+ [SubscriptEditing.pluginName]: SubscriptEditing;
28
+ }
29
+ }
@@ -0,0 +1,26 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/subscript/subscriptui
7
+ */
8
+ import { Plugin } from 'ckeditor5/src/core';
9
+ /**
10
+ * The subscript UI feature. It introduces the Subscript button.
11
+ */
12
+ export default class SubscriptUI extends Plugin {
13
+ /**
14
+ * @inheritDoc
15
+ */
16
+ static get pluginName(): 'SubscriptUI';
17
+ /**
18
+ * @inheritDoc
19
+ */
20
+ init(): void;
21
+ }
22
+ declare module '@ckeditor/ckeditor5-core' {
23
+ interface PluginsMap {
24
+ [SubscriptUI.pluginName]: SubscriptUI;
25
+ }
26
+ }
@@ -0,0 +1,29 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/subscript
7
+ */
8
+ import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
9
+ /**
10
+ * The subscript feature.
11
+ *
12
+ * It loads the {@link module:basic-styles/subscript/subscriptediting~SubscriptEditing} and
13
+ * {@link module:basic-styles/subscript/subscriptui~SubscriptUI} plugins.
14
+ */
15
+ export default class Subscript extends Plugin {
16
+ /**
17
+ * @inheritDoc
18
+ */
19
+ static get requires(): PluginDependencies;
20
+ /**
21
+ * @inheritDoc
22
+ */
23
+ static get pluginName(): 'Subscript';
24
+ }
25
+ declare module '@ckeditor/ckeditor5-core' {
26
+ interface PluginsMap {
27
+ [Subscript.pluginName]: Subscript;
28
+ }
29
+ }
@@ -0,0 +1,29 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/superscript/superscriptediting
7
+ */
8
+ import { Plugin } from 'ckeditor5/src/core';
9
+ /**
10
+ * The superscript editing feature.
11
+ *
12
+ * It registers the `super` command and introduces the `super` attribute in the model which renders to the view
13
+ * as a `<super>` element.
14
+ */
15
+ export default class SuperscriptEditing extends Plugin {
16
+ /**
17
+ * @inheritDoc
18
+ */
19
+ static get pluginName(): 'SuperscriptEditing';
20
+ /**
21
+ * @inheritDoc
22
+ */
23
+ init(): void;
24
+ }
25
+ declare module '@ckeditor/ckeditor5-core' {
26
+ interface PluginsMap {
27
+ [SuperscriptEditing.pluginName]: SuperscriptEditing;
28
+ }
29
+ }
@@ -0,0 +1,26 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/superscript/superscriptui
7
+ */
8
+ import { Plugin } from 'ckeditor5/src/core';
9
+ /**
10
+ * The superscript UI feature. It introduces the Superscript button.
11
+ */
12
+ export default class SuperscriptUI extends Plugin {
13
+ /**
14
+ * @inheritDoc
15
+ */
16
+ static get pluginName(): 'SuperscriptUI';
17
+ /**
18
+ * @inheritDoc
19
+ */
20
+ init(): void;
21
+ }
22
+ declare module '@ckeditor/ckeditor5-core' {
23
+ interface PluginsMap {
24
+ [SuperscriptUI.pluginName]: SuperscriptUI;
25
+ }
26
+ }
@@ -0,0 +1,29 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/superscript
7
+ */
8
+ import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
9
+ /**
10
+ * The superscript feature.
11
+ *
12
+ * It loads the {@link module:basic-styles/superscript/superscriptediting~SuperscriptEditing} and
13
+ * {@link module:basic-styles/superscript/superscriptui~SuperscriptUI} plugins.
14
+ */
15
+ export default class Superscript extends Plugin {
16
+ /**
17
+ * @inheritDoc
18
+ */
19
+ static get requires(): PluginDependencies;
20
+ /**
21
+ * @inheritDoc
22
+ */
23
+ static get pluginName(): 'Superscript';
24
+ }
25
+ declare module '@ckeditor/ckeditor5-core' {
26
+ interface PluginsMap {
27
+ [Superscript.pluginName]: Superscript;
28
+ }
29
+ }
@@ -0,0 +1,29 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/underline/underlineediting
7
+ */
8
+ import { Plugin } from 'ckeditor5/src/core';
9
+ /**
10
+ * The underline editing feature.
11
+ *
12
+ * It registers the `'underline'` command, the <kbd>Ctrl+U</kbd> keystroke
13
+ * and introduces the `underline` attribute in the model which renders to the view as an `<u>` element.
14
+ */
15
+ export default class UnderlineEditing extends Plugin {
16
+ /**
17
+ * @inheritDoc
18
+ */
19
+ static get pluginName(): 'UnderlineEditing';
20
+ /**
21
+ * @inheritDoc
22
+ */
23
+ init(): void;
24
+ }
25
+ declare module '@ckeditor/ckeditor5-core' {
26
+ interface PluginsMap {
27
+ [UnderlineEditing.pluginName]: UnderlineEditing;
28
+ }
29
+ }
@@ -0,0 +1,26 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/underline/underlineui
7
+ */
8
+ import { Plugin } from 'ckeditor5/src/core';
9
+ /**
10
+ * The underline UI feature. It introduces the Underline button.
11
+ */
12
+ export default class UnderlineUI extends Plugin {
13
+ /**
14
+ * @inheritDoc
15
+ */
16
+ static get pluginName(): 'UnderlineUI';
17
+ /**
18
+ * @inheritDoc
19
+ */
20
+ init(): void;
21
+ }
22
+ declare module '@ckeditor/ckeditor5-core' {
23
+ interface PluginsMap {
24
+ [UnderlineUI.pluginName]: UnderlineUI;
25
+ }
26
+ }
@@ -0,0 +1,32 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module basic-styles/underline
7
+ */
8
+ import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
9
+ /**
10
+ * The underline feature.
11
+ *
12
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature} guide
13
+ * and the {@glink api/basic-styles package page}.
14
+ *
15
+ * This is a "glue" plugin which loads the {@link module:basic-styles/underline/underlineediting~UnderlineEditing} and
16
+ * {@link module:basic-styles/underline/underlineui~UnderlineUI} plugins.
17
+ */
18
+ export default class Underline extends Plugin {
19
+ /**
20
+ * @inheritDoc
21
+ */
22
+ static get requires(): PluginDependencies;
23
+ /**
24
+ * @inheritDoc
25
+ */
26
+ static get pluginName(): 'Underline';
27
+ }
28
+ declare module '@ckeditor/ckeditor5-core' {
29
+ interface PluginsMap {
30
+ [Underline.pluginName]: Underline;
31
+ }
32
+ }
package/src/underline.js CHANGED
@@ -11,7 +11,7 @@ import UnderlineUI from './underline/underlineui';
11
11
  /**
12
12
  * The underline feature.
13
13
  *
14
- * For a detailed overview check the {@glink features/basic-styles Basic styles feature documentation}
14
+ * For a detailed overview check the {@glink features/basic-styles Basic styles feature} guide
15
15
  * and the {@glink api/basic-styles package page}.
16
16
  *
17
17
  * This is a "glue" plugin which loads the {@link module:basic-styles/underline/underlineediting~UnderlineEditing} and