@ckeditor/ckeditor5-list 38.1.0 → 38.1.1

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 (95) hide show
  1. package/build/list.js +1 -1
  2. package/build/list.js.map +1 -0
  3. package/package.json +3 -3
  4. package/src/augmentation.d.ts +50 -50
  5. package/src/augmentation.js +5 -5
  6. package/src/documentlist/adjacentlistssupport.d.ts +15 -15
  7. package/src/documentlist/adjacentlistssupport.js +81 -81
  8. package/src/documentlist/converters.d.ts +63 -63
  9. package/src/documentlist/converters.js +354 -354
  10. package/src/documentlist/documentlistcommand.d.ts +80 -80
  11. package/src/documentlist/documentlistcommand.js +145 -145
  12. package/src/documentlist/documentlistediting.d.ts +154 -154
  13. package/src/documentlist/documentlistediting.js +565 -565
  14. package/src/documentlist/documentlistindentcommand.d.ts +62 -62
  15. package/src/documentlist/documentlistindentcommand.js +129 -129
  16. package/src/documentlist/documentlistmergecommand.d.ts +76 -76
  17. package/src/documentlist/documentlistmergecommand.js +174 -174
  18. package/src/documentlist/documentlistsplitcommand.d.ts +67 -67
  19. package/src/documentlist/documentlistsplitcommand.js +70 -70
  20. package/src/documentlist/documentlistutils.d.ts +46 -46
  21. package/src/documentlist/documentlistutils.js +50 -50
  22. package/src/documentlist/utils/listwalker.d.ts +141 -141
  23. package/src/documentlist/utils/listwalker.js +162 -162
  24. package/src/documentlist/utils/model.d.ts +193 -193
  25. package/src/documentlist/utils/model.js +435 -435
  26. package/src/documentlist/utils/postfixers.d.ts +37 -37
  27. package/src/documentlist/utils/postfixers.js +118 -118
  28. package/src/documentlist/utils/view.d.ts +81 -81
  29. package/src/documentlist/utils/view.js +117 -117
  30. package/src/documentlist.d.ts +26 -26
  31. package/src/documentlist.js +30 -30
  32. package/src/documentlistproperties/converters.d.ts +19 -19
  33. package/src/documentlistproperties/converters.js +43 -43
  34. package/src/documentlistproperties/documentlistpropertiesediting.d.ts +88 -88
  35. package/src/documentlistproperties/documentlistpropertiesediting.js +289 -289
  36. package/src/documentlistproperties/documentlistpropertiesutils.d.ts +33 -33
  37. package/src/documentlistproperties/documentlistpropertiesutils.js +44 -44
  38. package/src/documentlistproperties/documentlistreversedcommand.d.ts +36 -36
  39. package/src/documentlistproperties/documentlistreversedcommand.js +55 -55
  40. package/src/documentlistproperties/documentliststartcommand.d.ts +38 -38
  41. package/src/documentlistproperties/documentliststartcommand.js +57 -57
  42. package/src/documentlistproperties/documentliststylecommand.d.ts +72 -72
  43. package/src/documentlistproperties/documentliststylecommand.js +113 -113
  44. package/src/documentlistproperties/utils/style.d.ts +20 -20
  45. package/src/documentlistproperties/utils/style.js +54 -54
  46. package/src/documentlistproperties.d.ts +27 -27
  47. package/src/documentlistproperties.js +31 -31
  48. package/src/index.d.ts +40 -40
  49. package/src/index.js +27 -27
  50. package/src/list/converters.d.ts +196 -196
  51. package/src/list/converters.js +905 -905
  52. package/src/list/indentcommand.d.ts +37 -37
  53. package/src/list/indentcommand.js +107 -107
  54. package/src/list/listcommand.d.ts +55 -55
  55. package/src/list/listcommand.js +274 -274
  56. package/src/list/listediting.d.ts +32 -32
  57. package/src/list/listediting.js +161 -161
  58. package/src/list/listui.d.ts +19 -19
  59. package/src/list/listui.js +32 -32
  60. package/src/list/listutils.d.ts +41 -41
  61. package/src/list/listutils.js +46 -46
  62. package/src/list/utils.d.ts +112 -112
  63. package/src/list/utils.js +374 -374
  64. package/src/list.d.ts +26 -26
  65. package/src/list.js +30 -30
  66. package/src/listconfig.d.ts +122 -122
  67. package/src/listconfig.js +5 -5
  68. package/src/listproperties/listpropertiesediting.d.ts +72 -72
  69. package/src/listproperties/listpropertiesediting.js +696 -696
  70. package/src/listproperties/listpropertiesui.d.ts +23 -23
  71. package/src/listproperties/listpropertiesui.js +277 -277
  72. package/src/listproperties/listreversedcommand.d.ts +38 -38
  73. package/src/listproperties/listreversedcommand.js +52 -52
  74. package/src/listproperties/liststartcommand.d.ts +37 -37
  75. package/src/listproperties/liststartcommand.js +51 -51
  76. package/src/listproperties/liststylecommand.d.ts +67 -67
  77. package/src/listproperties/liststylecommand.js +99 -99
  78. package/src/listproperties/ui/collapsibleview.d.ts +63 -63
  79. package/src/listproperties/ui/collapsibleview.js +89 -89
  80. package/src/listproperties/ui/listpropertiesview.d.ts +157 -157
  81. package/src/listproperties/ui/listpropertiesview.js +299 -299
  82. package/src/listproperties.d.ts +26 -26
  83. package/src/listproperties.js +30 -30
  84. package/src/liststyle.d.ts +28 -28
  85. package/src/liststyle.js +36 -36
  86. package/src/todolist/checktodolistcommand.d.ts +52 -52
  87. package/src/todolist/checktodolistcommand.js +76 -76
  88. package/src/todolist/todolistconverters.d.ts +82 -82
  89. package/src/todolist/todolistconverters.js +260 -260
  90. package/src/todolist/todolistediting.d.ts +39 -39
  91. package/src/todolist/todolistediting.js +161 -161
  92. package/src/todolist/todolistui.d.ts +19 -19
  93. package/src/todolist/todolistui.js +29 -29
  94. package/src/todolist.d.ts +27 -27
  95. package/src/todolist.js +31 -31
