@sveltia/ui 0.90.0 → 0.92.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 (284) hide show
  1. package/dist/components/bottom-navigation/bottom-navigation.svelte +3 -9
  2. package/dist/components/bottom-navigation/bottom-navigation.svelte.d.ts +4 -39
  3. package/dist/components/button/button-group.svelte +2 -4
  4. package/dist/components/button/button-group.svelte.d.ts +3 -19
  5. package/dist/components/button/select-button-group.svelte +2 -13
  6. package/dist/components/button/select-button-group.svelte.d.ts +5 -67
  7. package/dist/components/calendar/calendar.d.ts +9 -0
  8. package/dist/components/calendar/calendar.js +43 -0
  9. package/dist/components/calendar/calendar.svelte +26 -27
  10. package/dist/components/checkbox/checkbox-group.svelte +2 -8
  11. package/dist/components/checkbox/checkbox-group.svelte.d.ts +4 -39
  12. package/dist/components/dialog/alert-dialog.svelte.d.ts +2 -3
  13. package/dist/components/dialog/confirmation-dialog.svelte.d.ts +2 -3
  14. package/dist/components/dialog/dialog.svelte +6 -7
  15. package/dist/components/dialog/dialog.svelte.d.ts +2 -3
  16. package/dist/components/dialog/prompt-dialog.svelte +2 -2
  17. package/dist/components/dialog/prompt-dialog.svelte.d.ts +2 -3
  18. package/dist/components/disclosure/disclosure.svelte +14 -16
  19. package/dist/components/disclosure/disclosure.svelte.d.ts +4 -38
  20. package/dist/components/drawer/drawer.svelte +22 -39
  21. package/dist/components/drawer/drawer.svelte.d.ts +3 -24
  22. package/dist/components/grid/grid-body.svelte +2 -3
  23. package/dist/components/grid/grid-body.svelte.d.ts +3 -18
  24. package/dist/components/grid/grid-cell.svelte +2 -8
  25. package/dist/components/grid/grid-cell.svelte.d.ts +3 -22
  26. package/dist/components/grid/grid-col-header.svelte +2 -4
  27. package/dist/components/grid/grid-col-header.svelte.d.ts +3 -19
  28. package/dist/components/grid/grid-foot.svelte +4 -9
  29. package/dist/components/grid/grid-foot.svelte.d.ts +3 -22
  30. package/dist/components/grid/grid-head.svelte +4 -9
  31. package/dist/components/grid/grid-head.svelte.d.ts +3 -22
  32. package/dist/components/grid/grid-row-header.svelte +2 -8
  33. package/dist/components/grid/grid-row-header.svelte.d.ts +3 -22
  34. package/dist/components/grid/grid-row.svelte +4 -5
  35. package/dist/components/grid/grid-row.svelte.d.ts +3 -19
  36. package/dist/components/grid/grid.d.ts +10 -0
  37. package/dist/components/grid/grid.js +11 -0
  38. package/dist/components/grid/grid.svelte +6 -7
  39. package/dist/components/grid/grid.svelte.d.ts +5 -21
  40. package/dist/components/listbox/listbox.svelte +34 -15
  41. package/dist/components/listbox/listbox.svelte.d.ts +5 -69
  42. package/dist/components/listbox/option-group.svelte +2 -8
  43. package/dist/components/listbox/option-group.svelte.d.ts +4 -39
  44. package/dist/components/listbox/option.svelte +2 -1
  45. package/dist/components/menu/menu-item-group.svelte +2 -6
  46. package/dist/components/menu/menu-item-group.svelte.d.ts +3 -22
  47. package/dist/components/menu/menu-item.svelte +5 -1
  48. package/dist/components/menu/menu.svelte +2 -8
  49. package/dist/components/menu/menu.svelte.d.ts +4 -39
  50. package/dist/components/radio/radio-group.svelte +2 -17
  51. package/dist/components/radio/radio-group.svelte.d.ts +5 -67
  52. package/dist/components/radio/radio.svelte +19 -22
  53. package/dist/components/radio/radio.svelte.d.ts +10 -40
  54. package/dist/components/resizable-pane/resizable-handle.svelte +42 -49
  55. package/dist/components/resizable-pane/resizable-pane-group.svelte +44 -58
  56. package/dist/components/resizable-pane/resizable-pane-group.svelte.d.ts +3 -19
  57. package/dist/components/resizable-pane/resizable-pane.svelte +2 -5
  58. package/dist/components/resizable-pane/resizable-pane.svelte.d.ts +3 -19
  59. package/dist/components/resizable-pane/sizing.d.ts +24 -0
  60. package/dist/components/resizable-pane/sizing.js +83 -0
  61. package/dist/components/select/combobox.svelte +35 -39
  62. package/dist/components/select/select-tags.svelte +3 -13
  63. package/dist/components/select/select-tags.svelte.d.ts +5 -67
  64. package/dist/components/slider/slider.d.ts +5 -4
  65. package/dist/components/slider/slider.js +28 -23
  66. package/dist/components/slider/slider.svelte +64 -62
  67. package/dist/components/slider/slider.svelte.d.ts +4 -37
  68. package/dist/components/switch/switch.svelte +2 -13
  69. package/dist/components/switch/switch.svelte.d.ts +5 -67
  70. package/dist/components/table/table-body.svelte +2 -4
  71. package/dist/components/table/table-body.svelte.d.ts +3 -19
  72. package/dist/components/table/table-cell.svelte +2 -8
  73. package/dist/components/table/table-cell.svelte.d.ts +3 -22
  74. package/dist/components/table/table-col-header.svelte +2 -8
  75. package/dist/components/table/table-col-header.svelte.d.ts +3 -22
  76. package/dist/components/table/table-foot.svelte +2 -8
  77. package/dist/components/table/table-foot.svelte.d.ts +3 -22
  78. package/dist/components/table/table-head.svelte +2 -8
  79. package/dist/components/table/table-head.svelte.d.ts +3 -22
  80. package/dist/components/table/table-part.svelte +2 -4
  81. package/dist/components/table/table-part.svelte.d.ts +3 -19
  82. package/dist/components/table/table-row-header.svelte +2 -8
  83. package/dist/components/table/table-row-header.svelte.d.ts +3 -22
  84. package/dist/components/table/table-row.svelte +2 -8
  85. package/dist/components/table/table-row.svelte.d.ts +3 -22
  86. package/dist/components/table/table.svelte +2 -4
  87. package/dist/components/table/table.svelte.d.ts +3 -19
  88. package/dist/components/tabs/tab-box.svelte +2 -4
  89. package/dist/components/tabs/tab-box.svelte.d.ts +3 -19
  90. package/dist/components/tabs/tab-list.svelte +2 -7
  91. package/dist/components/tabs/tab-list.svelte.d.ts +4 -37
  92. package/dist/components/tabs/tab-panel.svelte +2 -8
  93. package/dist/components/tabs/tab-panel.svelte.d.ts +3 -22
  94. package/dist/components/tabs/tab-panels.svelte +2 -8
  95. package/dist/components/tabs/tab-panels.svelte.d.ts +3 -22
  96. package/dist/components/text-editor/code-editor.js +14 -7
  97. package/dist/components/text-editor/code-editor.svelte +14 -22
  98. package/dist/components/text-editor/code-editor.svelte.d.ts +5 -103
  99. package/dist/components/text-editor/config.d.ts +73 -0
  100. package/dist/components/text-editor/config.js +110 -0
  101. package/dist/components/text-editor/constants.d.ts +40 -6
  102. package/dist/components/text-editor/constants.js +81 -7
  103. package/dist/components/text-editor/conversion/editor-components.js +4 -4
  104. package/dist/components/text-editor/conversion/html/components.d.ts +16 -0
  105. package/dist/components/text-editor/conversion/html/components.js +87 -0
  106. package/dist/components/text-editor/conversion/html/export.d.ts +10 -0
  107. package/dist/components/text-editor/conversion/html/export.js +360 -0
  108. package/dist/components/text-editor/conversion/html/import-rules.d.ts +12 -0
  109. package/dist/components/text-editor/conversion/html/import-rules.js +234 -0
  110. package/dist/components/text-editor/conversion/html/index.d.ts +10 -0
  111. package/dist/components/text-editor/conversion/html/index.js +33 -0
  112. package/dist/components/text-editor/conversion/html/paragraph.d.ts +1 -0
  113. package/dist/components/text-editor/conversion/html/paragraph.js +123 -0
  114. package/dist/components/text-editor/conversion/html/task-list.d.ts +13 -0
  115. package/dist/components/text-editor/conversion/html/task-list.js +82 -0
  116. package/dist/components/text-editor/conversion/html/unsupported.d.ts +2 -0
  117. package/dist/components/text-editor/conversion/html/unsupported.js +122 -0
  118. package/dist/components/text-editor/conversion/html/utils.d.ts +6 -0
  119. package/dist/components/text-editor/conversion/html/utils.js +34 -0
  120. package/dist/components/text-editor/conversion/import.js +33 -27
  121. package/dist/components/text-editor/conversion/markdown/block-conversion.d.ts +4 -0
  122. package/dist/components/text-editor/conversion/markdown/block-conversion.js +154 -0
  123. package/dist/components/text-editor/conversion/markdown/block-structure.d.ts +16 -0
  124. package/dist/components/text-editor/conversion/markdown/block-structure.js +254 -0
  125. package/dist/components/text-editor/conversion/markdown/code-blocks.d.ts +57 -0
  126. package/dist/components/text-editor/conversion/markdown/code-blocks.js +279 -0
  127. package/dist/components/text-editor/conversion/markdown/code-spans.d.ts +19 -0
  128. package/dist/components/text-editor/conversion/markdown/code-spans.js +71 -0
  129. package/dist/components/text-editor/conversion/markdown/formatting.d.ts +22 -0
  130. package/dist/components/text-editor/conversion/markdown/formatting.js +451 -0
  131. package/dist/components/text-editor/conversion/markdown/index.d.ts +10 -0
  132. package/dist/components/text-editor/conversion/markdown/index.js +55 -0
  133. package/dist/components/text-editor/conversion/markdown/placeholders.d.ts +2 -0
  134. package/dist/components/text-editor/conversion/markdown/placeholders.js +229 -0
  135. package/dist/components/text-editor/conversion/markdown/syntax.d.ts +99 -0
  136. package/dist/components/text-editor/conversion/markdown/syntax.js +206 -0
  137. package/dist/components/text-editor/conversion/placeholder-chars.d.ts +43 -0
  138. package/dist/components/text-editor/conversion/placeholder-chars.js +51 -0
  139. package/dist/components/text-editor/conversion/transformers/block-escape.d.ts +1 -0
  140. package/dist/components/text-editor/conversion/transformers/block-escape.js +53 -26
  141. package/dist/components/text-editor/conversion/transformers/code.d.ts +3 -14
  142. package/dist/components/text-editor/conversion/transformers/code.js +78 -16
  143. package/dist/components/text-editor/conversion/transformers/formatted-code.js +3 -18
  144. package/dist/components/text-editor/conversion/transformers/inline-code.js +3 -1
  145. package/dist/components/text-editor/conversion/transformers/link.js +3 -1
  146. package/dist/components/text-editor/conversion/transformers/raw-syntax.d.ts +0 -19
  147. package/dist/components/text-editor/conversion/transformers/raw-syntax.js +22 -93
  148. package/dist/components/text-editor/conversion/transformers/table.js +57 -16
  149. package/dist/components/text-editor/conversion/transformers/task-list.d.ts +24 -0
  150. package/dist/components/text-editor/conversion/transformers/task-list.js +53 -0
  151. package/dist/components/text-editor/conversion/update.d.ts +19 -2
  152. package/dist/components/text-editor/conversion/update.js +64 -40
  153. package/dist/components/text-editor/core.d.ts +12 -51
  154. package/dist/components/text-editor/core.js +47 -77
  155. package/dist/components/text-editor/editing/commands.js +9 -18
  156. package/dist/components/text-editor/editing/guards.d.ts +7 -0
  157. package/dist/components/text-editor/editing/guards.js +123 -0
  158. package/dist/components/text-editor/editing/raw-markdown.d.ts +7 -2
  159. package/dist/components/text-editor/editing/raw-markdown.js +68 -8
  160. package/dist/components/text-editor/editing/selection.js +6 -2
  161. package/dist/components/text-editor/lexical-root.svelte +89 -47
  162. package/dist/components/text-editor/lexical-root.svelte.d.ts +4 -67
  163. package/dist/components/text-editor/shiki/{facade.d.ts → engine.d.ts} +8 -8
  164. package/dist/components/text-editor/shiki/{facade.js → engine.js} +53 -156
  165. package/dist/components/text-editor/shiki/highlighter.js +5 -5
  166. package/dist/components/text-editor/shiki/lexical.d.ts +6 -0
  167. package/dist/components/text-editor/shiki/lexical.js +165 -0
  168. package/dist/components/text-editor/shiki/preload.js +1 -1
  169. package/dist/components/text-editor/shiki/source-highlight.svelte.d.ts +15 -0
  170. package/dist/components/text-editor/shiki/source-highlight.svelte.js +120 -0
  171. package/dist/components/text-editor/shiki/version.d.ts +1 -1
  172. package/dist/components/text-editor/shiki/version.js +1 -1
  173. package/dist/components/text-editor/store.svelte.js +65 -16
  174. package/dist/components/text-editor/text-editor.svelte +57 -146
  175. package/dist/components/text-editor/text-editor.svelte.d.ts +9 -105
  176. package/dist/components/text-editor/toolbar/actions.d.ts +25 -0
  177. package/dist/components/text-editor/toolbar/actions.js +107 -0
  178. package/dist/components/text-editor/toolbar/align-menu-button.svelte +16 -14
  179. package/dist/components/text-editor/toolbar/format-text-button.svelte +27 -19
  180. package/dist/components/text-editor/toolbar/insert-horizontal-rule-button.svelte +23 -23
  181. package/dist/components/text-editor/toolbar/insert-item-button.svelte +1 -1
  182. package/dist/components/text-editor/toolbar/insert-link-button.svelte +47 -51
  183. package/dist/components/text-editor/toolbar/insert-menu-button.svelte +1 -1
  184. package/dist/components/text-editor/toolbar/insert-table-button.svelte +35 -52
  185. package/dist/components/text-editor/toolbar/table-action-menu.svelte +19 -17
  186. package/dist/components/text-editor/toolbar/text-editor-toolbar.svelte +34 -11
  187. package/dist/components/text-editor/toolbar/text-editor-toolbar.svelte.d.ts +0 -8
  188. package/dist/components/text-editor/toolbar/toggle-block-menu-item.svelte +35 -41
  189. package/dist/components/text-editor/widgets/emoji-autocomplete.svelte +7 -6
  190. package/dist/components/text-editor/widgets/floating-link-editor.svelte +19 -32
  191. package/dist/components/text-editor/widgets/table-cell-menu-button.svelte +28 -32
  192. package/dist/components/text-field/date-time-input.svelte +7 -8
  193. package/dist/components/text-field/date-time-input.svelte.d.ts +3 -32
  194. package/dist/components/text-field/number-input.d.ts +0 -2
  195. package/dist/components/text-field/number-input.js +25 -25
  196. package/dist/components/text-field/number-input.svelte +18 -9
  197. package/dist/components/text-field/number-input.svelte.d.ts +1 -1
  198. package/dist/components/text-field/text-area.d.ts +2 -0
  199. package/dist/components/text-field/text-area.js +31 -0
  200. package/dist/components/text-field/text-area.svelte +12 -25
  201. package/dist/components/text-field/text-area.svelte.d.ts +5 -67
  202. package/dist/components/toast/toast.svelte +31 -8
  203. package/dist/components/toast/toast.svelte.d.ts +6 -6
  204. package/dist/components/toolbar/toolbar.svelte +2 -7
  205. package/dist/components/toolbar/toolbar.svelte.d.ts +4 -37
  206. package/dist/components/tree/tree-item.svelte +2 -6
  207. package/dist/components/tree/tree-item.svelte.d.ts +3 -22
  208. package/dist/components/tree/tree.svelte +3 -10
  209. package/dist/components/tree/tree.svelte.d.ts +4 -39
  210. package/dist/components/util/group.svelte +2 -7
  211. package/dist/components/util/group.svelte.d.ts +4 -37
  212. package/dist/components/util/modal.d.ts +9 -0
  213. package/dist/components/util/modal.js +30 -0
  214. package/dist/components/util/modal.svelte +16 -12
  215. package/dist/index.d.ts +1 -1
  216. package/dist/index.js +1 -1
  217. package/dist/locales/ar.yaml +2 -0
  218. package/dist/locales/bg.yaml +2 -0
  219. package/dist/locales/ca.yaml +2 -0
  220. package/dist/locales/cs.yaml +2 -0
  221. package/dist/locales/da.yaml +2 -0
  222. package/dist/locales/de.yaml +2 -0
  223. package/dist/locales/el.yaml +2 -0
  224. package/dist/locales/en-CA.yaml +2 -0
  225. package/dist/locales/en-GB.yaml +2 -0
  226. package/dist/locales/en-US.yaml +2 -0
  227. package/dist/locales/en-ZA.yaml +2 -0
  228. package/dist/locales/es-CO.yaml +2 -0
  229. package/dist/locales/es-ES.yaml +2 -0
  230. package/dist/locales/fa.yaml +2 -0
  231. package/dist/locales/fi.yaml +2 -0
  232. package/dist/locales/fr.yaml +2 -0
  233. package/dist/locales/he.yaml +2 -0
  234. package/dist/locales/hr.yaml +2 -0
  235. package/dist/locales/hu.yaml +176 -0
  236. package/dist/locales/it.yaml +2 -0
  237. package/dist/locales/ja.yaml +2 -0
  238. package/dist/locales/ko.yaml +2 -0
  239. package/dist/locales/nl.yaml +2 -0
  240. package/dist/locales/pl.yaml +2 -0
  241. package/dist/locales/pt-BR.yaml +2 -0
  242. package/dist/locales/pt-PT.yaml +2 -0
  243. package/dist/locales/ru.yaml +2 -0
  244. package/dist/locales/sk.yaml +2 -0
  245. package/dist/locales/sv.yaml +2 -0
  246. package/dist/locales/tr.yaml +2 -0
  247. package/dist/locales/uk.yaml +2 -0
  248. package/dist/locales/vi.yaml +2 -0
  249. package/dist/locales/zh-CN.yaml +2 -0
  250. package/dist/locales/zh-TW.yaml +2 -0
  251. package/dist/services/composite-widget.svelte.d.ts +76 -0
  252. package/dist/services/composite-widget.svelte.js +157 -0
  253. package/dist/services/focus.d.ts +2 -0
  254. package/dist/services/focus.js +68 -0
  255. package/dist/services/group.svelte.d.ts +17 -69
  256. package/dist/services/group.svelte.js +128 -391
  257. package/dist/services/label.d.ts +9 -0
  258. package/dist/services/label.js +22 -0
  259. package/dist/services/menu.d.ts +8 -0
  260. package/dist/services/menu.js +237 -0
  261. package/dist/services/navigation.d.ts +9 -0
  262. package/dist/services/navigation.js +13 -0
  263. package/dist/services/number.d.ts +2 -0
  264. package/dist/services/number.js +27 -0
  265. package/dist/services/pointer-drag.d.ts +14 -0
  266. package/dist/services/pointer-drag.js +89 -0
  267. package/dist/services/popup.svelte.js +123 -103
  268. package/dist/services/text.d.ts +3 -0
  269. package/dist/services/text.js +17 -0
  270. package/dist/services/tree.svelte.d.ts +29 -43
  271. package/dist/services/tree.svelte.js +58 -105
  272. package/dist/services/type-ahead.d.ts +10 -1
  273. package/dist/services/type-ahead.js +56 -34
  274. package/dist/typedefs.d.ts +108 -6
  275. package/dist/typedefs.js +63 -6
  276. package/package.json +5 -5
  277. package/dist/components/text-editor/conversion/html.d.ts +0 -30
  278. package/dist/components/text-editor/conversion/html.js +0 -857
  279. package/dist/components/text-editor/conversion/markdown.d.ts +0 -56
  280. package/dist/components/text-editor/conversion/markdown.js +0 -949
  281. package/dist/components/text-editor/toolbar/code-editor-toolbar.svelte +0 -28
  282. package/dist/components/text-editor/toolbar/code-editor-toolbar.svelte.d.ts +0 -37
  283. package/dist/components/text-editor/toolbar/insert-component.d.ts +0 -3
  284. package/dist/components/text-editor/toolbar/insert-component.js +0 -37
