@ckeditor/ckeditor5-table 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.
Files changed (94) hide show
  1. package/dist/augmentation.d.ts +80 -80
  2. package/dist/commands/insertcolumncommand.d.ts +50 -50
  3. package/dist/commands/insertrowcommand.d.ts +49 -49
  4. package/dist/commands/inserttablecommand.d.ts +43 -43
  5. package/dist/commands/inserttablelayoutcommand.d.ts +34 -34
  6. package/dist/commands/mergecellcommand.d.ts +63 -63
  7. package/dist/commands/mergecellscommand.d.ts +24 -24
  8. package/dist/commands/removecolumncommand.d.ts +24 -24
  9. package/dist/commands/removerowcommand.d.ts +24 -24
  10. package/dist/commands/selectcolumncommand.d.ts +28 -28
  11. package/dist/commands/selectrowcommand.d.ts +28 -28
  12. package/dist/commands/setfooterrowcommand.d.ts +48 -48
  13. package/dist/commands/setheadercolumncommand.d.ts +45 -45
  14. package/dist/commands/setheaderrowcommand.d.ts +48 -48
  15. package/dist/commands/splitcellcommand.d.ts +38 -38
  16. package/dist/converters/downcast.d.ts +77 -77
  17. package/dist/converters/table-caption-post-fixer.d.ts +18 -18
  18. package/dist/converters/table-cell-paragraph-post-fixer.d.ts +30 -30
  19. package/dist/converters/table-cell-refresh-handler.d.ts +16 -16
  20. package/dist/converters/table-layout-post-fixer.d.ts +224 -224
  21. package/dist/converters/table-structure-post-fixer.d.ts +16 -16
  22. package/dist/converters/table-structure-refresh-handler.d.ts +15 -15
  23. package/dist/converters/tableproperties.d.ts +98 -98
  24. package/dist/converters/upcasttable.d.ts +47 -47
  25. package/dist/index.css.map +1 -1
  26. package/dist/index.d.ts +98 -98
  27. package/dist/index.js +12835 -14503
  28. package/dist/index.js.map +1 -1
  29. package/dist/plaintableoutput.d.ts +28 -28
  30. package/dist/table.d.ts +39 -39
  31. package/dist/tablecaption/tablecaptionediting.d.ts +62 -62
  32. package/dist/tablecaption/tablecaptionui.d.ts +18 -18
  33. package/dist/tablecaption/toggletablecaptioncommand.d.ts +61 -61
  34. package/dist/tablecaption/utils.d.ts +31 -31
  35. package/dist/tablecaption.d.ts +23 -23
  36. package/dist/tablecellproperties/commands/tablecellbackgroundcolorcommand.d.ts +27 -27
  37. package/dist/tablecellproperties/commands/tablecellbordercolorcommand.d.ts +32 -32
  38. package/dist/tablecellproperties/commands/tablecellborderstylecommand.d.ts +32 -32
  39. package/dist/tablecellproperties/commands/tablecellborderwidthcommand.d.ts +46 -46
  40. package/dist/tablecellproperties/commands/tablecellheightcommand.d.ts +41 -41
  41. package/dist/tablecellproperties/commands/tablecellhorizontalalignmentcommand.d.ts +27 -27
  42. package/dist/tablecellproperties/commands/tablecellpaddingcommand.d.ts +46 -46
  43. package/dist/tablecellproperties/commands/tablecellpropertycommand.d.ts +79 -79
  44. package/dist/tablecellproperties/commands/tablecelltypecommand.d.ts +42 -42
  45. package/dist/tablecellproperties/commands/tablecellverticalalignmentcommand.d.ts +35 -35
  46. package/dist/tablecellproperties/tablecellpropertiesediting.d.ts +49 -49
  47. package/dist/tablecellproperties/tablecellpropertiesui.d.ts +123 -123
  48. package/dist/tablecellproperties/tablecellpropertiesutils.d.ts +13 -13
  49. package/dist/tablecellproperties/ui/tablecellpropertiesview.d.ts +257 -257
  50. package/dist/tablecellproperties.d.ts +29 -29
  51. package/dist/tablecellwidth/commands/tablecellwidthcommand.d.ts +41 -41
  52. package/dist/tablecellwidth/tablecellwidthediting.d.ts +28 -28
  53. package/dist/tableclipboard.d.ts +79 -79
  54. package/dist/tablecolumnresize/constants.d.ts +23 -23
  55. package/dist/tablecolumnresize/converters.d.ts +20 -20
  56. package/dist/tablecolumnresize/tablecolumnresizeediting.d.ts +184 -184
  57. package/dist/tablecolumnresize/tablewidthscommand.d.ts +31 -31
  58. package/dist/tablecolumnresize/utils.d.ts +127 -127
  59. package/dist/tablecolumnresize.d.ts +25 -25
  60. package/dist/tableconfig.d.ts +670 -670
  61. package/dist/tableediting.d.ts +99 -99
  62. package/dist/tablekeyboard.d.ts +67 -67
  63. package/dist/tablelayout/commands/tabletypecommand.d.ts +38 -38
  64. package/dist/tablelayout/tablelayoutediting.d.ts +58 -58
  65. package/dist/tablelayout/tablelayoutui.d.ts +27 -27
  66. package/dist/tablelayout.d.ts +25 -25
  67. package/dist/tablemouse/mouseeventsobserver.d.ts +54 -54
  68. package/dist/tablemouse.d.ts +47 -47
  69. package/dist/tableproperties/commands/tablealignmentcommand.d.ts +27 -27
  70. package/dist/tableproperties/commands/tablebackgroundcolorcommand.d.ts +27 -27
  71. package/dist/tableproperties/commands/tablebordercolorcommand.d.ts +32 -32
  72. package/dist/tableproperties/commands/tableborderstylecommand.d.ts +32 -32
  73. package/dist/tableproperties/commands/tableborderwidthcommand.d.ts +46 -46
  74. package/dist/tableproperties/commands/tableheightcommand.d.ts +41 -41
  75. package/dist/tableproperties/commands/tablepropertycommand.d.ts +64 -64
  76. package/dist/tableproperties/commands/tablewidthcommand.d.ts +41 -41
  77. package/dist/tableproperties/tablepropertiesediting.d.ts +48 -48
  78. package/dist/tableproperties/tablepropertiesui.d.ts +131 -131
  79. package/dist/tableproperties/ui/tablepropertiesview.d.ts +207 -207
  80. package/dist/tableproperties.d.ts +29 -29
  81. package/dist/tableselection.d.ts +106 -106
  82. package/dist/tabletoolbar.d.ts +31 -31
  83. package/dist/tableui.d.ts +53 -53
  84. package/dist/tableutils.d.ts +532 -532
  85. package/dist/tablewalker.d.ts +342 -350
  86. package/dist/ui/colorinputview.d.ts +137 -137
  87. package/dist/ui/inserttableview.d.ts +78 -78
  88. package/dist/utils/common.d.ts +58 -58
  89. package/dist/utils/structure.d.ts +229 -229
  90. package/dist/utils/table-properties.d.ts +92 -92
  91. package/dist/utils/ui/contextualballoon.d.ts +28 -28
  92. package/dist/utils/ui/table-properties.d.ts +195 -192
  93. package/dist/utils/ui/widget.d.ts +22 -22
  94. package/package.json +9 -9
