@ckeditor/ckeditor5-list 48.2.0-alpha.7 → 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.
Files changed (61) hide show
  1. package/dist/augmentation.d.ts +54 -54
  2. package/dist/index.css.map +1 -1
  3. package/dist/index.d.ts +67 -67
  4. package/dist/index.js +7187 -8921
  5. package/dist/index.js.map +1 -1
  6. package/dist/legacyerrors.d.ts +0 -4
  7. package/dist/legacylist/legacyconverters.d.ts +184 -184
  8. package/dist/legacylist/legacyindentcommand.d.ts +33 -33
  9. package/dist/legacylist/legacylistcommand.d.ts +52 -52
  10. package/dist/legacylist/legacylistediting.d.ts +32 -32
  11. package/dist/legacylist/legacylistutils.d.ts +40 -40
  12. package/dist/legacylist/legacyutils.d.ts +91 -91
  13. package/dist/legacylist.d.ts +25 -25
  14. package/dist/legacylistproperties/legacylistpropertiesediting.d.ts +71 -71
  15. package/dist/legacylistproperties/legacylistreversedcommand.d.ts +33 -33
  16. package/dist/legacylistproperties/legacyliststartcommand.d.ts +33 -33
  17. package/dist/legacylistproperties/legacyliststylecommand.d.ts +63 -63
  18. package/dist/legacylistproperties.d.ts +26 -26
  19. package/dist/legacytodolist/legacychecktodolistcommand.d.ts +47 -47
  20. package/dist/legacytodolist/legacytodolistconverters.d.ts +76 -76
  21. package/dist/legacytodolist/legacytodolistediting.d.ts +46 -46
  22. package/dist/legacytodolist.d.ts +26 -26
  23. package/dist/list/adjacentlistssupport.d.ts +16 -16
  24. package/dist/list/converters.d.ts +68 -68
  25. package/dist/list/listcommand.d.ts +84 -84
  26. package/dist/list/listediting.d.ts +213 -219
  27. package/dist/list/listindentcommand.d.ts +54 -54
  28. package/dist/list/listmergecommand.d.ts +68 -68
  29. package/dist/list/listsplitcommand.d.ts +59 -59
  30. package/dist/list/listui.d.ts +19 -19
  31. package/dist/list/listutils.d.ts +55 -55
  32. package/dist/list/utils/listwalker.d.ts +139 -139
  33. package/dist/list/utils/model.d.ts +202 -202
  34. package/dist/list/utils/postfixers.d.ts +30 -30
  35. package/dist/list/utils/view.d.ts +65 -65
  36. package/dist/list/utils.d.ts +15 -15
  37. package/dist/list.d.ts +25 -25
  38. package/dist/listconfig.d.ts +234 -234
  39. package/dist/listformatting/listitemboldintegration.d.ts +29 -29
  40. package/dist/listformatting/listitemfontcolorintegration.d.ts +29 -29
  41. package/dist/listformatting/listitemfontfamilyintegration.d.ts +29 -29
  42. package/dist/listformatting/listitemfontsizeintegration.d.ts +29 -29
  43. package/dist/listformatting/listitemitalicintegration.d.ts +29 -29
  44. package/dist/listformatting.d.ts +66 -66
  45. package/dist/listproperties/converters.d.ts +15 -15
  46. package/dist/listproperties/listpropertiesediting.d.ts +91 -91
  47. package/dist/listproperties/listpropertiesui.d.ts +22 -22
  48. package/dist/listproperties/listpropertiesutils.d.ts +32 -32
  49. package/dist/listproperties/listreversedcommand.d.ts +31 -31
  50. package/dist/listproperties/liststartcommand.d.ts +34 -34
  51. package/dist/listproperties/liststylecommand.d.ts +67 -67
  52. package/dist/listproperties/ui/listpropertiesview.d.ts +147 -147
  53. package/dist/listproperties/utils/config.d.ts +32 -32
  54. package/dist/listproperties/utils/style.d.ts +31 -31
  55. package/dist/listproperties.d.ts +26 -26
  56. package/dist/todolist/checktodolistcommand.d.ts +44 -44
  57. package/dist/todolist/todocheckboxchangeobserver.d.ts +36 -36
  58. package/dist/todolist/todolistediting.d.ts +45 -45
  59. package/dist/todolist/todolistui.d.ts +19 -19
  60. package/dist/todolist.d.ts +26 -26
  61. package/package.json +10 -10