@@ -0,0 +1,16 @@
1
+ /**
2
+ * @import { DOMConversionMap, LexicalEditor } from 'lexical';
3
+ * @import { TextEditorComponent } from '../../../../typedefs.js';
4
+ */
5
+ /**
6
+ * Editor components of each editor, used to tell the elements they import, which come with their
7
+ * content, when HTML is imported.
8
+ * @type {WeakMap<LexicalEditor, TextEditorComponent[]>}
9
+ */
10
+ export const editorComponents: WeakMap<LexicalEditor, TextEditorComponent[]>;
11
+ export function getComponentConversionMap(node: any): DOMConversionMap;
12
+ export function getElementComponent(editor: LexicalEditor, element: Element): TextEditorComponent | undefined;
13
+ export function isInlineComponentElement(element: Element): boolean;
14
+ import type { LexicalEditor } from 'lexical';
15
+ import type { TextEditorComponent } from '../../../../typedefs.js';
16
+ import type { DOMConversionMap } from 'lexical';
@@ -0,0 +1,87 @@
1
+ /**
2
+ * Editor components in HTML: the elements they import, which come with their content.
3
+ */
4
+
5
+ import { $getEditor as getEditor } from 'lexical';
6
+
7
+ /**
8
+ * @import { DOMConversionMap, LexicalEditor } from 'lexical';
9
+ * @import { TextEditorComponent } from '../../../../typedefs.js';
10
+ */
11
+
12
+ /**
13
+ * Editor components of each editor, used to tell the elements they import, which come with their
14
+ * content, when HTML is imported.
15
+ * @type {WeakMap<LexicalEditor, TextEditorComponent[]>}
16
+ */
17
+ export const editorComponents = new WeakMap();
18
+
19
+ /**
20
+ * Conversion maps of the editor component nodes, cached as each `importDOM()` call can create a new
21
+ * map.
22
+ * @type {WeakMap<any, DOMConversionMap>}
23
+ */
24
+ const componentConversionMaps = new WeakMap();
25
+
26
+ /**
27
+ * Get the conversion map of the given editor component node.
28
+ * @param {any} node Lexical node class.
29
+ * @returns {DOMConversionMap} Conversion map.
30
+ */
31
+ export const getComponentConversionMap = (node) => {
32
+ let map = componentConversionMaps.get(node);
33
+
34
+ if (!map) {
35
+ map = node.importDOM?.() ?? {};
36
+ componentConversionMaps.set(node, /** @type {DOMConversionMap} */ (map));
37
+ }
38
+
39
+ return /** @type {DOMConversionMap} */ (map);
40
+ };
41
+
42
+ /**
43
+ * Editor component that imports each element, or `null` if none does, cached as the same element is
44
+ * checked many times during an import, and a conversion can run developer code. An element is only
45
+ * imported to one editor, as each import parses the HTML anew.
46
+ * @type {WeakMap<Element, TextEditorComponent | null>}
47
+ */
48
+ const elementComponents = new WeakMap();
49
+
50
+ /**
51
+ * Get the editor component that imports the given element, if any. The element’s content is then
52
+ * part of the component.
53
+ * @param {LexicalEditor} editor Editor instance.
54
+ * @param {Element} element Element.
55
+ * @returns {TextEditorComponent | undefined} Component.
56
+ */
57
+ export const getElementComponent = (editor, element) => {
58
+ let component = elementComponents.get(element);
59
+
60
+ if (component === undefined) {
61
+ component =
62
+ editorComponents
63
+ .get(editor)
64
+ ?.find(
65
+ ({ node }) =>
66
+ !!getComponentConversionMap(node)[element.localName]?.(
67
+ /** @type {HTMLElement} */ (element),
68
+ ),
69
+ ) ?? null;
70
+ elementComponents.set(element, component);
71
+ }
72
+
73
+ return component ?? undefined;
74
+ };
75
+
76
+ /**
77
+ * Check if the given element is imported by an inline editor component, like an image, which is
78
+ * content in the line just like text.
79
+ * @param {Element} element Element.
80
+ * @returns {boolean} Result.
81
+ */
82
+ export const isInlineComponentElement = (element) => {
83
+ const component = getElementComponent(getEditor(), element);
84
+
85
+ // The `node` is actually a node class
86
+ return !!component && !!(/** @type {any} */ (component.node).prototype.isInline?.());
87
+ };
@@ -0,0 +1,10 @@
1
+ /**
2
+ * Map of Lexical node classes and functions to export them to clean HTML. A class only takes effect
3
+ * if the node is registered with the editor. Other nodes, including the ones of editor components,
4
+ * are exported with their own `exportDOM` method.
5
+ * @type {DOMExportOutputMap}
6
+ */
7
+ export const HTML_EXPORT_MAP: DOMExportOutputMap;
8
+ export function exportHtml(editor: LexicalEditor): string;
9
+ import type { DOMExportOutputMap } from 'lexical';
10
+ import type { LexicalEditor } from 'lexical';
@@ -0,0 +1,360 @@
1
+ /**
2
+ * Export of the editor content to clean HTML, without the attributes and elements only meant for
3
+ * the editor.
4
+ */
5
+
6
+ import { CodeHighlightNode, CodeNode } from '@lexical/code-core';
7
+ import { HorizontalRuleNode } from '@lexical/extension';
8
+ import { $generateHtmlFromNodes as generateHtmlFromNodes } from '@lexical/html';
9
+ import { LinkNode } from '@lexical/link';
10
+ import { ListItemNode, ListNode } from '@lexical/list';
11
+ import { HeadingNode, QuoteNode } from '@lexical/rich-text';
12
+ import { TableCellNode, TableNode } from '@lexical/table';
13
+ import {
14
+ $isParagraphNode as isParagraphNode,
15
+ isHTMLElement,
16
+ ParagraphNode,
17
+ TabNode,
18
+ TextNode,
19
+ } from 'lexical';
20
+ import { isPlainLanguage } from '../../shiki/engine.js';
21
+ import { decorateTaskList, decorateTaskListItem } from './task-list.js';
22
+ import { splitParagraphAroundBlocks } from './paragraph.js';
23
+ import { TEXT_FORMAT_TAGS } from './utils.js';
24
+
25
+ /**
26
+ * @import {
27
+ * DOMExportOutput,
28
+ * DOMExportOutputMap,
29
+ * ElementNode,
30
+ * LexicalEditor,
31
+ * } from 'lexical';
32
+ */
33
+
34
+ /**
35
+ * Attributes to be kept on the exported elements, by tag name. Anything else Lexical adds, like
36
+ * `class`, `dir`, `style`, `value` or `spellcheck`, is only meant for the editor itself, except for
37
+ * the text alignment of a block; see {@link ALIGNABLE_TAGS}.
38
+ * @type {Record<string, string[]>}
39
+ */
40
+ const ALLOWED_ATTRIBUTES = {
41
+ a: ['href', 'rel', 'target', 'title'],
42
+ ol: ['start'],
43
+ td: ['colspan', 'rowspan'],
44
+ th: ['colspan', 'rowspan'],
45
+ };
46
+
47
+ /**
48
+ * Elements that keep their text alignment, which is the only style kept in the exported HTML.
49
+ * Lexical writes it as `style="text-align: …"` for the blocks it can be set on.
50
+ */
51
+ const ALIGNABLE_TAGS = ['p', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'blockquote', 'li'];
52
+
53
+ /**
54
+ * Remove the attributes not listed in {@link ALLOWED_ATTRIBUTES} from the given element, as well as
55
+ * any style but the text alignment of a block listed in {@link ALIGNABLE_TAGS}.
56
+ * @param {Element} element Element.
57
+ */
58
+ const removeExtraAttributes = (element) => {
59
+ const allowedAttributes = ALLOWED_ATTRIBUTES[element.localName] ?? [];
60
+
61
+ const textAlign = ALIGNABLE_TAGS.includes(element.localName)
62
+ ? /** @type {HTMLElement} */ (element).style.textAlign
63
+ : '';
64
+
65
+ [...element.attributes].forEach(({ name }) => {
66
+ if (!allowedAttributes.includes(name)) {
67
+ element.removeAttribute(name);
68
+ }
69
+ });
70
+
71
+ if (textAlign) {
72
+ /** @type {HTMLElement} */ (element).style.textAlign = textAlign;
73
+ }
74
+ };
75
+
76
+ /**
77
+ * Export an element node with Lexical’s own implementation, then remove the extra attributes from
78
+ * the element, as well as the attribute Lexical adds to the `<br>` terminating a trailing line
79
+ * break. The element’s own `after` function, if any, still runs first, so the structure is kept,
80
+ * like a nested list moved into the previous list item.
81
+ * @param {LexicalEditor} editor Editor instance.
82
+ * @param {ElementNode} node Element node.
83
+ * @returns {DOMExportOutput} Export output.
84
+ */
85
+ const exportElementNode = (editor, node) => {
86
+ const { after, ...output } = node.exportDOM(editor);
87
+
88
+ if (isHTMLElement(output.element)) {
89
+ removeExtraAttributes(output.element);
90
+ }
91
+
92
+ return {
93
+ ...output,
94
+ /**
95
+ * Clean up the element once its children are in place.
96
+ * @param {HTMLElement | DocumentFragment | Text | null | undefined} element Exported element.
97
+ * @returns {HTMLElement | DocumentFragment | Text | null | undefined} New element to replace
98
+ * the exported one, if any.
99
+ */
100
+ after: (element) => {
101
+ const newElement = after ? after.call(node, element) : undefined;
102
+ const target = newElement ?? element;
103
+
104
+ if (isHTMLElement(target)) {
105
+ removeExtraAttributes(target);
106
+ target.querySelectorAll(':scope > br').forEach(removeExtraAttributes);
107
+ }
108
+
109
+ // Returning the same element would make Lexical replace it with itself
110
+ return newElement === element ? undefined : newElement;
111
+ },
112
+ };
113
+ };
114
+
115
+ /**
116
+ * Export a paragraph node. Empty paragraphs at the end are left out, as they have no content; one
117
+ * may be added just by clicking below a block decorator. A paragraph that is the only child of a
118
+ * table cell is exported without the `<p>` element, unless it’s aligned. A paragraph holding
119
+ * elements it can’t hold, like a `<figure>`, is split around them.
120
+ * @param {LexicalEditor} editor Editor instance.
121
+ * @param {ParagraphNode} node Paragraph node.
122
+ * @returns {DOMExportOutput} Export output.
123
+ */
124
+ const exportParagraphNode = (editor, node) => {
125
+ const parent = node.getParent();
126
+
127
+ // Keep the `<p>` of an aligned paragraph, which holds the alignment
128
+ if (parent instanceof TableCellNode && parent.getChildrenSize() === 1 && !node.getFormatType()) {
129
+ return { element: document.createDocumentFragment() };
130
+ }
131
+
132
+ if (
133
+ node.isEmpty() &&
134
+ node.getNextSiblings().every((sibling) => isParagraphNode(sibling) && sibling.isEmpty())
135
+ ) {
136
+ return { element: null };
137
+ }
138
+
139
+ const { after, ...output } = exportElementNode(editor, node);
140
+
141
+ return {
142
+ ...output,
143
+ /**
144
+ * Clean up the paragraph once its children are in place, and split it around the elements it
145
+ * can’t hold, if any.
146
+ * @param {HTMLElement | DocumentFragment | Text | null | undefined} element Exported element.
147
+ * @returns {HTMLElement | DocumentFragment | Text | null | undefined} New element to replace
148
+ * the exported one, if any.
149
+ */
150
+ after: (element) => {
151
+ const newElement = /** @type {NonNullable<DOMExportOutput['after']>} */ (after).call(
152
+ node,
153
+ element,
154
+ );
155
+
156
+ const target = newElement ?? element;
157
+
158
+ return (isHTMLElement(target) && splitParagraphAroundBlocks(target)) || newElement;
159
+ },
160
+ };
161
+ };
162
+
163
+ /**
164
+ * Export a text node as plain text wrapped with the elements for its formats, instead of the
165
+ * `<span>`, `<b>` and `<i>` elements with styles and classes Lexical uses.
166
+ * @param {LexicalEditor} _editor Editor instance.
167
+ * @param {TextNode} node Text node.
168
+ * @returns {DOMExportOutput} Export output.
169
+ */
170
+ const exportTextNode = (_editor, node) => {
171
+ /** @type {HTMLElement | Text} */
172
+ let element = document.createTextNode(node.getTextContent());
173
+
174
+ TEXT_FORMAT_TAGS.forEach(([format, tagName]) => {
175
+ if (node.hasFormat(format)) {
176
+ const wrapper = document.createElement(tagName);
177
+
178
+ wrapper.append(element);
179
+ element = wrapper;
180
+ }
181
+ });
182
+
183
+ return { element };
184
+ };
185
+
186
+ /**
187
+ * Export a code block node as `<pre><code>` with the common `language-*` class, instead of the
188
+ * highlighted tokens Lexical renders in the editor. The children are still exported as usual, so
189
+ * copying part of a code block only exports the selected text, then their text is moved into the
190
+ * `<code>` element.
191
+ * @param {LexicalEditor} _editor Editor instance.
192
+ * @param {CodeNode} node Code node.
193
+ * @returns {DOMExportOutput} Export output.
194
+ */
195
+ const exportCodeNode = (_editor, node) => ({
196
+ element: document.createElement('pre'),
197
+ /**
198
+ * Replace the exported children with a `<code>` element holding their text.
199
+ * @param {HTMLElement | DocumentFragment | Text | null | undefined} pre Exported element.
200
+ * @returns {undefined} Nothing, as the element is updated in place.
201
+ */
202
+ after: (pre) => {
203
+ /* v8 ignore next 3 */
204
+ if (!isHTMLElement(pre)) {
205
+ return undefined;
206
+ }
207
+
208
+ const code = document.createElement('code');
209
+ const language = node.getLanguage();
210
+
211
+ if (language && !isPlainLanguage(language)) {
212
+ code.className = `language-${language}`;
213
+ }
214
+
215
+ code.textContent = [...pre.childNodes]
216
+ .map((child) => {
217
+ if (child.nodeName !== 'BR') {
218
+ return child.textContent;
219
+ }
220
+
221
+ // Skip the `<br>` Lexical adds to terminate a trailing line break
222
+ return isHTMLElement(child) && child.hasAttribute('data-lexical-managed-linebreak')
223
+ ? ''
224
+ : '\n';
225
+ })
226
+ .join('');
227
+
228
+ pre.replaceChildren(code);
229
+
230
+ return undefined;
231
+ },
232
+ });
233
+
234
+ /**
235
+ * Selector for the structural elements of a table, excluding the cell content.
236
+ */
237
+ const TABLE_STRUCTURE_SELECTOR = [
238
+ ':scope > :is(thead, tbody, tfoot)',
239
+ ':scope > :is(thead, tbody, tfoot) > tr',
240
+ ':scope > :is(thead, tbody, tfoot) > tr > :is(th, td)',
241
+ ':scope > tr',
242
+ ':scope > tr > :is(th, td)',
243
+ ].join(', ');
244
+
245
+ /**
246
+ * Export a table node, then remove the column definitions and extra attributes Lexical adds to the
247
+ * table and its descendants. The cleanup has to wait until the table is complete, as Lexical uses
248
+ * temporary attributes on the cells to compute the columns.
249
+ * @param {LexicalEditor} editor Editor instance.
250
+ * @param {TableNode} node Table node.
251
+ * @returns {DOMExportOutput} Export output.
252
+ */
253
+ const exportTableNode = (editor, node) => {
254
+ const { after, ...output } = node.exportDOM(editor);
255
+
256
+ return {
257
+ ...output,
258
+ /**
259
+ * Clean up the table once Lexical has completed it.
260
+ * @param {HTMLElement | DocumentFragment | Text | null | undefined} element Exported element.
261
+ * @returns {HTMLElement | DocumentFragment | Text | null | undefined} New element to replace
262
+ * the exported one, if any.
263
+ */
264
+ after: (element) => {
265
+ const newElement = after ? after.call(node, element) : undefined;
266
+ const target = newElement ?? element;
267
+
268
+ if (isHTMLElement(target)) {
269
+ target.querySelectorAll(':scope > colgroup').forEach((colgroup) => colgroup.remove());
270
+ // Leave the cell content alone, which has been cleaned up by its own nodes, while the
271
+ // content of an editor component may need its attributes
272
+ [target, ...target.querySelectorAll(TABLE_STRUCTURE_SELECTOR)].forEach(
273
+ removeExtraAttributes,
274
+ );
275
+ }
276
+
277
+ // Returning the same element would make Lexical replace it with itself
278
+ return newElement === element ? undefined : newElement;
279
+ },
280
+ };
281
+ };
282
+
283
+ /**
284
+ * Export an element node with {@link exportElementNode}, then update the cleaned-up element with
285
+ * the given function, like adding the classes and check boxes of a task list.
286
+ * @param {LexicalEditor} editor Editor instance.
287
+ * @param {ElementNode} node Element node.
288
+ * @param {(element: HTMLElement) => void} decorate Function to update the exported element.
289
+ * @returns {DOMExportOutput} Export output.
290
+ */
291
+ const exportDecoratedElementNode = (editor, node, decorate) => {
292
+ const output = exportElementNode(editor, node);
293
+
294
+ return {
295
+ ...output,
296
+ /**
297
+ * Update the element once it’s been cleaned up.
298
+ * @param {HTMLElement | DocumentFragment | Text | null | undefined} element Exported element.
299
+ * @returns {HTMLElement | DocumentFragment | Text | null | undefined} New element, if any.
300
+ */
301
+ after: (element) => {
302
+ const newElement = output.after?.(element);
303
+ const target = newElement ?? element;
304
+
305
+ if (isHTMLElement(target)) {
306
+ decorate(target);
307
+ }
308
+
309
+ return newElement;
310
+ },
311
+ };
312
+ };
313
+
314
+ /**
315
+ * Export a list node, adding the class of a task list to a check list.
316
+ * @param {LexicalEditor} editor Editor instance.
317
+ * @param {ListNode} node List node.
318
+ * @returns {DOMExportOutput} Export output.
319
+ */
320
+ const exportListNode = (editor, node) =>
321
+ exportDecoratedElementNode(editor, node, (element) => decorateTaskList(node, element));
322
+
323
+ /**
324
+ * Export a list item node, adding the class and a disabled check box to an item of a check list.
325
+ * @param {LexicalEditor} editor Editor instance.
326
+ * @param {ListItemNode} node List item node.
327
+ * @returns {DOMExportOutput} Export output.
328
+ */
329
+ const exportListItemNode = (editor, node) =>
330
+ exportDecoratedElementNode(editor, node, (element) => decorateTaskListItem(node, element));
331
+
332
+ /**
333
+ * Map of Lexical node classes and functions to export them to clean HTML. A class only takes effect
334
+ * if the node is registered with the editor. Other nodes, including the ones of editor components,
335
+ * are exported with their own `exportDOM` method.
336
+ * @type {DOMExportOutputMap}
337
+ */
338
+ export const HTML_EXPORT_MAP = new Map(
339
+ /** @type {[any, (editor: LexicalEditor, node: any) => DOMExportOutput][]} */ ([
340
+ [TextNode, exportTextNode],
341
+ [TabNode, exportTextNode],
342
+ [CodeHighlightNode, exportTextNode],
343
+ [ParagraphNode, exportParagraphNode],
344
+ [HeadingNode, exportElementNode],
345
+ [QuoteNode, exportElementNode],
346
+ [ListNode, exportListNode],
347
+ [ListItemNode, exportListItemNode],
348
+ [LinkNode, exportElementNode],
349
+ [HorizontalRuleNode, exportElementNode],
350
+ [CodeNode, exportCodeNode],
351
+ [TableNode, exportTableNode],
352
+ ]),
353
+ );
354
+
355
+ /**
356
+ * Convert the editor content to HTML. Call this within an editor update or read.
357
+ * @param {LexicalEditor} editor Editor instance.
358
+ * @returns {string} HTML value.
359
+ */
360
+ export const exportHtml = (editor) => generateHtmlFromNodes(editor);
@@ -0,0 +1,12 @@
1
+ export function getCodeLanguage(code: Element): string | undefined;
2
+ /**
3
+ * Additional DOM conversions to import HTML. They take priority over Lexical’s own conversions.
4
+ * @type {DOMConversionMap}
5
+ */
6
+ export const HTML_IMPORT_MAP: DOMConversionMap;
7
+ /**
8
+ * Additional DOM conversions to import HTML with code blocks.
9
+ * @type {DOMConversionMap}
10
+ */
11
+ export const HTML_CODE_IMPORT_MAP: DOMConversionMap;
12
+ import type { DOMConversionMap } from 'lexical';