@@ -1,33 +1,33 @@
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 table/plaintableoutput
7
- */
8
- import { Plugin } from '@ckeditor/ckeditor5-core';
9
- import { Table } from './table.js';
6
+ * @module table/plaintableoutput
7
+ */
8
+ import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
9
+ import { Table } from "./table.js";
10
10
  /**
11
- * The plain table output feature.
12
- *
13
- * This feature strips the `<figure>` tag from the table data. This is because this tag is not supported
14
- * by most popular email clients and removing it ensures compatibility.
15
- */
11
+ * The plain table output feature.
12
+ *
13
+ * This feature strips the `<figure>` tag from the table data. This is because this tag is not supported
14
+ * by most popular email clients and removing it ensures compatibility.
15
+ */
16
16
  export declare class PlainTableOutput extends Plugin {
17
- /**
18
- * @inheritDoc
19
- */
20
- static get pluginName(): "PlainTableOutput";
21
- /**
22
- * @inheritDoc
23
- */
24
- static get isOfficialPlugin(): true;
25
- /**
26
- * @inheritDoc
27
- */
28
- static get requires(): readonly [typeof Table];
29
- /**
30
- * @inheritDoc
31
- */
32
- init(): void;
17
+ /**
18
+ * @inheritDoc
19
+ */
20
+ static get pluginName(): "PlainTableOutput";
21
+ /**
22
+ * @inheritDoc
23
+ */
24
+ static override get isOfficialPlugin(): true;
25
+ /**
26
+ * @inheritDoc
27
+ */
28
+ static get requires(): PluginDependenciesOf<[Table]>;
29
+ /**
30
+ * @inheritDoc
31
+ */
32
+ init(): void;
33
33
  }
