@ckeditor/ckeditor5-special-characters 39.0.2 → 40.0.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-special-characters",
3
- "version": "39.0.2",
3
+ "version": "40.0.0",
4
4
  "description": "Special characters feature for CKEditor 5.",
5
5
  "keywords": [
6
6
  "ckeditor",
@@ -12,7 +12,7 @@
12
12
  ],
13
13
  "main": "src/index.js",
14
14
  "dependencies": {
15
- "ckeditor5": "39.0.2"
15
+ "ckeditor5": "40.0.0"
16
16
  },
17
17
  "author": "CKSource (http://cksource.com/)",
18
18
  "license": "GPL-2.0-or-later",
@@ -1,24 +1,24 @@
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
- import type { SpecialCharacters, SpecialCharactersArrows, SpecialCharactersCurrency, SpecialCharactersEssentials, SpecialCharactersLatin, SpecialCharactersMathematical, SpecialCharactersText, SpecialCharactersConfig } from './index';
6
- declare module '@ckeditor/ckeditor5-core' {
7
- interface PluginsMap {
8
- [SpecialCharacters.pluginName]: SpecialCharacters;
9
- [SpecialCharactersText.pluginName]: SpecialCharactersText;
10
- [SpecialCharactersArrows.pluginName]: SpecialCharactersArrows;
11
- [SpecialCharactersEssentials.pluginName]: SpecialCharactersEssentials;
12
- [SpecialCharactersLatin.pluginName]: SpecialCharactersLatin;
13
- [SpecialCharactersCurrency.pluginName]: SpecialCharactersCurrency;
14
- [SpecialCharactersMathematical.pluginName]: SpecialCharactersMathematical;
15
- }
16
- interface EditorConfig {
17
- /**
18
- * The configuration of the {@link module:special-characters/specialcharacters~SpecialCharacters} feature.
19
- *
20
- * Read more in {@link module:special-characters/specialcharactersconfig~SpecialCharactersConfig}.
21
- */
22
- specialCharacters?: SpecialCharactersConfig;
23
- }
24
- }
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
+ import type { SpecialCharacters, SpecialCharactersArrows, SpecialCharactersCurrency, SpecialCharactersEssentials, SpecialCharactersLatin, SpecialCharactersMathematical, SpecialCharactersText, SpecialCharactersConfig } from './index';
6
+ declare module '@ckeditor/ckeditor5-core' {
7
+ interface PluginsMap {
8
+ [SpecialCharacters.pluginName]: SpecialCharacters;
9
+ [SpecialCharactersText.pluginName]: SpecialCharactersText;
10
+ [SpecialCharactersArrows.pluginName]: SpecialCharactersArrows;
11
+ [SpecialCharactersEssentials.pluginName]: SpecialCharactersEssentials;
12
+ [SpecialCharactersLatin.pluginName]: SpecialCharactersLatin;
13
+ [SpecialCharactersCurrency.pluginName]: SpecialCharactersCurrency;
14
+ [SpecialCharactersMathematical.pluginName]: SpecialCharactersMathematical;
15
+ }
16
+ interface EditorConfig {
17
+ /**
18
+ * The configuration of the {@link module:special-characters/specialcharacters~SpecialCharacters} feature.
19
+ *
20
+ * Read more in {@link module:special-characters/specialcharactersconfig~SpecialCharactersConfig}.
21
+ */
22
+ specialCharacters?: SpecialCharactersConfig;
23
+ }
24
+ }
@@ -1,5 +1,5 @@
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
- export {};
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
+ export {};
package/src/index.d.ts CHANGED
@@ -1,16 +1,16 @@
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 special-characters
7
- */
8
- export { default as SpecialCharacters } from './specialcharacters';
9
- export { default as SpecialCharactersArrows } from './specialcharactersarrows';
10
- export { default as SpecialCharactersText } from './specialcharacterstext';
11
- export { default as SpecialCharactersMathematical } from './specialcharactersmathematical';
12
- export { default as SpecialCharactersLatin } from './specialcharacterslatin';
13
- export { default as SpecialCharactersEssentials } from './specialcharactersessentials';
14
- export { default as SpecialCharactersCurrency } from './specialcharacterscurrency';
15
- export type { SpecialCharactersConfig } from './specialcharactersconfig';
16
- import './augmentation';
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 special-characters
7
+ */
8
+ export { default as SpecialCharacters } from './specialcharacters';
9
+ export { default as SpecialCharactersArrows } from './specialcharactersarrows';
10
+ export { default as SpecialCharactersText } from './specialcharacterstext';
11
+ export { default as SpecialCharactersMathematical } from './specialcharactersmathematical';
12
+ export { default as SpecialCharactersLatin } from './specialcharacterslatin';
13
+ export { default as SpecialCharactersEssentials } from './specialcharactersessentials';
14
+ export { default as SpecialCharactersCurrency } from './specialcharacterscurrency';
15
+ export type { SpecialCharactersConfig } from './specialcharactersconfig';
16
+ import './augmentation';
package/src/index.js CHANGED
@@ -1,15 +1,15 @@
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 special-characters
7
- */
8
- export { default as SpecialCharacters } from './specialcharacters';
9
- export { default as SpecialCharactersArrows } from './specialcharactersarrows';
10
- export { default as SpecialCharactersText } from './specialcharacterstext';
11
- export { default as SpecialCharactersMathematical } from './specialcharactersmathematical';
12
- export { default as SpecialCharactersLatin } from './specialcharacterslatin';
13
- export { default as SpecialCharactersEssentials } from './specialcharactersessentials';
14
- export { default as SpecialCharactersCurrency } from './specialcharacterscurrency';
15
- import './augmentation';
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 special-characters
7
+ */
8
+ export { default as SpecialCharacters } from './specialcharacters';
9
+ export { default as SpecialCharactersArrows } from './specialcharactersarrows';
10
+ export { default as SpecialCharactersText } from './specialcharacterstext';
11
+ export { default as SpecialCharactersMathematical } from './specialcharactersmathematical';
12
+ export { default as SpecialCharactersLatin } from './specialcharacterslatin';
13
+ export { default as SpecialCharactersEssentials } from './specialcharactersessentials';
14
+ export { default as SpecialCharactersCurrency } from './specialcharacterscurrency';
15
+ import './augmentation';
@@ -1,96 +1,96 @@
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 special-characters/specialcharacters
7
- */
8
- import { Plugin, type Editor } from 'ckeditor5/src/core';
9
- import { Typing } from 'ckeditor5/src/typing';
10
- import '../theme/specialcharacters.css';
11
- /**
12
- * The special characters feature.
13
- *
14
- * Introduces the `'specialCharacters'` dropdown.
15
- */
16
- export default class SpecialCharacters extends Plugin {
17
- /**
18
- * Registered characters. A pair of a character name and its symbol.
19
- */
20
- private _characters;
21
- /**
22
- * Registered groups. Each group contains a displayed label and a collection with symbol names.
23
- */
24
- private _groups;
25
- /**
26
- * A label describing the "All" special characters category.
27
- */
28
- private _allSpecialCharactersGroupLabel;
29
- /**
30
- * @inheritDoc
31
- */
32
- static get requires(): readonly [typeof Typing];
33
- /**
34
- * @inheritDoc
35
- */
36
- static get pluginName(): "SpecialCharacters";
37
- /**
38
- * @inheritDoc
39
- */
40
- constructor(editor: Editor);
41
- /**
42
- * @inheritDoc
43
- */
44
- init(): void;
45
- /**
46
- * Adds a collection of special characters to the specified group. The title of a special character must be unique.
47
- *
48
- * **Note:** The "All" category name is reserved by the plugin and cannot be used as a new name for a special
49
- * characters category.
50
- */
51
- addItems(groupName: string, items: Array<SpecialCharacterDefinition>, options?: {
52
- label: string;
53
- }): void;
54
- /**
55
- * Returns special character groups in an order determined based on configuration and registration sequence.
56
- */
57
- getGroups(): Set<string>;
58
- /**
59
- * Returns a collection of special characters symbol names (titles).
60
- */
61
- getCharactersForGroup(groupName: string): Set<string> | undefined;
62
- /**
63
- * Returns the symbol of a special character for the specified name. If the special character could not be found, `undefined`
64
- * is returned.
65
- *
66
- * @param title The title of a special character.
67
- */
68
- getCharacter(title: string): string | undefined;
69
- /**
70
- * Returns a group of special characters. If the group with the specified name does not exist, it will be created.
71
- *
72
- * @param groupName The name of the group to create.
73
- * @param label The label describing the new group.
74
- */
75
- private _getGroup;
76
- /**
77
- * Updates the symbol grid depending on the currently selected character group.
78
- */
79
- private _updateGrid;
80
- /**
81
- * Initializes the dropdown, used for lazy loading.
82
- *
83
- * @returns An object with `navigationView`, `gridView` and `infoView` properties, containing UI parts.
84
- */
85
- private _createDropdownPanelContent;
86
- }
87
- export interface SpecialCharacterDefinition {
88
- /**
89
- * A unique name of the character (e.g. "greek small letter epsilon").
90
- */
91
- title: string;
92
- /**
93
- * A human-readable character displayed as the label (e.g. "ε").
94
- */
95
- character: string;
96
- }
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 special-characters/specialcharacters
7
+ */
8
+ import { Plugin, type Editor } from 'ckeditor5/src/core';
9
+ import { Typing } from 'ckeditor5/src/typing';
10
+ import '../theme/specialcharacters.css';
11
+ /**
12
+ * The special characters feature.
13
+ *
14
+ * Introduces the `'specialCharacters'` dropdown.
15
+ */
16
+ export default class SpecialCharacters extends Plugin {
17
+ /**
18
+ * Registered characters. A pair of a character name and its symbol.
19
+ */
20
+ private _characters;
21
+ /**
22
+ * Registered groups. Each group contains a displayed label and a collection with symbol names.
23
+ */
24
+ private _groups;
25
+ /**
26
+ * A label describing the "All" special characters category.
27
+ */
28
+ private _allSpecialCharactersGroupLabel;
29
+ /**
30
+ * @inheritDoc
31
+ */
32
+ static get requires(): readonly [typeof Typing];
33
+ /**
34
+ * @inheritDoc
35
+ */
36
+ static get pluginName(): "SpecialCharacters";
37
+ /**
38
+ * @inheritDoc
39
+ */
40
+ constructor(editor: Editor);
41
+ /**
42
+ * @inheritDoc
43
+ */
44
+ init(): void;
45
+ /**
46
+ * Adds a collection of special characters to the specified group. The title of a special character must be unique.
47
+ *
48
+ * **Note:** The "All" category name is reserved by the plugin and cannot be used as a new name for a special
49
+ * characters category.
50
+ */
51
+ addItems(groupName: string, items: Array<SpecialCharacterDefinition>, options?: {
52
+ label: string;
53
+ }): void;
54
+ /**
55
+ * Returns special character groups in an order determined based on configuration and registration sequence.
56
+ */
57
+ getGroups(): Set<string>;
58
+ /**
59
+ * Returns a collection of special characters symbol names (titles).
60
+ */
61
+ getCharactersForGroup(groupName: string): Set<string> | undefined;
62
+ /**
63
+ * Returns the symbol of a special character for the specified name. If the special character could not be found, `undefined`
64
+ * is returned.
65
+ *
66
+ * @param title The title of a special character.
67
+ */
68
+ getCharacter(title: string): string | undefined;
69
+ /**
70
+ * Returns a group of special characters. If the group with the specified name does not exist, it will be created.
71
+ *
72
+ * @param groupName The name of the group to create.
73
+ * @param label The label describing the new group.
74
+ */
75
+ private _getGroup;
76
+ /**
77
+ * Updates the symbol grid depending on the currently selected character group.
78
+ */
79
+ private _updateGrid;
80
+ /**
81
+ * Initializes the dropdown, used for lazy loading.
82
+ *
83
+ * @returns An object with `navigationView`, `gridView` and `infoView` properties, containing UI parts.
84
+ */
85
+ private _createDropdownPanelContent;
86
+ }
87
+ export interface SpecialCharacterDefinition {
88
+ /**
89
+ * A unique name of the character (e.g. "greek small letter epsilon").
90
+ */
91
+ title: string;
92
+ /**
93
+ * A human-readable character displayed as the label (e.g. "ε").
94
+ */
95
+ character: string;
96
+ }