@ckeditor/ckeditor5-document-outline 41.2.1 → 41.3.0-alpha.2

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 (118) hide show
  1. package/build/document-outline.js +1 -1
  2. package/dist/content-index.css +363 -0
  3. package/dist/editor-index.css +420 -0
  4. package/dist/index.css +1154 -0
  5. package/dist/translations/ar.d.ts +8 -0
  6. package/dist/translations/ar.js +23 -0
  7. package/dist/translations/bg.d.ts +8 -0
  8. package/dist/translations/bg.js +23 -0
  9. package/dist/translations/bn.d.ts +8 -0
  10. package/dist/translations/bn.js +23 -0
  11. package/dist/translations/ca.d.ts +8 -0
  12. package/dist/translations/ca.js +23 -0
  13. package/dist/translations/cs.d.ts +8 -0
  14. package/dist/translations/cs.js +23 -0
  15. package/dist/translations/da.d.ts +8 -0
  16. package/dist/translations/da.js +23 -0
  17. package/dist/translations/de.d.ts +8 -0
  18. package/dist/translations/de.js +23 -0
  19. package/dist/translations/el.d.ts +8 -0
  20. package/dist/translations/el.js +23 -0
  21. package/dist/translations/en-au.d.ts +8 -0
  22. package/dist/translations/en-au.js +23 -0
  23. package/dist/translations/en.d.ts +8 -0
  24. package/dist/translations/en.js +23 -0
  25. package/dist/translations/es.d.ts +8 -0
  26. package/dist/translations/es.js +23 -0
  27. package/dist/translations/et.d.ts +8 -0
  28. package/dist/translations/et.js +23 -0
  29. package/dist/translations/fi.d.ts +8 -0
  30. package/dist/translations/fi.js +23 -0
  31. package/dist/translations/fr.d.ts +8 -0
  32. package/dist/translations/fr.js +23 -0
  33. package/dist/translations/gl.d.ts +8 -0
  34. package/dist/translations/gl.js +23 -0
  35. package/dist/translations/he.d.ts +8 -0
  36. package/dist/translations/he.js +23 -0
  37. package/dist/translations/hi.d.ts +8 -0
  38. package/dist/translations/hi.js +23 -0
  39. package/dist/translations/hr.d.ts +8 -0
  40. package/dist/translations/hr.js +23 -0
  41. package/dist/translations/hu.d.ts +8 -0
  42. package/dist/translations/hu.js +23 -0
  43. package/dist/translations/id.d.ts +8 -0
  44. package/dist/translations/id.js +23 -0
  45. package/dist/translations/it.d.ts +8 -0
  46. package/dist/translations/it.js +23 -0
  47. package/dist/translations/ja.d.ts +8 -0
  48. package/dist/translations/ja.js +23 -0
  49. package/dist/translations/ko.d.ts +8 -0
  50. package/dist/translations/ko.js +23 -0
  51. package/dist/translations/lt.d.ts +8 -0
  52. package/dist/translations/lt.js +23 -0
  53. package/dist/translations/lv.d.ts +8 -0
  54. package/dist/translations/lv.js +23 -0
  55. package/dist/translations/ms.d.ts +8 -0
  56. package/dist/translations/ms.js +23 -0
  57. package/dist/translations/nl.d.ts +8 -0
  58. package/dist/translations/nl.js +23 -0
  59. package/dist/translations/no.d.ts +8 -0
  60. package/dist/translations/no.js +23 -0
  61. package/dist/translations/pl.d.ts +8 -0
  62. package/dist/translations/pl.js +23 -0
  63. package/dist/translations/pt-br.d.ts +8 -0
  64. package/dist/translations/pt-br.js +23 -0
  65. package/dist/translations/pt.d.ts +8 -0
  66. package/dist/translations/pt.js +23 -0
  67. package/dist/translations/ro.d.ts +8 -0
  68. package/dist/translations/ro.js +23 -0
  69. package/dist/translations/ru.d.ts +8 -0
  70. package/dist/translations/ru.js +23 -0
  71. package/dist/translations/sk.d.ts +8 -0
  72. package/dist/translations/sk.js +23 -0
  73. package/dist/translations/sr-latn.d.ts +8 -0
  74. package/dist/translations/sr-latn.js +23 -0
  75. package/dist/translations/sr.d.ts +8 -0
  76. package/dist/translations/sr.js +23 -0
  77. package/dist/translations/sv.d.ts +8 -0
  78. package/dist/translations/sv.js +23 -0
  79. package/dist/translations/th.d.ts +8 -0
  80. package/dist/translations/th.js +23 -0
  81. package/dist/translations/tr.d.ts +8 -0
  82. package/dist/translations/tr.js +23 -0
  83. package/dist/translations/ug.d.ts +8 -0
  84. package/dist/translations/ug.js +23 -0
  85. package/dist/translations/uk.d.ts +8 -0
  86. package/dist/translations/uk.js +23 -0
  87. package/dist/translations/vi.d.ts +8 -0
  88. package/dist/translations/vi.js +23 -0
  89. package/dist/translations/zh-cn.d.ts +8 -0
  90. package/dist/translations/zh-cn.js +23 -0
  91. package/dist/translations/zh.d.ts +8 -0
  92. package/dist/translations/zh.js +23 -0
  93. package/dist/types/augmentation.d.ts +31 -0
  94. package/dist/types/documentoutline/documentoutlineui.d.ts +44 -0
  95. package/dist/types/documentoutline/documentoutlineutils.d.ts +70 -0
  96. package/dist/types/documentoutline/ui/documentoutlineitemview.d.ts +55 -0
  97. package/dist/types/documentoutline/ui/documentoutlineview.d.ts +56 -0
  98. package/dist/types/documentoutline/utils.d.ts +21 -0
  99. package/dist/types/documentoutline.d.ts +103 -0
  100. package/dist/types/index.d.ts +20 -0
  101. package/dist/types/tableofcontents/headingid.d.ts +22 -0
  102. package/dist/types/tableofcontents/tableofcontentscommand.d.ts +25 -0
  103. package/dist/types/tableofcontents/tableofcontentsediting.d.ts +41 -0
  104. package/dist/types/tableofcontents/tableofcontentsui.d.ts +31 -0
  105. package/dist/types/tableofcontents.d.ts +30 -0
  106. package/package.json +5 -4
  107. package/src/documentoutline/documentoutlineui.js +1 -1
  108. package/src/documentoutline/documentoutlineutils.js +1 -1
  109. package/src/documentoutline/ui/documentoutlineitemview.js +1 -1
  110. package/src/documentoutline/ui/documentoutlineview.js +1 -1
  111. package/src/documentoutline/utils.js +1 -1
  112. package/src/documentoutline.js +1 -1
  113. package/src/index.js +1 -1
  114. package/src/tableofcontents/headingid.js +1 -1
  115. package/src/tableofcontents/tableofcontentscommand.js +1 -1
  116. package/src/tableofcontents/tableofcontentsediting.js +1 -1
  117. package/src/tableofcontents/tableofcontentsui.js +1 -1
  118. package/src/tableofcontents.js +1 -1