package/dist/table.d.ts CHANGED
@@ -1,44 +1,44 @@
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 table/table
7
- */
8
- import { Plugin } from '@ckeditor/ckeditor5-core';
9
- import { Widget } from '@ckeditor/ckeditor5-widget';
10
- import { TableEditing } from './tableediting.js';
11
- import { TableUI } from './tableui.js';
12
- import { TableSelection } from './tableselection.js';
13
- import { TableClipboard } from './tableclipboard.js';
14
- import { TableKeyboard } from './tablekeyboard.js';
15
- import { TableMouse } from './tablemouse.js';
16
- import '../theme/table.css';
6
+ * @module table/table
7
+ */
8
+ import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
9
+ import { Widget } from "@ckeditor/ckeditor5-widget";
10
+ import { TableEditing } from "./tableediting.js";
11
+ import { TableUI } from "./tableui.js";
12
+ import { TableSelection } from "./tableselection.js";
13
+ import { TableClipboard } from "./tableclipboard.js";
14
+ import { TableKeyboard } from "./tablekeyboard.js";
15
+ import { TableMouse } from "./tablemouse.js";
16
+ import "../theme/table.css";
17
17
  /**
18
- * The table plugin.
19
- *
20
- * For a detailed overview, check the {@glink features/tables/tables Table feature documentation}.
21
- *
22
- * This is a "glue" plugin that loads the following table features:
23
- *
24
- * * {@link module:table/tableediting~TableEditing editing feature},
25
- * * {@link module:table/tableselection~TableSelection selection feature},
26
- * * {@link module:table/tablekeyboard~TableKeyboard keyboard navigation feature},
27
- * * {@link module:table/tablemouse~TableMouse mouse selection feature},
28
- * * {@link module:table/tableclipboard~TableClipboard clipboard feature},
29
- * * {@link module:table/tableui~TableUI UI feature}.
30
- */
18
+ * The table plugin.
19
+ *
20
+ * For a detailed overview, check the {@glink features/tables/tables Table feature documentation}.
21
+ *
22
+ * This is a "glue" plugin that loads the following table features:
23
+ *
24
+ * * {@link module:table/tableediting~TableEditing editing feature},
25
+ * * {@link module:table/tableselection~TableSelection selection feature},
26
+ * * {@link module:table/tablekeyboard~TableKeyboard keyboard navigation feature},
27
+ * * {@link module:table/tablemouse~TableMouse mouse selection feature},
28
+ * * {@link module:table/tableclipboard~TableClipboard clipboard feature},
29
+ * * {@link module:table/tableui~TableUI UI feature}.
30
+ */
31
31
  export declare class Table extends Plugin {
32
- /**
33
- * @inheritDoc
34
- */
35
- static get requires(): readonly [typeof TableEditing, typeof TableUI, typeof TableSelection, typeof TableMouse, typeof TableKeyboard, typeof TableClipboard, typeof Widget];
36
- /**
37
- * @inheritDoc
38
- */
39
- static get pluginName(): "Table";
40
- /**
41
- * @inheritDoc
42
- */
43
- static get isOfficialPlugin(): true;
32
+ /**
33
+ * @inheritDoc
34
+ */
35
+ static get requires(): PluginDependenciesOf<[TableEditing, TableUI, TableSelection, TableMouse, TableKeyboard, TableClipboard, Widget]>;
36
+ /**
37
+ * @inheritDoc
38
+ */
39
+ static get pluginName(): "Table";
40
+ /**
41
+ * @inheritDoc
42
+ */
43
+ static override get isOfficialPlugin(): true;
44
44
  }