@@ -1,38 +1,38 @@
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 list/listproperties/listreversedcommand
7
- */
8
- import { Command } from 'ckeditor5/src/core';
9
- /**
10
- * The reversed list command. It changes the `listReversed` attribute of the selected list items. As a result, the list order will be
11
- * reversed.
12
- * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
13
- */
14
- export default 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
- * @returns The current value.
36
- */
37
- private _getValue;
38
- }
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 list/listproperties/listreversedcommand
7
+ */
8
+ import { Command } from 'ckeditor5/src/core';
9
+ /**
10
+ * The reversed list command. It changes the `listReversed` attribute of the selected list items. As a result, the list order will be
11
+ * reversed.
12
+ * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
13
+ */
14
+ export default 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
+ * @returns The current value.
36
+ */
37
+ private _getValue;
38
+ }
@@ -1,52 +1,52 @@
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 list/listproperties/listreversedcommand
7
- */
8
- import { Command } from 'ckeditor5/src/core';
9
- import { getSelectedListItems } from '../list/utils';
10
- /**
11
- * The reversed list command. It changes the `listReversed` attribute of the selected list items. As a result, the list order will be
12
- * reversed.
13
- * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
14
- */
15
- export default class ListReversedCommand extends Command {
16
- /**
17
- * @inheritDoc
18
- */
19
- refresh() {
20
- const value = this._getValue();
21
- this.value = value;
22
- this.isEnabled = value != null;
23
- }
24
- /**
25
- * Executes the command.
26
- *
27
- * @fires execute
28
- * @param options.reversed Whether the list should be reversed.
29
- */
30
- execute(options = {}) {
31
- const model = this.editor.model;
32
- const listItems = getSelectedListItems(model)
33
- .filter(item => item.getAttribute('listType') == 'numbered');
34
- model.change(writer => {
35
- for (const item of listItems) {
36
- writer.setAttribute('listReversed', !!options.reversed, item);
37
- }
38
- });
39
- }
40
- /**
41
- * Checks the command's {@link #value}.
42
- *
43
- * @returns The current value.
44
- */
45
- _getValue() {
46
- const listItem = this.editor.model.document.selection.getFirstPosition().parent;
47
- if (listItem && listItem.is('element', 'listItem') && listItem.getAttribute('listType') == 'numbered') {
48
- return listItem.getAttribute('listReversed');
49
- }
50
- return null;
51
- }
52
- }
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 list/listproperties/listreversedcommand
7
+ */
8
+ import { Command } from 'ckeditor5/src/core';
9
+ import { getSelectedListItems } from '../list/utils';
10
+ /**
11
+ * The reversed list command. It changes the `listReversed` attribute of the selected list items. As a result, the list order will be
12
+ * reversed.
13
+ * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
14
+ */
15
+ export default class ListReversedCommand extends Command {
16
+ /**
17
+ * @inheritDoc
18
+ */
19
+ refresh() {
20
+ const value = this._getValue();
21
+ this.value = value;
22
+ this.isEnabled = value != null;
23
+ }
24
+ /**
25
+ * Executes the command.
26
+ *
27
+ * @fires execute
28
+ * @param options.reversed Whether the list should be reversed.
29
+ */
30
+ execute(options = {}) {
31
+ const model = this.editor.model;
32
+ const listItems = getSelectedListItems(model)
33
+ .filter(item => item.getAttribute('listType') == 'numbered');
34
+ model.change(writer => {
35
+ for (const item of listItems) {
36
+ writer.setAttribute('listReversed', !!options.reversed, item);
37
+ }
38
+ });
39
+ }
40
+ /**
41
+ * Checks the command's {@link #value}.
42
+ *
43
+ * @returns The current value.
44
+ */
45
+ _getValue() {
46
+ const listItem = this.editor.model.document.selection.getFirstPosition().parent;
47
+ if (listItem && listItem.is('element', 'listItem') && listItem.getAttribute('listType') == 'numbered') {
48
+ return listItem.getAttribute('listReversed');
49
+ }
50
+ return null;
51
+ }
52
+ }
@@ -1,37 +1,37 @@
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 list/listproperties/liststartcommand
7
- */
8
- import { Command } from 'ckeditor5/src/core';
9
- /**
10
- * The list start index command. It changes the `listStart` attribute of the selected list items.
11
- * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
12
- */
13
- export default class ListStartCommand extends Command {
14
- /**
15
- * @inheritDoc
16
- */
17
- value: number | null;
18
- /**
19
- * @inheritDoc
20
- */
21
- refresh(): void;
22
- /**
23
- * Executes the command.
24
- *
25
- * @fires execute
26
- * @param options.startIndex The list start index.
27
- */
28
- execute({ startIndex }?: {
29
- startIndex?: number;
30
- }): void;
31
- /**
32
- * Checks the command's {@link #value}.
33
- *
34
- * @returns The current value.
35
- */
36
- private _getValue;
37
- }
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 list/listproperties/liststartcommand
7
+ */
8
+ import { Command } from 'ckeditor5/src/core';
9
+ /**
10
+ * The list start index command. It changes the `listStart` attribute of the selected list items.
11
+ * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
12
+ */
13
+ export default class ListStartCommand extends Command {
14
+ /**
15
+ * @inheritDoc
16
+ */
17
+ value: number | null;
18
+ /**
19
+ * @inheritDoc
20
+ */
21
+ refresh(): void;
22
+ /**
23
+ * Executes the command.
24
+ *
25
+ * @fires execute
26
+ * @param options.startIndex The list start index.
27
+ */
28
+ execute({ startIndex }?: {
29
+ startIndex?: number;
30
+ }): void;
31
+ /**
32
+ * Checks the command's {@link #value}.
33
+ *
34
+ * @returns The current value.
35
+ */
36
+ private _getValue;
37
+ }
@@ -1,51 +1,51 @@
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 list/listproperties/liststartcommand
7
- */
8
- import { Command } from 'ckeditor5/src/core';
9
- import { getSelectedListItems } from '../list/utils';
10
- /**
11
- * The list start index command. It changes the `listStart` attribute of the selected list items.
12
- * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
13
- */
14
- export default class ListStartCommand extends Command {
15
- /**
16
- * @inheritDoc
17
- */
18
- refresh() {
19
- const value = this._getValue();
20
- this.value = value;
21
- this.isEnabled = value != null;
22
- }
23
- /**
24
- * Executes the command.
25
- *
26
- * @fires execute
27
- * @param options.startIndex The list start index.
28
- */
29
- execute({ startIndex = 1 } = {}) {
30
- const model = this.editor.model;
31
- const listItems = getSelectedListItems(model)
32
- .filter(item => item.getAttribute('listType') == 'numbered');
33
- model.change(writer => {
34
- for (const item of listItems) {
35
- writer.setAttribute('listStart', startIndex >= 0 ? startIndex : 1, item);
36
- }
37
- });
38
- }
39
- /**
40
- * Checks the command's {@link #value}.
41
- *
42
- * @returns The current value.
43
- */
44
- _getValue() {
45
- const listItem = this.editor.model.document.selection.getFirstPosition().parent;
46
- if (listItem && listItem.is('element', 'listItem') && listItem.getAttribute('listType') == 'numbered') {
47
- return listItem.getAttribute('listStart');
48
- }
49
- return null;
50
- }
51
- }
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 list/listproperties/liststartcommand
7
+ */
8
+ import { Command } from 'ckeditor5/src/core';
9
+ import { getSelectedListItems } from '../list/utils';
10
+ /**
11
+ * The list start index command. It changes the `listStart` attribute of the selected list items.
12
+ * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
13
+ */
14
+ export default class ListStartCommand extends Command {
15
+ /**
16
+ * @inheritDoc
17
+ */
18
+ refresh() {
19
+ const value = this._getValue();
20
+ this.value = value;
21
+ this.isEnabled = value != null;
22
+ }
23
+ /**
24
+ * Executes the command.
25
+ *
26
+ * @fires execute
27
+ * @param options.startIndex The list start index.
28
+ */
29
+ execute({ startIndex = 1 } = {}) {
30
+ const model = this.editor.model;
31
+ const listItems = getSelectedListItems(model)
32
+ .filter(item => item.getAttribute('listType') == 'numbered');
33
+ model.change(writer => {
34
+ for (const item of listItems) {
35
+ writer.setAttribute('listStart', startIndex >= 0 ? startIndex : 1, item);
36
+ }
37
+ });
38
+ }
39
+ /**
40
+ * Checks the command's {@link #value}.
41
+ *
42
+ * @returns The current value.
43
+ */
44
+ _getValue() {
45
+ const listItem = this.editor.model.document.selection.getFirstPosition().parent;
46
+ if (listItem && listItem.is('element', 'listItem') && listItem.getAttribute('listType') == 'numbered') {
47
+ return listItem.getAttribute('listStart');
48
+ }
49
+ return null;
50
+ }
51
+ }
@@ -1,67 +1,67 @@
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 list/listproperties/liststylecommand
7
- */
8
- import { Command, type Editor } from 'ckeditor5/src/core';
9
- /**
10
- * The list style command. It changes the `listStyle` attribute of the selected list items.
11
- *
12
- * If the list type (numbered or bulleted) can be inferred from the passed style type,
13
- * the command tries to convert selected items to a list of that type.
14
- * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
15
- */
16
- export default class ListStyleCommand extends Command {
17
- isStyleTypeSupported: undefined;
18
- /**
19
- * @inheritDoc
20
- * @readonly
21
- */
22
- value: string | null;
23
- /**
24
- * The default type of the list style.
25
- */
26
- readonly defaultType: string;
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
- */
34
- constructor(editor: Editor, defaultType: string);
35
- /**
36
- * @inheritDoc
37
- */
38
- refresh(): void;
39
- /**
40
- * Executes the command.
41
- *
42
- * @fires execute
43
- * @param options.type The type of the list style, e.g. `'disc'` or `'square'`. If `null` is specified, the default
44
- * style will be applied.
45
- */
46
- execute(options?: {
47
- type?: string | null;
48
- }): void;
49
- /**
50
- * Checks the command's {@link #value}.
51
- *
52
- * @returns The current value.
53
- */
54
- private _getValue;
55
- /**
56
- * Checks whether the command can be enabled in the current context.
57
- *
58
- * @returns Whether the command should be enabled.
59
- */
60
- private _checkEnabled;
61
- /**
62
- * Checks if the provided list style is valid. Also changes the selection to a list if it's not set yet.
63
- *
64
- * @param The type of the list style. If `null` is specified, the function does nothing.
65
- */
66
- private _tryToConvertItemsToList;
67
- }
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 list/listproperties/liststylecommand
7
+ */
8
+ import { Command, type Editor } from 'ckeditor5/src/core';
9
+ /**
10
+ * The list style command. It changes the `listStyle` attribute of the selected list items.
11
+ *
12
+ * If the list type (numbered or bulleted) can be inferred from the passed style type,
13
+ * the command tries to convert selected items to a list of that type.
14
+ * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
15
+ */
16
+ export default class ListStyleCommand extends Command {
17
+ isStyleTypeSupported: undefined;
18
+ /**
19
+ * @inheritDoc
20
+ * @readonly
21
+ */
22
+ value: string | null;
23
+ /**
24
+ * The default type of the list style.
25
+ */
26
+ readonly defaultType: string;
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
+ */
34
+ constructor(editor: Editor, defaultType: string);
35
+ /**
36
+ * @inheritDoc
37
+ */
38
+ refresh(): void;
39
+ /**
40
+ * Executes the command.
41
+ *
42
+ * @fires execute
43
+ * @param options.type The type of the list style, e.g. `'disc'` or `'square'`. If `null` is specified, the default
44
+ * style will be applied.
45
+ */
46
+ execute(options?: {
47
+ type?: string | null;
48
+ }): void;
49
+ /**
50
+ * Checks the command's {@link #value}.
51
+ *
52
+ * @returns The current value.
53
+ */
54
+ private _getValue;
55
+ /**
56
+ * Checks whether the command can be enabled in the current context.
57
+ *
58
+ * @returns Whether the command should be enabled.
59
+ */
60
+ private _checkEnabled;
61
+ /**
62
+ * Checks if the provided list style is valid. Also changes the selection to a list if it's not set yet.
63
+ *
64
+ * @param The type of the list style. If `null` is specified, the function does nothing.
65
+ */
66
+ private _tryToConvertItemsToList;
67
+ }