@@ -1,37 +1,37 @@
1
1
  /**
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
- */
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
- * @module list/listproperties/listpropertiesutils
7
- */
8
- import { Plugin } from '@ckeditor/ckeditor5-core';
6
+ * @module list/listproperties/listpropertiesutils
7
+ */
8
+ import { Plugin } from "@ckeditor/ckeditor5-core";
9
9
  /**
10
- * A set of helpers related to document lists.
11
- */
10
+ * A set of helpers related to document lists.
11
+ */
12
12
  export declare class ListPropertiesUtils extends Plugin {
13
- /**
14
- * @inheritDoc
15
- */
16
- static get pluginName(): "ListPropertiesUtils";
17
- /**
18
- * @inheritDoc
19
- */
20
- static get isOfficialPlugin(): true;
21
- /**
22
- * Gets all the style types supported by given list type.
23
- */
24
- getAllSupportedStyleTypes(): Array<string>;
25
- /**
26
- * Checks whether the given list-style-type is supported by numbered or bulleted list.
27
- */
28
- getListTypeFromListStyleType(listStyleType: string): 'bulleted' | 'numbered' | null;
29
- /**
30
- * Converts `type` attribute of `<ul>` or `<ol>` elements to `list-style-type` equivalent.
31
- */
32
- getListStyleTypeFromTypeAttribute(value: string): string | null;
33
- /**
34
- * Converts `list-style-type` style to `type` attribute of `<ul>` or `<ol>` elements.
35
- */
36
- getTypeAttributeFromListStyleType(value: string): string | null;
13
+ /**
14
+ * @inheritDoc
15
+ */
16
+ static get pluginName(): "ListPropertiesUtils";
17
+ /**
18
+ * @inheritDoc
19
+ */
20
+ static override get isOfficialPlugin(): true;
21
+ /**
22
+ * Gets all the style types supported by given list type.
23
+ */
24
+ getAllSupportedStyleTypes(): Array<string>;
25
+ /**
26
+ * Checks whether the given list-style-type is supported by numbered or bulleted list.
27
+ */
28
+ getListTypeFromListStyleType(listStyleType: string): "bulleted" | "numbered" | null;
29
+ /**
30
+ * Converts `type` attribute of `<ul>` or `<ol>` elements to `list-style-type` equivalent.
31
+ */
32
+ getListStyleTypeFromTypeAttribute(value: string): string | null;
33
+ /**
34
+ * Converts `list-style-type` style to `type` attribute of `<ul>` or `<ol>` elements.
35
+ */
36
+ getTypeAttributeFromListStyleType(value: string): string | null;
37
37
  }
@@ -1,36 +1,36 @@
1
1
  /**
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
- */
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
- * @module list/listproperties/listreversedcommand
7
- */
8
- import { Command } from '@ckeditor/ckeditor5-core';
6
+ * @module list/listproperties/listreversedcommand
7
+ */
8
+ import { Command } from "@ckeditor/ckeditor5-core";
9
9
  /**
10
- * The list reversed command. It changes the `listReversed` attribute of the selected list items,
11
- * letting the user to choose the order of an ordered list.
12
- * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
13
- */
10
+ * The list reversed command. It changes the `listReversed` attribute of the selected list items,
11
+ * letting the user to choose the order of an ordered list.
12
+ * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
13
+ */
14
14
  export declare class ListReversedCommand extends Command {
15
- /**
16
- * @inheritDoc
17
- */
18
- value: boolean | null;
19
- /**
20
- * @inheritDoc
21
- */
22
- refresh(): void;
23
- /**
24
- * Executes the command.
25
- *
26
- * @fires execute
27
- * @param options.reversed Whether the list should be reversed.
28
- */
29
- execute(options?: {
30
- reversed?: boolean;
31
- }): void;
32
- /**
33
- * Checks the command's {@link #value}.
34
- */
35
- private _getValue;
15
+ /**
16
+ * @inheritDoc
17
+ */
18
+ value: boolean | null;
19
+ /**
20
+ * @inheritDoc
21
+ */
22
+ override refresh(): void;
23
+ /**
24
+ * Executes the command.
25
+ *
26
+ * @fires execute
27
+ * @param options.reversed Whether the list should be reversed.
28
+ */
29
+ override execute(options?: {
30
+ reversed?: boolean;
31
+ }): void;
32
+ /**
33
+ * Checks the command's {@link #value}.
34
+ */
35
+ private _getValue;
36
36
  }
@@ -1,39 +1,39 @@
1
1
  /**
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
- */
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
- * @module list/listproperties/liststartcommand
7
- */
8
- import { Command } from '@ckeditor/ckeditor5-core';
6
+ * @module list/listproperties/liststartcommand
7
+ */
8
+ import { Command } from "@ckeditor/ckeditor5-core";
9
9
  /**
10
- * The list start index command. It changes the `listStart` attribute of the selected list items,
11
- * letting the user to choose the starting point of an ordered list.
12
- * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
13
- */
10
+ * The list start index command. It changes the `listStart` attribute of the selected list items,
11
+ * letting the user to choose the starting point of an ordered list.
12
+ * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
13
+ */
14
14
  export declare class ListStartCommand extends Command {
15
- /**
16
- * @inheritDoc
17
- */
18
- value: number | null;
19
- /**
20
- * @inheritDoc
21
- */
22
- refresh(): void;
23
- /**
24
- * Executes the command.
25
- *
26
- * @fires execute
27
- * @param options Execute options.
28
- * @param options.startIndex The list start index.
29
- */
30
- execute({ startIndex }?: {
31
- startIndex?: number;
32
- }): void;
33
- /**
34
- * Checks the command's {@link #value}.
35
- *
36
- * @returns The current value.
37
- */
38
- private _getValue;
15
+ /**
16
+ * @inheritDoc
17
+ */
18
+ value: number | null;
19
+ /**
20
+ * @inheritDoc
21
+ */
22
+ override refresh(): void;
23
+ /**
24
+ * Executes the command.
25
+ *
26
+ * @fires execute
27
+ * @param options Execute options.
28
+ * @param options.startIndex The list start index.
29
+ */
30
+ override execute({ startIndex }?: {
31
+ startIndex?: number;
32
+ }): void;
33
+ /**
34
+ * Checks the command's {@link #value}.
35
+ *
36
+ * @returns The current value.
37
+ */
38
+ private _getValue;
39
39
  }