@@ -1,67 +1,67 @@
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 table/tablecaption/tablecaptionediting
7
- */
8
- import { Plugin } from '@ckeditor/ckeditor5-core';
9
- import { ModelElement } from '@ckeditor/ckeditor5-engine';
6
+ * @module table/tablecaption/tablecaptionediting
7
+ */
8
+ import { Plugin } from "@ckeditor/ckeditor5-core";
9
+ import { ModelElement } from "@ckeditor/ckeditor5-engine";
10
10
  /**
11
- * The table caption editing plugin.
12
- */
11
+ * The table caption editing plugin.
12
+ */
13
13
  export declare class TableCaptionEditing extends Plugin {
14
- /**
15
- * A map that keeps saved JSONified table captions and table model elements they are
16
- * associated with.
17
- *
18
- * To learn more about this system, see {@link #_saveCaption}.
19
- */
20
- private _savedCaptionsMap;
21
- /**
22
- * A map that keeps generated ids for table captions to reuse them if the same caption is rendered again.
23
- */
24
- private _captionIdsMapping;
25
- /**
26
- * @inheritDoc
27
- */
28
- static get pluginName(): "TableCaptionEditing";
29
- /**
30
- * @inheritDoc
31
- */
32
- static get isOfficialPlugin(): true;
33
- /**
34
- * @inheritDoc
35
- */
36
- init(): void;
37
- /**
38
- * Returns the saved {@link module:engine/model/element~ModelElement#toJSON JSONified} caption
39
- * of a table model element.
40
- *
41
- * See {@link #_saveCaption}.
42
- *
43
- * @internal
44
- * @param tableModelElement The model element the caption should be returned for.
45
- * @returns The model caption element or `null` if there is none.
46
- */
47
- _getSavedCaption(tableModelElement: ModelElement): ModelElement | null;
48
- /**
49
- * Saves a {@link module:engine/model/element~ModelElement#toJSON JSONified} caption for
50
- * a table element to allow restoring it in the future.
51
- *
52
- * A caption is saved every time it gets hidden. The
53
- * user should be able to restore it on demand.
54
- *
55
- * **Note**: The caption cannot be stored in the table model element attribute because,
56
- * for instance, when the model state propagates to collaborators, the attribute would get
57
- * lost (mainly because it does not convert to anything when the caption is hidden) and
58
- * the states of collaborators' models would de-synchronize causing numerous issues.
59
- *
60
- * See {@link #_getSavedCaption}.
61
- *
62
- * @internal
63
- * @param tableModelElement The model element the caption is saved for.
64
- * @param caption The caption model element to be saved.
65
- */
66
- _saveCaption(tableModelElement: ModelElement, caption: ModelElement): void;
14
+ /**
15
+ * A map that keeps saved JSONified table captions and table model elements they are
16
+ * associated with.
17
+ *
18
+ * To learn more about this system, see {@link #_saveCaption}.
19
+ */
20
+ private _savedCaptionsMap;
21
+ /**
22
+ * A map that keeps generated ids for table captions to reuse them if the same caption is rendered again.
23
+ */
24
+ private _captionIdsMapping;
25
+ /**
26
+ * @inheritDoc
27
+ */
28
+ static get pluginName(): "TableCaptionEditing";
29
+ /**
30
+ * @inheritDoc
31
+ */
32
+ static override get isOfficialPlugin(): true;
33
+ /**
34
+ * @inheritDoc
35
+ */
36
+ init(): void;
37
+ /**
38
+ * Returns the saved {@link module:engine/model/element~ModelElement#toJSON JSONified} caption
39
+ * of a table model element.
40
+ *
41
+ * See {@link #_saveCaption}.
42
+ *
43
+ * @internal
44
+ * @param tableModelElement The model element the caption should be returned for.
45
+ * @returns The model caption element or `null` if there is none.
46
+ */
47
+ _getSavedCaption(tableModelElement: ModelElement): ModelElement | null;
48
+ /**
49
+ * Saves a {@link module:engine/model/element~ModelElement#toJSON JSONified} caption for
50
+ * a table element to allow restoring it in the future.
51
+ *
52
+ * A caption is saved every time it gets hidden. The
53
+ * user should be able to restore it on demand.
54
+ *
55
+ * **Note**: The caption cannot be stored in the table model element attribute because,
56
+ * for instance, when the model state propagates to collaborators, the attribute would get
57
+ * lost (mainly because it does not convert to anything when the caption is hidden) and
58
+ * the states of collaborators' models would de-synchronize causing numerous issues.
59
+ *
60
+ * See {@link #_getSavedCaption}.
61
+ *
62
+ * @internal
63
+ * @param tableModelElement The model element the caption is saved for.
64
+ * @param caption The caption model element to be saved.
65
+ */
66
+ _saveCaption(tableModelElement: ModelElement, caption: ModelElement): void;
67
67
  }
