@ckeditor/ckeditor5-code-block 48.2.0 → 48.3.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/dist/augmentation.d.ts +23 -23
- package/dist/codeblock.d.ts +28 -28
- package/dist/codeblockcommand.d.ts +56 -56
- package/dist/codeblockconfig.d.ts +142 -142
- package/dist/codeblockediting.d.ts +42 -42
- package/dist/codeblockui.d.ts +28 -28
- package/dist/converters.d.ts +119 -119
- package/dist/indentcodeblockcommand.d.ts +28 -28
- package/dist/index.css.map +1 -1
- package/dist/index.d.ts +15 -15
- package/dist/index.js +1140 -1426
- package/dist/index.js.map +1 -1
- package/dist/outdentcodeblockcommand.d.ts +29 -29
- package/dist/utils.d.ts +174 -174
- package/package.json +8 -8
|
@@ -1,33 +1,33 @@
|
|
|
1
1
|
/**
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
import { Command, type Editor } from
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
|
|
4
|
+
*/
|
|
5
|
+
import { Command, type Editor } from "@ckeditor/ckeditor5-core";
|
|
6
6
|
/**
|
|
7
|
-
|
|
8
|
-
|
|
7
|
+
* The code block indentation decrease command plugin.
|
|
8
|
+
*/
|
|
9
9
|
export declare class OutdentCodeBlockCommand extends Command {
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
10
|
+
/**
|
|
11
|
+
* A sequence of characters removed from the line when the command is executed.
|
|
12
|
+
*/
|
|
13
|
+
private readonly _indentSequence;
|
|
14
|
+
constructor(editor: Editor);
|
|
15
|
+
/**
|
|
16
|
+
* @inheritDoc
|
|
17
|
+
*/
|
|
18
|
+
override refresh(): void;
|
|
19
|
+
/**
|
|
20
|
+
* Executes the command. When the command {@link #isEnabled is enabled}, the indentation of the
|
|
21
|
+
* code lines in the selection will be decreased.
|
|
22
|
+
*
|
|
23
|
+
* @fires execute
|
|
24
|
+
*/
|
|
25
|
+
override execute(): void;
|
|
26
|
+
/**
|
|
27
|
+
* Checks whether the command can be enabled in the current context.
|
|
28
|
+
*
|
|
29
|
+
* @private
|
|
30
|
+
* @returns {Boolean} Whether the command should be enabled.
|
|
31
|
+
*/
|
|
32
|
+
private _checkEnabled;
|
|
33
33
|
}
|
package/dist/utils.d.ts
CHANGED
|
@@ -1,193 +1,193 @@
|
|
|
1
1
|
/**
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
2
|
+
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
|
|
4
|
+
*/
|
|
5
5
|
/**
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
import type { Editor } from
|
|
9
|
-
import type { CodeBlockLanguageDefinition } from
|
|
10
|
-
import type { ModelDocumentSelection, ModelElement, Model, ModelPosition, ModelSchema, ModelText, ViewUpcastWriter, ViewDocumentFragment } from
|
|
11
|
-
import { type LocaleTranslate } from
|
|
6
|
+
* @module code-block/utils
|
|
7
|
+
*/
|
|
8
|
+
import type { Editor } from "@ckeditor/ckeditor5-core";
|
|
9
|
+
import type { CodeBlockLanguageDefinition } from "./codeblockconfig.js";
|
|
10
|
+
import type { ModelDocumentSelection, ModelElement, Model, ModelPosition, ModelSchema, ModelText, ViewUpcastWriter, ViewDocumentFragment } from "@ckeditor/ckeditor5-engine";
|
|
11
|
+
import { type LocaleTranslate } from "@ckeditor/ckeditor5-utils";
|
|
12
12
|
/**
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
13
|
+
* Returns code block languages as defined in `config.codeBlock.languages` but processed:
|
|
14
|
+
*
|
|
15
|
+
* * To consider the editor localization, i.e. to display {@link module:code-block/codeblockconfig~CodeBlockLanguageDefinition}
|
|
16
|
+
* in the correct language. There is no way to use {@link module:utils/locale~Locale#t} when the user
|
|
17
|
+
* configuration is defined because the editor does not exist yet.
|
|
18
|
+
* * To make sure each definition has a CSS class associated with it even if not specified
|
|
19
|
+
* in the original configuration.
|
|
20
|
+
*
|
|
21
|
+
* @internal
|
|
22
|
+
*/
|
|
23
23
|
export declare function getNormalizedAndLocalizedLanguageDefinitions(editor: Editor): Array<CodeBlockLanguageDefinition>;
|
|
24
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
|
-
|
|
25
|
+
* Returns an object associating certain language definition properties with others. For instance:
|
|
26
|
+
*
|
|
27
|
+
* For:
|
|
28
|
+
*
|
|
29
|
+
* ```ts
|
|
30
|
+
* const definitions = {
|
|
31
|
+
* { language: 'php', class: 'language-php', label: 'PHP' },
|
|
32
|
+
* { language: 'javascript', class: 'js', label: 'JavaScript' },
|
|
33
|
+
* };
|
|
34
|
+
*
|
|
35
|
+
* getPropertyAssociation( definitions, 'class', 'language' );
|
|
36
|
+
* ```
|
|
37
|
+
*
|
|
38
|
+
* returns:
|
|
39
|
+
*
|
|
40
|
+
* ```ts
|
|
41
|
+
* {
|
|
42
|
+
* 'language-php': 'php',
|
|
43
|
+
* 'js': 'javascript'
|
|
44
|
+
* }
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* and
|
|
48
|
+
*
|
|
49
|
+
* ```ts
|
|
50
|
+
* getPropertyAssociation( definitions, 'language', 'label' );
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
53
|
+
* returns:
|
|
54
|
+
*
|
|
55
|
+
* ```ts
|
|
56
|
+
* {
|
|
57
|
+
* 'php': 'PHP',
|
|
58
|
+
* 'javascript': 'JavaScript'
|
|
59
|
+
* }
|
|
60
|
+
* ```
|
|
61
|
+
*
|
|
62
|
+
* @internal
|
|
63
|
+
*/
|
|
64
64
|
export declare function getPropertyAssociation(languageDefs: Array<CodeBlockLanguageDefinition>, key: keyof CodeBlockLanguageDefinition, value: keyof CodeBlockLanguageDefinition): Record<string, string>;
|
|
65
65
|
/**
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
66
|
+
* For a given model text node, it returns white spaces that precede other characters in that node.
|
|
67
|
+
* This corresponds to the indentation part of the code block line.
|
|
68
|
+
*
|
|
69
|
+
* @internal
|
|
70
|
+
*/
|
|
71
71
|
export declare function getLeadingWhiteSpaces(textNode: ModelText): string;
|
|
72
72
|
/**
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
73
|
+
* For plain text containing the code (a snippet), it returns a document fragment containing
|
|
74
|
+
* view text nodes separated by `<br>` elements (in place of new line characters "\n"), for instance:
|
|
75
|
+
*
|
|
76
|
+
* Input:
|
|
77
|
+
*
|
|
78
|
+
* ```ts
|
|
79
|
+
* "foo()\n
|
|
80
|
+
* bar()"
|
|
81
|
+
* ```
|
|
82
|
+
*
|
|
83
|
+
* Output:
|
|
84
|
+
*
|
|
85
|
+
* ```html
|
|
86
|
+
* <DocumentFragment>
|
|
87
|
+
* "foo()"
|
|
88
|
+
* <br/>
|
|
89
|
+
* "bar()"
|
|
90
|
+
* </DocumentFragment>
|
|
91
|
+
* ```
|
|
92
|
+
*
|
|
93
|
+
* @param text The raw code text to be converted.
|
|
94
|
+
* @internal
|
|
95
|
+
*/
|
|
96
96
|
export declare function rawSnippetTextToViewDocumentFragment(writer: ViewUpcastWriter, text: string): ViewDocumentFragment;
|
|
97
97
|
/**
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
98
|
+
* Returns an array of all model positions within the selection that represent code block lines.
|
|
99
|
+
*
|
|
100
|
+
* If the selection is collapsed, it returns the exact selection anchor position:
|
|
101
|
+
*
|
|
102
|
+
* ```html
|
|
103
|
+
* <codeBlock>[]foo</codeBlock> -> <codeBlock>^foo</codeBlock>
|
|
104
|
+
* <codeBlock>foo[]bar</codeBlock> -> <codeBlock>foo^bar</codeBlock>
|
|
105
|
+
* ```
|
|
106
|
+
*
|
|
107
|
+
* Otherwise, it returns positions **before** each text node belonging to all code blocks contained by the selection:
|
|
108
|
+
*
|
|
109
|
+
* ```html
|
|
110
|
+
* <codeBlock> <codeBlock>
|
|
111
|
+
* foo[bar ^foobar
|
|
112
|
+
* <softBreak></softBreak> -> <softBreak></softBreak>
|
|
113
|
+
* baz]qux ^bazqux
|
|
114
|
+
* </codeBlock> </codeBlock>
|
|
115
|
+
* ```
|
|
116
|
+
*
|
|
117
|
+
* It also works across other non–code blocks:
|
|
118
|
+
*
|
|
119
|
+
* ```html
|
|
120
|
+
* <codeBlock> <codeBlock>
|
|
121
|
+
* foo[bar ^foobar
|
|
122
|
+
* </codeBlock> </codeBlock>
|
|
123
|
+
* <paragraph>text</paragraph> -> <paragraph>text</paragraph>
|
|
124
|
+
* <codeBlock> <codeBlock>
|
|
125
|
+
* baz]qux ^bazqux
|
|
126
|
+
* </codeBlock> </codeBlock>
|
|
127
|
+
* ```
|
|
128
|
+
*
|
|
129
|
+
* **Note:** The positions are in reverse order so they do not get outdated when iterating over them and
|
|
130
|
+
* the writer inserts or removes elements at the same time.
|
|
131
|
+
*
|
|
132
|
+
* **Note:** The position is located after the leading white spaces in the text node.
|
|
133
|
+
*
|
|
134
|
+
* @internal
|
|
135
|
+
*/
|
|
136
136
|
export declare function getIndentOutdentPositions(model: Model): Array<ModelPosition>;
|
|
137
137
|
/**
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
138
|
+
* Checks if any of the blocks within the model selection is a code block.
|
|
139
|
+
*
|
|
140
|
+
* @internal
|
|
141
|
+
*/
|
|
142
142
|
export declare function isModelSelectionInCodeBlock(selection: ModelDocumentSelection): boolean;
|
|
143
143
|
/**
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
144
|
+
* Checks if an {@link module:engine/model/element~ModelElement Element} can become a code block.
|
|
145
|
+
*
|
|
146
|
+
* @param schema Model's schema.
|
|
147
|
+
* @param element The element to be checked.
|
|
148
|
+
* @returns Check result.
|
|
149
|
+
* @internal
|
|
150
|
+
*/
|
|
151
151
|
export declare function canBeCodeBlock(schema: ModelSchema, element: ModelElement): boolean;
|
|
152
152
|
/**
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
export declare function getCodeBlockAriaAnnouncement(t: LocaleTranslate, languageDefs: Array<CodeBlockLanguageDefinition>, element: ModelElement, direction:
|
|
153
|
+
* Get the translated message read by the screen reader when you enter or exit an element with your cursor.
|
|
154
|
+
*
|
|
155
|
+
* @internal
|
|
156
|
+
*/
|
|
157
|
+
export declare function getCodeBlockAriaAnnouncement(t: LocaleTranslate, languageDefs: Array<CodeBlockLanguageDefinition>, element: ModelElement, direction: "enter" | "leave"): string;
|
|
158
158
|
/**
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
159
|
+
* For given position, finds the closest position that is at the beginning of a line of code and returns a text node that is at the
|
|
160
|
+
* beginning of the line (or `null` if there's no text node at the beginning of a given line).
|
|
161
|
+
*
|
|
162
|
+
* Line beings at the start of a code block element and after each `softBreak` element.
|
|
163
|
+
*
|
|
164
|
+
* Note: even though code block doesn't allow inline elements other than `<softBreak>` by default, some features may overwrite this rule,
|
|
165
|
+
* so such inline elements are taken into account.
|
|
166
|
+
*
|
|
167
|
+
* Some examples of expected results:
|
|
168
|
+
*
|
|
169
|
+
* ```
|
|
170
|
+
* <codeBlock>^</codeBlock> -> null
|
|
171
|
+
* <codeBlock>^foobar</codeBlock> -> <codeBlock>[foobar]</codeBlock>
|
|
172
|
+
* <codeBlock>foobar^</codeBlock> -> <codeBlock>[foobar]</codeBlock>
|
|
173
|
+
* <codeBlock>foo^bar</codeBlock> -> <codeBlock>[foobar]</codeBlock>
|
|
174
|
+
* <codeBlock>foo^<softBreak />bar</codeBlock> -> <codeBlock>[foo]<softBreak />bar</codeBlock>
|
|
175
|
+
* <codeBlock>foo<softBreak />bar^</codeBlock> -> <codeBlock>foo<softBreak />[bar]</codeBlock>
|
|
176
|
+
* <codeBlock>foo<softBreak />b^ar</codeBlock> -> <codeBlock>foo<softBreak />[bar]</codeBlock>
|
|
177
|
+
* <codeBlock>foo<softBreak />^bar</codeBlock> -> <codeBlock>foo<softBreak />[bar]</codeBlock>
|
|
178
|
+
* <codeBlock>^<element /></codeBlock> -> null
|
|
179
|
+
* <codeBlock><element />^</codeBlock> -> null
|
|
180
|
+
* <codeBlock>foo^<element /></codeBlock> -> <codeBlock>[foo]<element /></codeBlock>
|
|
181
|
+
* <codeBlock>foo<element />^</codeBlock> -> <codeBlock>[foo]<element /></codeBlock>
|
|
182
|
+
* <codeBlock>foo<element />bar^</codeBlock> -> <codeBlock>[foo]<element />bar</codeBlock>
|
|
183
|
+
* <codeBlock><element />bar^</codeBlock> -> null
|
|
184
|
+
* <codeBlock>foo<softBreak />^<softBreak /></codeBlock> -> null
|
|
185
|
+
* <codeBlock>foo<softBreak />^<element /></codeBlock> -> null
|
|
186
|
+
* <codeBlock>foo<softBreak /><element />^</codeBlock> -> null
|
|
187
|
+
* <codeBlock>foo<softBreak />bar<element />^</codeBlock> -> <codeBlock>foo<softBreak />[bar]<element /></codeBlock>
|
|
188
|
+
* <codeBlock>foo<softBreak /><element />ba^r</codeBlock> -> null
|
|
189
|
+
* ```
|
|
190
|
+
*
|
|
191
|
+
* @internal
|
|
192
|
+
*/
|
|
193
193
|
export declare function getTextNodeAtLineStart(position: ModelPosition, model: Model): ModelText | null;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ckeditor/ckeditor5-code-block",
|
|
3
|
-
"version": "48.
|
|
3
|
+
"version": "48.3.0-alpha.0",
|
|
4
4
|
"description": "Code block feature for CKEditor 5.",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
6
6
|
"author": "CKSource (http://cksource.com/)",
|
|
@@ -26,13 +26,13 @@
|
|
|
26
26
|
"./package.json": "./package.json"
|
|
27
27
|
},
|
|
28
28
|
"dependencies": {
|
|
29
|
-
"@ckeditor/ckeditor5-core": "48.
|
|
30
|
-
"@ckeditor/ckeditor5-clipboard": "48.
|
|
31
|
-
"@ckeditor/ckeditor5-engine": "48.
|
|
32
|
-
"@ckeditor/ckeditor5-enter": "48.
|
|
33
|
-
"@ckeditor/ckeditor5-icons": "48.
|
|
34
|
-
"@ckeditor/ckeditor5-ui": "48.
|
|
35
|
-
"@ckeditor/ckeditor5-utils": "48.
|
|
29
|
+
"@ckeditor/ckeditor5-core": "48.3.0-alpha.0",
|
|
30
|
+
"@ckeditor/ckeditor5-clipboard": "48.3.0-alpha.0",
|
|
31
|
+
"@ckeditor/ckeditor5-engine": "48.3.0-alpha.0",
|
|
32
|
+
"@ckeditor/ckeditor5-enter": "48.3.0-alpha.0",
|
|
33
|
+
"@ckeditor/ckeditor5-icons": "48.3.0-alpha.0",
|
|
34
|
+
"@ckeditor/ckeditor5-ui": "48.3.0-alpha.0",
|
|
35
|
+
"@ckeditor/ckeditor5-utils": "48.3.0-alpha.0"
|
|
36
36
|
},
|
|
37
37
|
"files": [
|
|
38
38
|
"dist",
|