@@ -1,72 +1,72 @@
1
1
  /**
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
- */
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
- * @module list/listproperties/liststylecommand
7
- */
8
- import { Command, type Editor } from '@ckeditor/ckeditor5-core';
6
+ * @module list/listproperties/liststylecommand
7
+ */
8
+ import { Command, type Editor } from "@ckeditor/ckeditor5-core";
9
9
  /**
10
- * The list style command. It changes `listStyle` attribute of the selected list items,
11
- * letting the user choose styles for the list item markers.
12
- * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
13
- */
10
+ * The list style command. It changes `listStyle` attribute of the selected list items,
11
+ * letting the user choose styles for the list item markers.
12
+ * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
13
+ */
14
14
  export declare class ListStyleCommand extends Command {
15
- /**
16
- * @inheritDoc
17
- */
18
- value: string | null;
19
- /**
20
- * The default type of the list style.
21
- */
22
- readonly defaultType: string;
23
- /**
24
- * The list of supported style types by this command.
25
- */
26
- private _supportedTypes;
27
- /**
28
- * Creates an instance of the command.
29
- *
30
- * @param editor The editor instance.
31
- * @param defaultType The list type that will be used by default if the value was not specified during
32
- * the command execution.
33
- * @param supportedTypes The list of supported style types by this command.
34
- */
35
- constructor(editor: Editor, defaultType: string, supportedTypes?: Array<string>);
36
- /**
37
- * @inheritDoc
38
- */
39
- refresh(): void;
40
- /**
41
- * Executes the command.
42
- *
43
- * @fires execute
44
- * @param options.type The type of the list style, e.g. `'disc'` or `'square'`. If `null` is specified, the default
45
- * style will be applied.
46
- */
47
- execute(options?: {
48
- type?: string | null;
49
- }): void;
50
- /**
51
- * Checks if the given style type is supported by this plugin.
52
- */
53
- isStyleTypeSupported(value: string): boolean;
54
- /**
55
- * Checks the command's {@link #value}.
56
- *
57
- * @returns The current value.
58
- */
59
- private _getValue;
60
- /**
61
- * Checks whether the command can be enabled in the current context.
62
- *
63
- * @returns Whether the command should be enabled.
64
- */
65
- private _checkEnabled;
66
- /**
67
- * Check if the provided list style is valid. Also change the selection to a list if it's not set yet.
68
- *
69
- * @param options.type The type of the list style. If `null` is specified, the function does nothing.
70
- */
71
- private _tryToConvertItemsToList;
15
+ /**
16
+ * @inheritDoc
17
+ */
18
+ value: string | null;
19
+ /**
20
+ * The default type of the list style.
21
+ */
22
+ readonly defaultType: string;
23
+ /**
24
+ * The list of supported style types by this command.
25
+ */
26
+ private _supportedTypes;
27
+ /**
28
+ * Creates an instance of the command.
29
+ *
30
+ * @param editor The editor instance.
31
+ * @param defaultType The list type that will be used by default if the value was not specified during
32
+ * the command execution.
33
+ * @param supportedTypes The list of supported style types by this command.
34
+ */
35
+ constructor(editor: Editor, defaultType: string, supportedTypes?: Array<string>);
36
+ /**
37
+ * @inheritDoc
38
+ */
39
+ override refresh(): void;
40
+ /**
41
+ * Executes the command.
42
+ *
43
+ * @fires execute
44
+ * @param options.type The type of the list style, e.g. `'disc'` or `'square'`. If `null` is specified, the default
45
+ * style will be applied.
46
+ */
47
+ override execute(options?: {
48
+ type?: string | null;
49
+ }): void;
50
+ /**
51
+ * Checks if the given style type is supported by this plugin.
52
+ */
53
+ isStyleTypeSupported(value: string): boolean;
54
+ /**
55
+ * Checks the command's {@link #value}.
56
+ *
57
+ * @returns The current value.
58
+ */
59
+ private _getValue;
60
+ /**
61
+ * Checks whether the command can be enabled in the current context.
62
+ *
63
+ * @returns Whether the command should be enabled.
64
+ */
65
+ private _checkEnabled;
66
+ /**
67
+ * Check if the provided list style is valid. Also change the selection to a list if it's not set yet.
68
+ *
69
+ * @param options.type The type of the list style. If `null` is specified, the function does nothing.
70
+ */
71
+ private _tryToConvertItemsToList;
72
72
  }