@@ -1,25 +1,25 @@
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
6
  * @module table/tablecaption/tablecaptionui
7
7
  */
8
- import { Plugin } from '@ckeditor/ckeditor5-core';
8
+ import { Plugin } from "@ckeditor/ckeditor5-core";
9
9
  /**
10
- * The table caption UI plugin. It introduces the `'toggleTableCaption'` UI button.
11
- */
10
+ * The table caption UI plugin. It introduces the `'toggleTableCaption'` UI button.
11
+ */
12
12
  export declare class TableCaptionUI extends Plugin {
13
- /**
14
- * @inheritDoc
15
- */
16
- static get pluginName(): "TableCaptionUI";
17
- /**
18
- * @inheritDoc
19
- */
20
- static get isOfficialPlugin(): true;
21
- /**
22
- * @inheritDoc
23
- */
24
- init(): void;
13
+ /**
14
+ * @inheritDoc
15
+ */
16
+ static get pluginName(): "TableCaptionUI";
17
+ /**
18
+ * @inheritDoc
19
+ */
20
+ static override get isOfficialPlugin(): true;
21
+ /**
22
+ * @inheritDoc
23
+ */
24
+ init(): void;
25
25
  }
@@ -1,68 +1,68 @@
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
6
  * @module table/tablecaption/toggletablecaptioncommand
7
7
  */
8
- import { Command } from '@ckeditor/ckeditor5-core';
8
+ import { Command } from "@ckeditor/ckeditor5-core";
9
9
  /**
10
- * The toggle table caption command.
11
- *
12
- * This command is registered by {@link module:table/tablecaption/tablecaptionediting~TableCaptionEditing} as the
13
- * `'toggleTableCaption'` editor command.
14
- *
15
- * Executing this command:
16
- *
17
- * * either adds or removes the table caption of a selected table (depending on whether the caption is present or not),
18
- * * removes the table caption if the selection is anchored in one.
19
- *
20
- * ```ts
21
- * // Toggle the presence of the caption.
22
- * editor.execute( 'toggleTableCaption' );
23
- * ```
24
- *
25
- * **Note**: You can move the selection to the caption right away as it shows up upon executing this command by using
26
- * the `focusCaptionOnShow` option:
27
- *
28
- * ```ts
29
- * editor.execute( 'toggleTableCaption', { focusCaptionOnShow: true } );
30
- * ```
31
- */
10
+ * The toggle table caption command.
11
+ *
12
+ * This command is registered by {@link module:table/tablecaption/tablecaptionediting~TableCaptionEditing} as the
13
+ * `'toggleTableCaption'` editor command.
14
+ *
15
+ * Executing this command:
16
+ *
17
+ * * either adds or removes the table caption of a selected table (depending on whether the caption is present or not),
18
+ * * removes the table caption if the selection is anchored in one.
19
+ *
20
+ * ```ts
21
+ * // Toggle the presence of the caption.
22
+ * editor.execute( 'toggleTableCaption' );
23
+ * ```
24
+ *
25
+ * **Note**: You can move the selection to the caption right away as it shows up upon executing this command by using
26
+ * the `focusCaptionOnShow` option:
27
+ *
28
+ * ```ts
29
+ * editor.execute( 'toggleTableCaption', { focusCaptionOnShow: true } );
30
+ * ```
31
+ */
32
32
  export declare class ToggleTableCaptionCommand extends Command {
33
- value: boolean;
34
- /**
35
- * @inheritDoc
36
- */
37
- refresh(): void;
38
- /**
39
- * Executes the command.
40
- *
41
- * ```ts
42
- * editor.execute( 'toggleTableCaption' );
43
- * ```
44
- *
45
- * @param options Options for the executed command.
46
- * @param options.focusCaptionOnShow When true and the caption shows up, the selection will be moved into it straight away.
47
- * @fires execute
48
- */
49
- execute({ focusCaptionOnShow }?: {
50
- focusCaptionOnShow?: boolean;
51
- }): void;
52
- /**
53
- * Shows the table caption. Also:
54
- *
55
- * * it attempts to restore the caption content from the `TableCaptionEditing` caption registry,
56
- * * it moves the selection to the caption right away, it the `focusCaptionOnShow` option was set.
57
- *
58
- * @param focusCaptionOnShow Default focus behavior when showing the caption.
59
- */
60
- private _showTableCaption;
61
- /**
62
- * Hides the caption of a selected table (or an table caption the selection is anchored to).
63
- *
64
- * The content of the caption is stored in the `TableCaptionEditing` caption registry to make this
65
- * a reversible action.
66
- */
67
- private _hideTableCaption;
33
+ value: boolean;
34
+ /**
35
+ * @inheritDoc
36
+ */
37
+ override refresh(): void;
38
+ /**
39
+ * Executes the command.
40
+ *
41
+ * ```ts
42
+ * editor.execute( 'toggleTableCaption' );
43
+ * ```
44
+ *
45
+ * @param options Options for the executed command.
46
+ * @param options.focusCaptionOnShow When true and the caption shows up, the selection will be moved into it straight away.
47
+ * @fires execute
48
+ */
49
+ override execute({ focusCaptionOnShow }?: {
50
+ focusCaptionOnShow?: boolean;
51
+ }): void;
52
+ /**
53
+ * Shows the table caption. Also:
54
+ *
55
+ * * it attempts to restore the caption content from the `TableCaptionEditing` caption registry,
56
+ * * it moves the selection to the caption right away, it the `focusCaptionOnShow` option was set.
57
+ *
58
+ * @param focusCaptionOnShow Default focus behavior when showing the caption.
59
+ */
60
+ private _showTableCaption;
61
+ /**
62
+ * Hides the caption of a selected table (or an table caption the selection is anchored to).
63
+ *
64
+ * The content of the caption is stored in the `TableCaptionEditing` caption registry to make this
65
+ * a reversible action.
66
+ */
67
+ private _hideTableCaption;
68
68
  }