@@ -0,0 +1,8 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2024, 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
+ import type { Translations } from 'ckeditor5';
7
+ declare const translations: Translations;
8
+ export default translations;
@@ -0,0 +1,23 @@
1
+ /*
2
+ * Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
+ *
4
+ *
5
+ *
6
+ *
7
+ * +---------------------------------------------------------------------------------+
8
+ * | |
9
+ * | Hello stranger! |
10
+ * | |
11
+ * | |
12
+ * | What you're currently looking at is the source code of a legally protected, |
13
+ * | proprietary software. Any attempts to deobfuscate / disassemble this code |
14
+ * | are forbidden and will result in legal consequences. |
15
+ * | |
16
+ * | |
17
+ * +---------------------------------------------------------------------------------+
18
+ *
19
+ *
20
+ *
21
+ *
22
+ */
23
+ export default{'sv':{'dictionary':{'Empty\x20heading':'Tom\x20rubrik','Editor\x20headings\x20will\x20appear\x20here\x20as\x20you\x20type.':'Redigerarens\x20rubriker\x20dyker\x20upp\x20här\x20medan\x20du\x20skriver.','No\x20headings\x20were\x20found\x20in\x20the\x20document.':'Inga\x20rubriker\x20hittades\x20i\x20dokumentet.','Table\x20of\x20contents':'Innehållsförteckning'},'getPluralForm':_0x1dbd05=>0x1!=_0x1dbd05}};
@@ -0,0 +1,8 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2024, 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
+ import type { Translations } from 'ckeditor5';
7
+ declare const translations: Translations;
8
+ export default translations;
@@ -0,0 +1,23 @@
1
+ /*
2
+ * Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
+ *
4
+ *
5
+ *
6
+ *
7
+ * +---------------------------------------------------------------------------------+
8
+ * | |
9
+ * | Hello stranger! |
10
+ * | |
11
+ * | |
12
+ * | What you're currently looking at is the source code of a legally protected, |
13
+ * | proprietary software. Any attempts to deobfuscate / disassemble this code |
14
+ * | are forbidden and will result in legal consequences. |
15
+ * | |
16
+ * | |
17
+ * +---------------------------------------------------------------------------------+
18
+ *
19
+ *
20
+ *
21
+ *
22
+ */
23
+ export default{'th':{'dictionary':{'Empty\x20heading':'หัวเรื่องว่างเปล่า','Editor\x20headings\x20will\x20appear\x20here\x20as\x20you\x20type.':'หัวเรื่องของโปรแกรมแก้ไขจะปรากฏที่นี่ขณะคุณพิมพ์','No\x20headings\x20were\x20found\x20in\x20the\x20document.':'ไม่พบหัวเรื่องในเอกสาร','Table\x20of\x20contents':'สารบัญ'},'getPluralForm':_0x13b6ad=>0x0}};
@@ -0,0 +1,8 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2024, 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
+ import type { Translations } from 'ckeditor5';
7
+ declare const translations: Translations;
8
+ export default translations;
@@ -0,0 +1,23 @@
1
+ /*
2
+ * Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
+ *
4
+ *
5
+ *
6
+ *
7
+ * +---------------------------------------------------------------------------------+
8
+ * | |
9
+ * | Hello stranger! |
10
+ * | |
11
+ * | |
12
+ * | What you're currently looking at is the source code of a legally protected, |
13
+ * | proprietary software. Any attempts to deobfuscate / disassemble this code |
14
+ * | are forbidden and will result in legal consequences. |
15
+ * | |
16
+ * | |
17
+ * +---------------------------------------------------------------------------------+
18
+ *
19
+ *
20
+ *
21
+ *
22
+ */
23
+ export default{'tr':{'dictionary':{'Empty\x20heading':'Boş\x20başlık','Editor\x20headings\x20will\x20appear\x20here\x20as\x20you\x20type.':'Siz\x20yazarken\x20editör\x20başlıkları\x20burada\x20görünecektir.','No\x20headings\x20were\x20found\x20in\x20the\x20document.':'Dokümanda\x20başlık\x20bulunamadı.','Table\x20of\x20contents':'İçindekiler'},'getPluralForm':_0xfee2d0=>_0xfee2d0>0x1}};
@@ -0,0 +1,8 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2024, 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
+ import type { Translations } from 'ckeditor5';
7
+ declare const translations: Translations;
8
+ export default translations;
@@ -0,0 +1,23 @@
1
+ /*
2
+ * Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
+ *
4
+ *
5
+ *
6
+ *
7
+ * +---------------------------------------------------------------------------------+
8
+ * | |
9
+ * | Hello stranger! |
10
+ * | |
11
+ * | |
12
+ * | What you're currently looking at is the source code of a legally protected, |
13
+ * | proprietary software. Any attempts to deobfuscate / disassemble this code |
14
+ * | are forbidden and will result in legal consequences. |
15
+ * | |
16
+ * | |
17
+ * +---------------------------------------------------------------------------------+
18
+ *
19
+ *
20
+ *
21
+ *
22
+ */
23
+ export default{'ug':{'dictionary':{'Empty\x20heading':'بوش\x20ماۋزۇ','Editor\x20headings\x20will\x20appear\x20here\x20as\x20you\x20type.':'خەت\x20كىرگۈزگەندە\x20تەھرىرنىڭ\x20ماۋزۇسى\x20كۆرۈنىدۇ.','No\x20headings\x20were\x20found\x20in\x20the\x20document.':'پۈتۈكتە\x20ماۋزۇ\x20بايقالمىدى.','Table\x20of\x20contents':'مەزمۇن\x20جەدۋىلى'},'getPluralForm':_0x24c04f=>0x1!=_0x24c04f}};
@@ -0,0 +1,8 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2024, 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
+ import type { Translations } from 'ckeditor5';
7
+ declare const translations: Translations;
8
+ export default translations;
@@ -0,0 +1,23 @@
1
+ /*
2
+ * Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
+ *
4
+ *
5
+ *
6
+ *
7
+ * +---------------------------------------------------------------------------------+
8
+ * | |
9
+ * | Hello stranger! |
10
+ * | |
11
+ * | |
12
+ * | What you're currently looking at is the source code of a legally protected, |
13
+ * | proprietary software. Any attempts to deobfuscate / disassemble this code |
14
+ * | are forbidden and will result in legal consequences. |
15
+ * | |
16
+ * | |
17
+ * +---------------------------------------------------------------------------------+
18
+ *
19
+ *
20
+ *
21
+ *
22
+ */
23
+ export default{'uk':{'dictionary':{'Empty\x20heading':'Порожній\x20заголовок','Editor\x20headings\x20will\x20appear\x20here\x20as\x20you\x20type.':'Редакторські\x20заголовки\x20з\x27являтимуться\x20тут,\x20коли\x20ви\x20друкуватимете.','No\x20headings\x20were\x20found\x20in\x20the\x20document.':'У\x20документі\x20не\x20знайдено\x20заголовків.','Table\x20of\x20contents':'Зміст'},'getPluralForm':_0x5c4409=>_0x5c4409%0x1==0x0&&_0x5c4409%0xa==0x1&&_0x5c4409%0x64!=0xb?0x0:_0x5c4409%0x1==0x0&&_0x5c4409%0xa>=0x2&&_0x5c4409%0xa<=0x4&&(_0x5c4409%0x64<0xc||_0x5c4409%0x64>0xe)?0x1:_0x5c4409%0x1==0x0&&(_0x5c4409%0xa==0x0||_0x5c4409%0xa>=0x5&&_0x5c4409%0xa<=0x9||_0x5c4409%0x64>=0xb&&_0x5c4409%0x64<=0xe)?0x2:0x3}};
@@ -0,0 +1,8 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2024, 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
+ import type { Translations } from 'ckeditor5';
7
+ declare const translations: Translations;
8
+ export default translations;
@@ -0,0 +1,23 @@
1
+ /*
2
+ * Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
+ *
4
+ *
5
+ *
6
+ *
7
+ * +---------------------------------------------------------------------------------+
8
+ * | |
9
+ * | Hello stranger! |
10
+ * | |
11
+ * | |
12
+ * | What you're currently looking at is the source code of a legally protected, |
13
+ * | proprietary software. Any attempts to deobfuscate / disassemble this code |
14
+ * | are forbidden and will result in legal consequences. |
15
+ * | |
16
+ * | |
17
+ * +---------------------------------------------------------------------------------+
18
+ *
19
+ *
20
+ *
21
+ *
22
+ */
23
+ export default{'vi':{'dictionary':{'Empty\x20heading':'Tiêu\x20đề\x20trống','Editor\x20headings\x20will\x20appear\x20here\x20as\x20you\x20type.':'Tiêu\x20đề\x20chỉnh\x20sửa\x20sẽ\x20hiện\x20ra\x20ở\x20đây\x20khi\x20bạn\x20nhập.','No\x20headings\x20were\x20found\x20in\x20the\x20document.':'Không\x20tìm\x20thấy\x20tiêu\x20đề\x20nào\x20trong\x20văn\x20bản.','Table\x20of\x20contents':'Mục\x20lục'},'getPluralForm':_0x126e1b=>0x0}};
@@ -0,0 +1,8 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2024, 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
+ import type { Translations } from 'ckeditor5';
7
+ declare const translations: Translations;
8
+ export default translations;
@@ -0,0 +1,23 @@
1
+ /*
2
+ * Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
+ *
4
+ *
5
+ *
6
+ *
7
+ * +---------------------------------------------------------------------------------+
8
+ * | |
9
+ * | Hello stranger! |
10
+ * | |
11
+ * | |
12
+ * | What you're currently looking at is the source code of a legally protected, |
13
+ * | proprietary software. Any attempts to deobfuscate / disassemble this code |
14
+ * | are forbidden and will result in legal consequences. |
15
+ * | |
16
+ * | |
17
+ * +---------------------------------------------------------------------------------+
18
+ *
19
+ *
20
+ *
21
+ *
22
+ */
23
+ export default{'zh-cn':{'dictionary':{'Empty\x20heading':'空标题','Editor\x20headings\x20will\x20appear\x20here\x20as\x20you\x20type.':'当你输入时,编辑的标题会出现在这里。','No\x20headings\x20were\x20found\x20in\x20the\x20document.':'文件中未发现标题。','Table\x20of\x20contents':'目录'},'getPluralForm':_0x1c2905=>0x0}};
@@ -0,0 +1,8 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2024, 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
+ import type { Translations } from 'ckeditor5';
7
+ declare const translations: Translations;
8
+ export default translations;
@@ -0,0 +1,23 @@
1
+ /*
2
+ * Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
3
+ *
4
+ *
5
+ *
6
+ *
7
+ * +---------------------------------------------------------------------------------+
8
+ * | |
9
+ * | Hello stranger! |
10
+ * | |
11
+ * | |
12
+ * | What you're currently looking at is the source code of a legally protected, |
13
+ * | proprietary software. Any attempts to deobfuscate / disassemble this code |
14
+ * | are forbidden and will result in legal consequences. |
15
+ * | |
16
+ * | |
17
+ * +---------------------------------------------------------------------------------+
18
+ *
19
+ *
20
+ *
21
+ *
22
+ */
23
+ export default{'zh':{'dictionary':{'Empty\x20heading':'空白標題','Editor\x20headings\x20will\x20appear\x20here\x20as\x20you\x20type.':'編輯器標題將在您輸入時出現在此處。','No\x20headings\x20were\x20found\x20in\x20the\x20document.':'無法在此文件中找到標題。','Table\x20of\x20contents':'內容目錄'},'getPluralForm':_0x345efa=>0x0}};
@@ -0,0 +1,31 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2024, 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
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
8
+ */
9
+ import type { DocumentOutline, DocumentOutlineUtils, DocumentOutlineConfig, DocumentOutlineUI, TableOfContents, TableOfContentsCommand, TableOfContentsEditing, TableOfContentsUI, HeadingId } from './index.js';
10
+ declare module '@ckeditor/ckeditor5-core' {
11
+ interface EditorConfig {
12
+ /**
13
+ * The configuration of the {@link module:document-outline/documentoutline~DocumentOutline} feature.
14
+ *
15
+ * Read more in {@link module:document-outline/documentoutline~DocumentOutlineConfig}.
16
+ */
17
+ documentOutline?: DocumentOutlineConfig;
18
+ }
19
+ interface PluginsMap {
20
+ [DocumentOutline.pluginName]: DocumentOutline;
21
+ [DocumentOutlineUI.pluginName]: DocumentOutlineUI;
22
+ [DocumentOutlineUtils.pluginName]: DocumentOutlineUtils;
23
+ [TableOfContents.pluginName]: TableOfContents;
24
+ [TableOfContentsEditing.pluginName]: TableOfContentsEditing;
25
+ [TableOfContentsUI.pluginName]: TableOfContentsUI;
26
+ [HeadingId.pluginName]: HeadingId;
27
+ }
28
+ interface CommandsMap {
29
+ insertTableOfContents: TableOfContentsCommand;
30
+ }
31
+ }
@@ -0,0 +1,44 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2024, 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
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
8
+ */
9
+ /**
10
+ * @module document-outline/documentoutline/documentoutlineui
11
+ * @publicApi
12
+ */
13
+ import { Plugin, type Editor } from 'ckeditor5/src/core.js';
14
+ import DocumentOutlineView from './ui/documentoutlineview.js';
15
+ import '../../theme/documentoutline.css';
16
+ /**
17
+ * Provides the UI for the document outline feature.
18
+ */
19
+ export default class DocumentOutlineUI extends Plugin {
20
+ /**
21
+ * The representation of the document outline view.
22
+ */
23
+ view: DocumentOutlineView;
24
+ /**
25
+ * @inheritDoc
26
+ */
27
+ static get pluginName(): "DocumentOutlineUI";
28
+ /**
29
+ * @inheritDoc
30
+ */
31
+ constructor(editor: Editor);
32
+ /**
33
+ * @inheritDoc
34
+ */
35
+ init(): void;
36
+ /**
37
+ * @inheritDoc
38
+ */
39
+ afterInit(): void;
40
+ /**
41
+ * @inheritDoc
42
+ */
43
+ destroy(): void;
44
+ }
@@ -0,0 +1,70 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2024, 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
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
8
+ */
9
+ /**
10
+ * @module document-outline/documentoutline/documentoutlineutils
11
+ */
12
+ import { Plugin } from 'ckeditor5/src/core.js';
13
+ import { type Element } from 'ckeditor5/src/engine.js';
14
+ import { diffToChanges } from 'ckeditor5/src/utils.js';
15
+ /**
16
+ * Document outline utilities.
17
+ */
18
+ export default class DocumentOutlineUtils extends Plugin {
19
+ /**
20
+ * @inheritDoc
21
+ */
22
+ static get pluginName(): "DocumentOutlineUtils";
23
+ /**
24
+ * Starts listening for editor events and handles them on the model document `change` event. This means both
25
+ * changes to the structure of the document and changes to the selection are reflected in the outline.
26
+ */
27
+ init(): void;
28
+ /**
29
+ * @inheritDoc
30
+ */
31
+ afterInit(): void;
32
+ }
33
+ /**
34
+ * The definition of the item in the document outline.
35
+ */
36
+ export type OutlineItemDefinition = {
37
+ level: number;
38
+ text: string;
39
+ modelElement: Element;
40
+ };
41
+ /**
42
+ * Fired whenever the headings structure in the document changes.
43
+ *
44
+ * @eventName ~DocumentOutlineUtils#change
45
+ * @param outlineDefinitions The list of current outline definitions.
46
+ * @param outlineChanges Describes what changes were applied in the headings structure.
47
+ * @param activeItemIndex The index of the active document outline item.
48
+ */
49
+ export type OutlineChangeEvent = {
50
+ name: 'change';
51
+ args: [
52
+ {
53
+ outlineDefinitions: Array<OutlineItemDefinition>;
54
+ outlineChanges: ReturnType<typeof diffToChanges<OutlineItemDefinition>>;
55
+ activeItemIndex: number;
56
+ }
57
+ ];
58
+ };
59
+ /**
60
+ * Fired whenever the active document outline item is changed.
61
+ *
62
+ * @eventName ~DocumentOutlineUtils#activeItemIndex
63
+ * @param activeItemIndex The index of the active document outline item.
64
+ */
65
+ export type ActiveOutlineItemChangeEvent = {
66
+ name: 'activeItemIndex';
67
+ args: [{
68
+ index: number;
69
+ }];
70
+ };
@@ -0,0 +1,55 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2024, 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
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
8
+ */
9
+ /**
10
+ * @module document-outline/documentoutline/ui/documentoutlineitemview
11
+ */
12
+ import { View } from 'ckeditor5/src/ui.js';
13
+ import { type Locale } from 'ckeditor5/src/utils.js';
14
+ /**
15
+ * An item of the document outline.
16
+ */
17
+ export default class DocumentOutlineItemView extends View {
18
+ /**
19
+ * The textual content of the item.
20
+ *
21
+ * @observable
22
+ */
23
+ text: string;
24
+ /**
25
+ * The level of heading nesting in the document.
26
+ *
27
+ * @observable
28
+ */
29
+ level: number;
30
+ /**
31
+ * Indicates whether the given item is currently active.
32
+ *
33
+ * @observable
34
+ */
35
+ isActive: boolean;
36
+ /**
37
+ * Indicates whether the heading doesn't have any text.
38
+ *
39
+ * @observable
40
+ */
41
+ isEmpty: boolean;
42
+ /**
43
+ * @inheritDoc
44
+ */
45
+ constructor(locale: Locale, showEmptyHeadingText?: boolean);
46
+ }
47
+ /**
48
+ * Fired whenever an item in the document outline is clicked.
49
+ *
50
+ * @eventName ~DocumentOutlineItemView#click
51
+ */
52
+ export type DocumentOutlineItemViewClickEvent = {
53
+ name: 'click';
54
+ args: [];
55
+ };
@@ -0,0 +1,56 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2024, 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
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
8
+ */
9
+ /**
10
+ * @module document-outline/documentoutline/ui/documentoutlineview
11
+ */
12
+ import { View, type ViewCollection } from 'ckeditor5/src/ui.js';
13
+ import { type Locale, type diffToChanges } from 'ckeditor5/src/utils.js';
14
+ import type { OutlineItemDefinition } from '../documentoutlineutils.js';
15
+ import DocumentOutlineItemView from './documentoutlineitemview.js';
16
+ /**
17
+ * The document outline panel.
18
+ */
19
+ export default class DocumentOutlineView extends View {
20
+ /**
21
+ * A collection of document outline items.
22
+ */
23
+ readonly items: ViewCollection<DocumentOutlineItemView>;
24
+ /**
25
+ * Indicates which item is active at the moment.
26
+ *
27
+ * @observable
28
+ */
29
+ activeItemIndex: number;
30
+ /**
31
+ * Creates an instance of the {@link module:documentoutline/ui/documentoutlineview~DocumentOutlineView} class.
32
+ *
33
+ * @param locale The localization services instance.
34
+ * @param showEmptyHeadingText Indicates whether the display of a placeholder for empty heading is enabled in the editor.
35
+ * @param containerElement The element that contains the document outline.
36
+ */
37
+ constructor(locale: Locale, showEmptyHeadingText?: boolean, containerElement?: HTMLElement);
38
+ /**
39
+ * If a heading was added or deleted in the editor, insert or delete it in the document outline.
40
+ */
41
+ sync(changesInItems: ReturnType<typeof diffToChanges<OutlineItemDefinition>>): void;
42
+ /**
43
+ * @inheritDoc
44
+ */
45
+ destroy(): void;
46
+ }
47
+ /**
48
+ * Fired whenever an item in the document outline is clicked.
49
+ *
50
+ * @eventName ~DocumentOutlineView#itemSelected
51
+ * @param itemIndex Index of selected item.
52
+ */
53
+ export type DocumentOutlineViewItemSelectedEvent = {
54
+ name: 'itemSelected';
55
+ args: [itemIndex: number];
56
+ };
@@ -0,0 +1,21 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2024, 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
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
7
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
8
+ */
9
+ /**
10
+ * @module document-outline/documentoutline/utils
11
+ */
12
+ import { type Element } from 'ckeditor5/src/engine.js';
13
+ import { type Editor } from 'ckeditor5/src/core.js';
14
+ /**
15
+ * Returns all text contents that are inside the given element and all its children.
16
+ */
17
+ export declare function getElementText(element: Element): string;
18
+ /**
19
+ * Returns a list of standard headings or GHS headings configured in the editor.
20
+ */
21
+ export declare function getDefaultFeatureHeadingNames(editor: Editor): Array<string>;