@@ -1,42 +1,42 @@
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 table/tablecaption/utils
7
- */
8
- import type { ModelDocumentFragment, ModelDocumentSelection, ModelElement, ViewElement } from '@ckeditor/ckeditor5-engine';
6
+ * @module table/tablecaption/utils
7
+ */
8
+ import type { ModelDocumentFragment, ModelDocumentSelection, ModelElement, ViewElement } from "@ckeditor/ckeditor5-engine";
9
9
  /**
10
- * Checks if the provided model element is a `table`.
11
- *
12
- * @param modelElement Element to check if it is a table.
13
- * @internal
14
- */
10
+ * Checks if the provided model element is a `table`.
11
+ *
12
+ * @param modelElement Element to check if it is a table.
13
+ * @internal
14
+ */
15
15
  export declare function isTable(modelElement: ModelElement | ModelDocumentFragment | null): boolean;
16
16
  /**
17
- * Returns the caption model element from a given table element. Returns `null` if no caption is found.
18
- *
19
- * @param tableModelElement Table element in which we will try to find a caption element.
20
- * @internal
21
- */
17
+ * Returns the caption model element from a given table element. Returns `null` if no caption is found.
18
+ *
19
+ * @param tableModelElement Table element in which we will try to find a caption element.
20
+ * @internal
21
+ */
22
22
  export declare function getCaptionFromTableModelElement(tableModelElement: ModelElement): ModelElement | null;
23
23
  /**
24
- * Returns the caption model element for a model selection. Returns `null` if the selection has no caption element ancestor.
25
- *
26
- * @param selection The selection checked for caption presence.
27
- * @internal
28
- */
24
+ * Returns the caption model element for a model selection. Returns `null` if the selection has no caption element ancestor.
25
+ *
26
+ * @param selection The selection checked for caption presence.
27
+ * @internal
28
+ */
29
29
  export declare function getCaptionFromModelSelection(selection: ModelDocumentSelection): ModelElement | null;
30
30
  /**
31
- * {@link module:engine/view/matcher~Matcher} pattern. Checks if a given element is a caption.
32
- *
33
- * There are two possible forms of the valid caption:
34
- * - A `<figcaption>` element inside a `<figure class="table">` element.
35
- * - A `<caption>` inside a <table>.
36
- *
37
- * @returns Returns the object accepted by {@link module:engine/view/matcher~Matcher} or `null` if the element cannot be matched.
38
- * @internal
39
- */
31
+ * {@link module:engine/view/matcher~Matcher} pattern. Checks if a given element is a caption.
32
+ *
33
+ * There are two possible forms of the valid caption:
34
+ * - A `<figcaption>` element inside a `<figure class="table">` element.
35
+ * - A `<caption>` inside a <table>.
36
+ *
37
+ * @returns Returns the object accepted by {@link module:engine/view/matcher~Matcher} or `null` if the element cannot be matched.
38
+ * @internal
39
+ */
40
40
  export declare function matchTableCaptionViewElement(element: ViewElement): {
41
- name: true;
41
+ name: true;
42
42
  } | null;
@@ -1,28 +1,28 @@
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 table/tablecaption
7
- */
8
- import { Plugin } from '@ckeditor/ckeditor5-core';
9
- import { TableCaptionEditing } from './tablecaption/tablecaptionediting.js';
10
- import { TableCaptionUI } from './tablecaption/tablecaptionui.js';
11
- import '../theme/tablecaption.css';
6
+ * @module table/tablecaption
7
+ */
8
+ import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
9
+ import { TableCaptionEditing } from "./tablecaption/tablecaptionediting.js";
10
+ import { TableCaptionUI } from "./tablecaption/tablecaptionui.js";
11
+ import "../theme/tablecaption.css";
12
12
  /**
13
- * The table caption plugin.
14
- */
13
+ * The table caption plugin.
14
+ */
15
15
  export declare class TableCaption extends Plugin {
16
- /**
17
- * @inheritDoc
18
- */
19
- static get pluginName(): "TableCaption";
20
- /**
21
- * @inheritDoc
22
- */
23
- static get isOfficialPlugin(): true;
24
- /**
25
- * @inheritDoc
26
- */
27
- static get requires(): readonly [typeof TableCaptionEditing, typeof TableCaptionUI];
16
+ /**
17
+ * @inheritDoc
18
+ */
19
+ static get pluginName(): "TableCaption";
20
+ /**
21
+ * @inheritDoc
22
+ */
23
+ static override get isOfficialPlugin(): true;
24
+ /**
25
+ * @inheritDoc
26
+ */
27
+ static get requires(): PluginDependenciesOf<[TableCaptionEditing, TableCaptionUI]>;
28
28
  }
@@ -1,32 +1,32 @@
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 table/tablecellproperties/commands/tablecellbackgroundcolorcommand
7
- */
8
- import type { Editor } from '@ckeditor/ckeditor5-core';
9
- import { TableCellPropertyCommand } from './tablecellpropertycommand.js';
6
+ * @module table/tablecellproperties/commands/tablecellbackgroundcolorcommand
7
+ */
8
+ import type { Editor } from "@ckeditor/ckeditor5-core";
9
+ import { TableCellPropertyCommand } from "./tablecellpropertycommand.js";
10
10
  /**
11
- * The table cell background color command.
12
- *
13
- * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
14
- * the `'tableCellBackgroundColor'` editor command.
15
- *
16
- * To change the background color of selected cells, execute the command:
17
- *
18
- * ```ts
19
- * editor.execute( 'tableCellBackgroundColor', {
20
- * value: '#f00'
21
- * } );
22
- * ```
23
- */
11
+ * The table cell background color command.
12
+ *
13
+ * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
14
+ * the `'tableCellBackgroundColor'` editor command.
15
+ *
16
+ * To change the background color of selected cells, execute the command:
17
+ *
18
+ * ```ts
19
+ * editor.execute( 'tableCellBackgroundColor', {
20
+ * value: '#f00'
21
+ * } );
22
+ * ```
23
+ */
24
24
  export declare class TableCellBackgroundColorCommand extends TableCellPropertyCommand {
25
- /**
26
- * Creates a new `TableCellBackgroundColorCommand` instance.
27
- *
28
- * @param editor An editor in which this command will be used.
29
- * @param defaultValue The default value of the attribute.
30
- */
31
- constructor(editor: Editor, defaultValue: string);
25
+ /**
26
+ * Creates a new `TableCellBackgroundColorCommand` instance.
27
+ *
28
+ * @param editor An editor in which this command will be used.
29
+ * @param defaultValue The default value of the attribute.
30
+ */
31
+ constructor(editor: Editor, defaultValue: string);
32
32
  }