@ckeditor/ckeditor5-html-support 44.1.0 → 44.2.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 (367) hide show
  1. package/LICENSE.md +1 -1
  2. package/build/html-support.js +1 -1
  3. package/dist/index-content.css +2 -2
  4. package/dist/index-editor.css +2 -2
  5. package/dist/index.css +3 -3
  6. package/dist/index.css.map +1 -1
  7. package/dist/index.js +4 -4
  8. package/dist/index.js.map +1 -1
  9. package/dist/translations/af.d.ts +2 -2
  10. package/dist/translations/af.js +2 -2
  11. package/dist/translations/af.umd.js +2 -2
  12. package/dist/translations/ar.d.ts +2 -2
  13. package/dist/translations/ar.js +2 -2
  14. package/dist/translations/ar.umd.js +2 -2
  15. package/dist/translations/ast.d.ts +2 -2
  16. package/dist/translations/ast.js +2 -2
  17. package/dist/translations/ast.umd.js +2 -2
  18. package/dist/translations/az.d.ts +2 -2
  19. package/dist/translations/az.js +2 -2
  20. package/dist/translations/az.umd.js +2 -2
  21. package/dist/translations/bg.d.ts +2 -2
  22. package/dist/translations/bg.js +2 -2
  23. package/dist/translations/bg.umd.js +2 -2
  24. package/dist/translations/bn.d.ts +2 -2
  25. package/dist/translations/bn.js +2 -2
  26. package/dist/translations/bn.umd.js +2 -2
  27. package/dist/translations/bs.d.ts +2 -2
  28. package/dist/translations/bs.js +2 -2
  29. package/dist/translations/bs.umd.js +2 -2
  30. package/dist/translations/ca.d.ts +2 -2
  31. package/dist/translations/ca.js +2 -2
  32. package/dist/translations/ca.umd.js +2 -2
  33. package/dist/translations/cs.d.ts +2 -2
  34. package/dist/translations/cs.js +2 -2
  35. package/dist/translations/cs.umd.js +2 -2
  36. package/dist/translations/da.d.ts +2 -2
  37. package/dist/translations/da.js +2 -2
  38. package/dist/translations/da.umd.js +2 -2
  39. package/dist/translations/de-ch.d.ts +2 -2
  40. package/dist/translations/de-ch.js +2 -2
  41. package/dist/translations/de-ch.umd.js +2 -2
  42. package/dist/translations/de.d.ts +2 -2
  43. package/dist/translations/de.js +2 -2
  44. package/dist/translations/de.umd.js +2 -2
  45. package/dist/translations/el.d.ts +2 -2
  46. package/dist/translations/el.js +2 -2
  47. package/dist/translations/el.umd.js +2 -2
  48. package/dist/translations/en-au.d.ts +2 -2
  49. package/dist/translations/en-au.js +2 -2
  50. package/dist/translations/en-au.umd.js +2 -2
  51. package/dist/translations/en-gb.d.ts +2 -2
  52. package/dist/translations/en-gb.js +2 -2
  53. package/dist/translations/en-gb.umd.js +2 -2
  54. package/dist/translations/en.d.ts +2 -2
  55. package/dist/translations/en.js +2 -2
  56. package/dist/translations/en.umd.js +2 -2
  57. package/dist/translations/eo.d.ts +2 -2
  58. package/dist/translations/eo.js +2 -2
  59. package/dist/translations/eo.umd.js +2 -2
  60. package/dist/translations/es-co.d.ts +2 -2
  61. package/dist/translations/es-co.js +2 -2
  62. package/dist/translations/es-co.umd.js +2 -2
  63. package/dist/translations/es.d.ts +2 -2
  64. package/dist/translations/es.js +2 -2
  65. package/dist/translations/es.umd.js +2 -2
  66. package/dist/translations/et.d.ts +2 -2
  67. package/dist/translations/et.js +2 -2
  68. package/dist/translations/et.umd.js +2 -2
  69. package/dist/translations/eu.d.ts +2 -2
  70. package/dist/translations/eu.js +2 -2
  71. package/dist/translations/eu.umd.js +2 -2
  72. package/dist/translations/fa.d.ts +2 -2
  73. package/dist/translations/fa.js +2 -2
  74. package/dist/translations/fa.umd.js +2 -2
  75. package/dist/translations/fi.d.ts +2 -2
  76. package/dist/translations/fi.js +2 -2
  77. package/dist/translations/fi.umd.js +2 -2
  78. package/dist/translations/fr.d.ts +2 -2
  79. package/dist/translations/fr.js +2 -2
  80. package/dist/translations/fr.umd.js +2 -2
  81. package/dist/translations/gl.d.ts +2 -2
  82. package/dist/translations/gl.js +2 -2
  83. package/dist/translations/gl.umd.js +2 -2
  84. package/dist/translations/gu.d.ts +2 -2
  85. package/dist/translations/gu.js +2 -2
  86. package/dist/translations/gu.umd.js +2 -2
  87. package/dist/translations/he.d.ts +2 -2
  88. package/dist/translations/he.js +2 -2
  89. package/dist/translations/he.umd.js +2 -2
  90. package/dist/translations/hi.d.ts +2 -2
  91. package/dist/translations/hi.js +2 -2
  92. package/dist/translations/hi.umd.js +2 -2
  93. package/dist/translations/hr.d.ts +2 -2
  94. package/dist/translations/hr.js +2 -2
  95. package/dist/translations/hr.umd.js +2 -2
  96. package/dist/translations/hu.d.ts +2 -2
  97. package/dist/translations/hu.js +2 -2
  98. package/dist/translations/hu.umd.js +2 -2
  99. package/dist/translations/hy.d.ts +2 -2
  100. package/dist/translations/hy.js +2 -2
  101. package/dist/translations/hy.umd.js +2 -2
  102. package/dist/translations/id.d.ts +2 -2
  103. package/dist/translations/id.js +2 -2
  104. package/dist/translations/id.umd.js +2 -2
  105. package/dist/translations/it.d.ts +2 -2
  106. package/dist/translations/it.js +2 -2
  107. package/dist/translations/it.umd.js +2 -2
  108. package/dist/translations/ja.d.ts +2 -2
  109. package/dist/translations/ja.js +2 -2
  110. package/dist/translations/ja.umd.js +2 -2
  111. package/dist/translations/jv.d.ts +2 -2
  112. package/dist/translations/jv.js +2 -2
  113. package/dist/translations/jv.umd.js +2 -2
  114. package/dist/translations/kk.d.ts +2 -2
  115. package/dist/translations/kk.js +2 -2
  116. package/dist/translations/kk.umd.js +2 -2
  117. package/dist/translations/km.d.ts +2 -2
  118. package/dist/translations/km.js +2 -2
  119. package/dist/translations/km.umd.js +2 -2
  120. package/dist/translations/kn.d.ts +2 -2
  121. package/dist/translations/kn.js +2 -2
  122. package/dist/translations/kn.umd.js +2 -2
  123. package/dist/translations/ko.d.ts +2 -2
  124. package/dist/translations/ko.js +2 -2
  125. package/dist/translations/ko.umd.js +2 -2
  126. package/dist/translations/ku.d.ts +2 -2
  127. package/dist/translations/ku.js +2 -2
  128. package/dist/translations/ku.umd.js +2 -2
  129. package/dist/translations/lt.d.ts +2 -2
  130. package/dist/translations/lt.js +2 -2
  131. package/dist/translations/lt.umd.js +2 -2
  132. package/dist/translations/lv.d.ts +2 -2
  133. package/dist/translations/lv.js +2 -2
  134. package/dist/translations/lv.umd.js +2 -2
  135. package/dist/translations/ms.d.ts +2 -2
  136. package/dist/translations/ms.js +2 -2
  137. package/dist/translations/ms.umd.js +2 -2
  138. package/dist/translations/nb.d.ts +2 -2
  139. package/dist/translations/nb.js +2 -2
  140. package/dist/translations/nb.umd.js +2 -2
  141. package/dist/translations/ne.d.ts +2 -2
  142. package/dist/translations/ne.js +2 -2
  143. package/dist/translations/ne.umd.js +2 -2
  144. package/dist/translations/nl.d.ts +2 -2
  145. package/dist/translations/nl.js +2 -2
  146. package/dist/translations/nl.umd.js +2 -2
  147. package/dist/translations/no.d.ts +2 -2
  148. package/dist/translations/no.js +2 -2
  149. package/dist/translations/no.umd.js +2 -2
  150. package/dist/translations/oc.d.ts +2 -2
  151. package/dist/translations/oc.js +2 -2
  152. package/dist/translations/oc.umd.js +2 -2
  153. package/dist/translations/pl.d.ts +2 -2
  154. package/dist/translations/pl.js +2 -2
  155. package/dist/translations/pl.umd.js +2 -2
  156. package/dist/translations/pt-br.d.ts +2 -2
  157. package/dist/translations/pt-br.js +2 -2
  158. package/dist/translations/pt-br.umd.js +2 -2
  159. package/dist/translations/pt.d.ts +2 -2
  160. package/dist/translations/pt.js +2 -2
  161. package/dist/translations/pt.umd.js +2 -2
  162. package/dist/translations/ro.d.ts +2 -2
  163. package/dist/translations/ro.js +2 -2
  164. package/dist/translations/ro.umd.js +2 -2
  165. package/dist/translations/ru.d.ts +2 -2
  166. package/dist/translations/ru.js +2 -2
  167. package/dist/translations/ru.umd.js +2 -2
  168. package/dist/translations/si.d.ts +2 -2
  169. package/dist/translations/si.js +2 -2
  170. package/dist/translations/si.umd.js +2 -2
  171. package/dist/translations/sk.d.ts +2 -2
  172. package/dist/translations/sk.js +2 -2
  173. package/dist/translations/sk.umd.js +2 -2
  174. package/dist/translations/sl.d.ts +2 -2
  175. package/dist/translations/sl.js +2 -2
  176. package/dist/translations/sl.umd.js +2 -2
  177. package/dist/translations/sq.d.ts +2 -2
  178. package/dist/translations/sq.js +2 -2
  179. package/dist/translations/sq.umd.js +2 -2
  180. package/dist/translations/sr-latn.d.ts +2 -2
  181. package/dist/translations/sr-latn.js +2 -2
  182. package/dist/translations/sr-latn.umd.js +2 -2
  183. package/dist/translations/sr.d.ts +2 -2
  184. package/dist/translations/sr.js +2 -2
  185. package/dist/translations/sr.umd.js +2 -2
  186. package/dist/translations/sv.d.ts +2 -2
  187. package/dist/translations/sv.js +2 -2
  188. package/dist/translations/sv.umd.js +2 -2
  189. package/dist/translations/th.d.ts +2 -2
  190. package/dist/translations/th.js +2 -2
  191. package/dist/translations/th.umd.js +2 -2
  192. package/dist/translations/ti.d.ts +2 -2
  193. package/dist/translations/ti.js +2 -2
  194. package/dist/translations/ti.umd.js +2 -2
  195. package/dist/translations/tk.d.ts +2 -2
  196. package/dist/translations/tk.js +2 -2
  197. package/dist/translations/tk.umd.js +2 -2
  198. package/dist/translations/tr.d.ts +2 -2
  199. package/dist/translations/tr.js +2 -2
  200. package/dist/translations/tr.umd.js +2 -2
  201. package/dist/translations/tt.d.ts +2 -2
  202. package/dist/translations/tt.js +2 -2
  203. package/dist/translations/tt.umd.js +2 -2
  204. package/dist/translations/ug.d.ts +2 -2
  205. package/dist/translations/ug.js +2 -2
  206. package/dist/translations/ug.umd.js +2 -2
  207. package/dist/translations/uk.d.ts +2 -2
  208. package/dist/translations/uk.js +2 -2
  209. package/dist/translations/uk.umd.js +2 -2
  210. package/dist/translations/ur.d.ts +2 -2
  211. package/dist/translations/ur.js +2 -2
  212. package/dist/translations/ur.umd.js +2 -2
  213. package/dist/translations/uz.d.ts +2 -2
  214. package/dist/translations/uz.js +2 -2
  215. package/dist/translations/uz.umd.js +2 -2
  216. package/dist/translations/vi.d.ts +2 -2
  217. package/dist/translations/vi.js +2 -2
  218. package/dist/translations/vi.umd.js +2 -2
  219. package/dist/translations/zh-cn.d.ts +2 -2
  220. package/dist/translations/zh-cn.js +2 -2
  221. package/dist/translations/zh-cn.umd.js +2 -2
  222. package/dist/translations/zh.d.ts +2 -2
  223. package/dist/translations/zh.js +2 -2
  224. package/dist/translations/zh.umd.js +2 -2
  225. package/lang/translations/af.po +1 -1
  226. package/lang/translations/ar.po +1 -1
  227. package/lang/translations/ast.po +1 -1
  228. package/lang/translations/az.po +1 -1
  229. package/lang/translations/bg.po +1 -1
  230. package/lang/translations/bn.po +1 -1
  231. package/lang/translations/bs.po +1 -1
  232. package/lang/translations/ca.po +1 -1
  233. package/lang/translations/cs.po +1 -1
  234. package/lang/translations/da.po +1 -1
  235. package/lang/translations/de-ch.po +1 -1
  236. package/lang/translations/de.po +1 -1
  237. package/lang/translations/el.po +1 -1
  238. package/lang/translations/en-au.po +1 -1
  239. package/lang/translations/en-gb.po +1 -1
  240. package/lang/translations/en.po +1 -1
  241. package/lang/translations/eo.po +1 -1
  242. package/lang/translations/es-co.po +1 -1
  243. package/lang/translations/es.po +1 -1
  244. package/lang/translations/et.po +1 -1
  245. package/lang/translations/eu.po +1 -1
  246. package/lang/translations/fa.po +1 -1
  247. package/lang/translations/fi.po +1 -1
  248. package/lang/translations/fr.po +1 -1
  249. package/lang/translations/gl.po +1 -1
  250. package/lang/translations/gu.po +1 -1
  251. package/lang/translations/he.po +1 -1
  252. package/lang/translations/hi.po +1 -1
  253. package/lang/translations/hr.po +1 -1
  254. package/lang/translations/hu.po +1 -1
  255. package/lang/translations/hy.po +1 -1
  256. package/lang/translations/id.po +1 -1
  257. package/lang/translations/it.po +1 -1
  258. package/lang/translations/ja.po +1 -1
  259. package/lang/translations/jv.po +1 -1
  260. package/lang/translations/kk.po +1 -1
  261. package/lang/translations/km.po +1 -1
  262. package/lang/translations/kn.po +1 -1
  263. package/lang/translations/ko.po +1 -1
  264. package/lang/translations/ku.po +1 -1
  265. package/lang/translations/lt.po +1 -1
  266. package/lang/translations/lv.po +1 -1
  267. package/lang/translations/ms.po +1 -1
  268. package/lang/translations/nb.po +1 -1
  269. package/lang/translations/ne.po +1 -1
  270. package/lang/translations/nl.po +1 -1
  271. package/lang/translations/no.po +1 -1
  272. package/lang/translations/oc.po +1 -1
  273. package/lang/translations/pl.po +1 -1
  274. package/lang/translations/pt-br.po +1 -1
  275. package/lang/translations/pt.po +1 -1
  276. package/lang/translations/ro.po +1 -1
  277. package/lang/translations/ru.po +1 -1
  278. package/lang/translations/si.po +1 -1
  279. package/lang/translations/sk.po +1 -1
  280. package/lang/translations/sl.po +1 -1
  281. package/lang/translations/sq.po +1 -1
  282. package/lang/translations/sr-latn.po +1 -1
  283. package/lang/translations/sr.po +1 -1
  284. package/lang/translations/sv.po +1 -1
  285. package/lang/translations/th.po +1 -1
  286. package/lang/translations/ti.po +1 -1
  287. package/lang/translations/tk.po +1 -1
  288. package/lang/translations/tr.po +1 -1
  289. package/lang/translations/tt.po +1 -1
  290. package/lang/translations/ug.po +1 -1
  291. package/lang/translations/uk.po +1 -1
  292. package/lang/translations/ur.po +1 -1
  293. package/lang/translations/uz.po +1 -1
  294. package/lang/translations/vi.po +1 -1
  295. package/lang/translations/zh-cn.po +1 -1
  296. package/lang/translations/zh.po +1 -1
  297. package/package.json +34 -8
  298. package/src/augmentation.d.ts +1 -1
  299. package/src/augmentation.js +1 -1
  300. package/src/converters.d.ts +1 -1
  301. package/src/converters.js +1 -1
  302. package/src/datafilter.d.ts +1 -1
  303. package/src/datafilter.js +1 -1
  304. package/src/dataschema.d.ts +1 -1
  305. package/src/dataschema.js +1 -1
  306. package/src/fullpage.d.ts +1 -1
  307. package/src/fullpage.js +1 -1
  308. package/src/generalhtmlsupport.d.ts +1 -1
  309. package/src/generalhtmlsupport.js +1 -1
  310. package/src/generalhtmlsupportconfig.d.ts +1 -1
  311. package/src/generalhtmlsupportconfig.js +1 -1
  312. package/src/htmlcomment.d.ts +1 -1
  313. package/src/htmlcomment.js +1 -1
  314. package/src/htmlpagedataprocessor.d.ts +1 -1
  315. package/src/htmlpagedataprocessor.js +1 -1
  316. package/src/index.d.ts +1 -1
  317. package/src/index.js +1 -1
  318. package/src/integrations/codeblock.d.ts +1 -1
  319. package/src/integrations/codeblock.js +1 -1
  320. package/src/integrations/customelement.d.ts +1 -1
  321. package/src/integrations/customelement.js +1 -1
  322. package/src/integrations/dualcontent.d.ts +1 -1
  323. package/src/integrations/dualcontent.js +1 -1
  324. package/src/integrations/heading.d.ts +1 -1
  325. package/src/integrations/heading.js +1 -1
  326. package/src/integrations/image.d.ts +1 -1
  327. package/src/integrations/image.js +1 -1
  328. package/src/integrations/integrationutils.d.ts +1 -1
  329. package/src/integrations/integrationutils.js +1 -1
  330. package/src/integrations/list.d.ts +1 -1
  331. package/src/integrations/list.js +1 -1
  332. package/src/integrations/mediaembed.d.ts +1 -1
  333. package/src/integrations/mediaembed.js +1 -1
  334. package/src/integrations/script.d.ts +1 -1
  335. package/src/integrations/script.js +1 -1
  336. package/src/integrations/style.d.ts +1 -1
  337. package/src/integrations/style.js +1 -1
  338. package/src/integrations/table.d.ts +1 -1
  339. package/src/integrations/table.js +1 -1
  340. package/src/schemadefinitions.d.ts +1 -1
  341. package/src/schemadefinitions.js +1 -1
  342. package/src/utils.d.ts +1 -1
  343. package/src/utils.js +1 -1
  344. package/theme/datafilter.css +1 -1
  345. package/dist/augmentation.d.ts +0 -37
  346. package/dist/converters.d.ts +0 -64
  347. package/dist/datafilter.d.ts +0 -312
  348. package/dist/dataschema.d.ts +0 -191
  349. package/dist/fullpage.d.ts +0 -29
  350. package/dist/generalhtmlsupport.d.ts +0 -106
  351. package/dist/generalhtmlsupportconfig.d.ts +0 -81
  352. package/dist/htmlcomment.d.ts +0 -79
  353. package/dist/htmlpagedataprocessor.d.ts +0 -26
  354. package/dist/index.d.ts +0 -29
  355. package/dist/integrations/codeblock.d.ts +0 -31
  356. package/dist/integrations/customelement.d.ts +0 -35
  357. package/dist/integrations/dualcontent.d.ts +0 -53
  358. package/dist/integrations/heading.d.ts +0 -39
  359. package/dist/integrations/image.d.ts +0 -34
  360. package/dist/integrations/integrationutils.d.ts +0 -19
  361. package/dist/integrations/list.d.ts +0 -35
  362. package/dist/integrations/mediaembed.d.ts +0 -34
  363. package/dist/integrations/script.d.ts +0 -34
  364. package/dist/integrations/style.d.ts +0 -34
  365. package/dist/integrations/table.d.ts +0 -31
  366. package/dist/schemadefinitions.d.ts +0 -17
  367. package/dist/utils.d.ts +0 -76
@@ -1,191 +0,0 @@
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-licensing-options
8
- */
9
- /**
10
- * @module html-support/dataschema
11
- */
12
- import { Plugin } from 'ckeditor5/src/core.js';
13
- import type { AttributeProperties, SchemaItemDefinition } from 'ckeditor5/src/engine.js';
14
- /**
15
- * Holds representation of the extended HTML document type definitions to be used by the
16
- * editor in HTML support.
17
- *
18
- * Data schema is represented by data schema definitions.
19
- *
20
- * To add new definition for block element,
21
- * use {@link module:html-support/dataschema~DataSchema#registerBlockElement} method:
22
- *
23
- * ```ts
24
- * dataSchema.registerBlockElement( {
25
- * view: 'section',
26
- * model: 'my-section',
27
- * modelSchema: {
28
- * inheritAllFrom: '$block'
29
- * }
30
- * } );
31
- * ```
32
- *
33
- * To add new definition for inline element,
34
- * use {@link module:html-support/dataschema~DataSchema#registerInlineElement} method:
35
- *
36
- * ```
37
- * dataSchema.registerInlineElement( {
38
- * view: 'span',
39
- * model: 'my-span',
40
- * attributeProperties: {
41
- * copyOnEnter: true
42
- * }
43
- * } );
44
- * ```
45
- */
46
- export default class DataSchema extends Plugin {
47
- /**
48
- * A map of registered data schema definitions.
49
- */
50
- private readonly _definitions;
51
- /**
52
- * @inheritDoc
53
- */
54
- static get pluginName(): "DataSchema";
55
- /**
56
- * @inheritDoc
57
- */
58
- static get isOfficialPlugin(): true;
59
- /**
60
- * @inheritDoc
61
- */
62
- init(): void;
63
- /**
64
- * Add new data schema definition describing block element.
65
- */
66
- registerBlockElement(definition: DataSchemaBlockElementDefinition): void;
67
- /**
68
- * Add new data schema definition describing inline element.
69
- */
70
- registerInlineElement(definition: DataSchemaInlineElementDefinition): void;
71
- /**
72
- * Updates schema definition describing block element with new properties.
73
- *
74
- * Creates new scheme if it doesn't exist.
75
- * Array properties are concatenated with original values.
76
- *
77
- * @param definition Definition update.
78
- */
79
- extendBlockElement(definition: DataSchemaBlockElementDefinition): void;
80
- /**
81
- * Updates schema definition describing inline element with new properties.
82
- *
83
- * Creates new scheme if it doesn't exist.
84
- * Array properties are concatenated with original values.
85
- *
86
- * @param definition Definition update.
87
- */
88
- extendInlineElement(definition: DataSchemaInlineElementDefinition): void;
89
- /**
90
- * Returns all definitions matching the given view name.
91
- *
92
- * @param includeReferences Indicates if this method should also include definitions of referenced models.
93
- */
94
- getDefinitionsForView(viewName: string | RegExp, includeReferences?: boolean): Set<DataSchemaDefinition>;
95
- /**
96
- * Returns definitions matching the given model name.
97
- */
98
- getDefinitionsForModel(modelName: string): Array<DataSchemaDefinition>;
99
- /**
100
- * Returns definitions matching the given view name.
101
- */
102
- private _getMatchingViewDefinitions;
103
- /**
104
- * Resolves all definition references registered for the given data schema definition.
105
- *
106
- * @param modelName Data schema model name.
107
- */
108
- private _getReferences;
109
- /**
110
- * Updates schema definition with new properties.
111
- *
112
- * Creates new scheme if it doesn't exist.
113
- * Array properties are concatenated with original values.
114
- *
115
- * @param definition Definition update.
116
- */
117
- private _extendDefinition;
118
- }
119
- /**
120
- * A base definition of {@link module:html-support/dataschema~DataSchema data schema}.
121
- */
122
- export interface DataSchemaDefinition {
123
- /**
124
- * Name of the model.
125
- */
126
- model: string;
127
- /**
128
- * Name of the view element.
129
- */
130
- view?: string;
131
- /**
132
- * Indicates that the definition describes object element.
133
- */
134
- isObject?: boolean;
135
- /**
136
- * The model schema item definition describing registered model.
137
- */
138
- modelSchema?: SchemaItemDefinition;
139
- /**
140
- * Indicates that the definition describes block element.
141
- * Set by {@link module:html-support/dataschema~DataSchema#registerBlockElement} method.
142
- */
143
- isBlock?: boolean;
144
- /**
145
- * Indicates that the definition describes inline element.
146
- */
147
- isInline?: boolean;
148
- }
149
- /**
150
- * A definition of {@link module:html-support/dataschema~DataSchema data schema} for block elements.
151
- */
152
- export interface DataSchemaBlockElementDefinition extends DataSchemaDefinition {
153
- /**
154
- * Should be used when an element can behave both as a sectioning element (e.g. article) and
155
- * element accepting only inline content (e.g. paragraph).
156
- * If an element contains only inline content, this option will be used as a model name.
157
- */
158
- paragraphLikeModel?: string;
159
- }
160
- /**
161
- * A definition of {@link module:html-support/dataschema~DataSchema data schema} for inline elements.
162
- */
163
- export interface DataSchemaInlineElementDefinition extends DataSchemaDefinition {
164
- /**
165
- * Additional metadata describing the model attribute.
166
- */
167
- attributeProperties?: AttributeProperties;
168
- /**
169
- * Element priority. Decides in what order elements are wrapped by
170
- * {@link module:engine/view/downcastwriter~DowncastWriter}.
171
- * Set by {@link module:html-support/dataschema~DataSchema#registerInlineElement} method.
172
- */
173
- priority?: number;
174
- /**
175
- * The name of the model attribute that generates the same view element. GHS inline attribute
176
- * will be removed from the model tree as soon as the coupled attribute is removed. See
177
- * {@link module:html-support/datafilter~DataFilter#_registerCoupledAttributesPostFixer GHS post-fixer} for more details.
178
- */
179
- coupledAttribute?: string;
180
- /**
181
- * Indicates that element should not be converted as a model text attribute.
182
- * It is used to map view elements that do not have a separate model element but their data is stored in a model attribute.
183
- * For example `<tbody>` element does not have a dedicated model element and GHS stores attributes of `<tbody>`
184
- * in the `htmlTbodyAttributes` model attribute of the `table` model element.
185
- */
186
- appliesToBlock?: boolean | string;
187
- /**
188
- * Indicates that an element should be preserved even if it has no content.
189
- */
190
- allowEmpty?: boolean;
191
- }
@@ -1,29 +0,0 @@
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-licensing-options
8
- */
9
- /**
10
- * @module html-support/fullpage
11
- */
12
- import { Plugin } from 'ckeditor5/src/core.js';
13
- /**
14
- * The full page editing feature. It preserves the whole HTML page in the editor data.
15
- */
16
- export default class FullPage extends Plugin {
17
- /**
18
- * @inheritDoc
19
- */
20
- static get pluginName(): "FullPage";
21
- /**
22
- * @inheritDoc
23
- */
24
- static get isOfficialPlugin(): true;
25
- /**
26
- * @inheritDoc
27
- */
28
- init(): void;
29
- }
@@ -1,106 +0,0 @@
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-licensing-options
8
- */
9
- /**
10
- * @module html-support/generalhtmlsupport
11
- */
12
- import { Plugin } from 'ckeditor5/src/core.js';
13
- import { type ArrayOrItem } from 'ckeditor5/src/utils.js';
14
- import DataFilter from './datafilter.js';
15
- import CodeBlockElementSupport from './integrations/codeblock.js';
16
- import DualContentModelElementSupport from './integrations/dualcontent.js';
17
- import HeadingElementSupport from './integrations/heading.js';
18
- import ImageElementSupport from './integrations/image.js';
19
- import MediaEmbedElementSupport from './integrations/mediaembed.js';
20
- import ScriptElementSupport from './integrations/script.js';
21
- import TableElementSupport from './integrations/table.js';
22
- import StyleElementSupport from './integrations/style.js';
23
- import ListElementSupport from './integrations/list.js';
24
- import CustomElementSupport from './integrations/customelement.js';
25
- import type { Selectable } from 'ckeditor5/src/engine.js';
26
- /**
27
- * The General HTML Support feature.
28
- *
29
- * This is a "glue" plugin which initializes the {@link module:html-support/datafilter~DataFilter data filter} configuration
30
- * and features integration with the General HTML Support.
31
- */
32
- export default class GeneralHtmlSupport extends Plugin {
33
- /**
34
- * @inheritDoc
35
- */
36
- static get pluginName(): "GeneralHtmlSupport";
37
- /**
38
- * @inheritDoc
39
- */
40
- static get isOfficialPlugin(): true;
41
- /**
42
- * @inheritDoc
43
- */
44
- static get requires(): readonly [typeof DataFilter, typeof CodeBlockElementSupport, typeof DualContentModelElementSupport, typeof HeadingElementSupport, typeof ImageElementSupport, typeof MediaEmbedElementSupport, typeof ScriptElementSupport, typeof TableElementSupport, typeof StyleElementSupport, typeof ListElementSupport, typeof CustomElementSupport];
45
- /**
46
- * @inheritDoc
47
- */
48
- init(): void;
49
- /**
50
- * Returns a GHS model attribute name related to a given view element name.
51
- *
52
- * @internal
53
- * @param viewElementName A view element name.
54
- */
55
- getGhsAttributeNameForElement(viewElementName: string): string;
56
- /**
57
- * Updates GHS model attribute for a specified view element name, so it includes the given class name.
58
- *
59
- * @internal
60
- * @param viewElementName A view element name.
61
- * @param className The css class to add.
62
- * @param selectable The selection or element to update.
63
- */
64
- addModelHtmlClass(viewElementName: string, className: ArrayOrItem<string>, selectable: Selectable): void;
65
- /**
66
- * Updates GHS model attribute for a specified view element name, so it does not include the given class name.
67
- *
68
- * @internal
69
- * @param viewElementName A view element name.
70
- * @param className The css class to remove.
71
- * @param selectable The selection or element to update.
72
- */
73
- removeModelHtmlClass(viewElementName: string, className: ArrayOrItem<string>, selectable: Selectable): void;
74
- /**
75
- * Updates GHS model attribute for a specified view element name, so it includes the given attribute.
76
- *
77
- * @param viewElementName A view element name.
78
- * @param attributes The object with attributes to set.
79
- * @param selectable The selection or element to update.
80
- */
81
- private setModelHtmlAttributes;
82
- /**
83
- * Updates GHS model attribute for a specified view element name, so it does not include the given attribute.
84
- *
85
- * @param viewElementName A view element name.
86
- * @param attributeName The attribute name (or names) to remove.
87
- * @param selectable The selection or element to update.
88
- */
89
- private removeModelHtmlAttributes;
90
- /**
91
- * Updates GHS model attribute for a specified view element name, so it includes a given style.
92
- *
93
- * @param viewElementName A view element name.
94
- * @param styles The object with styles to set.
95
- * @param selectable The selection or element to update.
96
- */
97
- private setModelHtmlStyles;
98
- /**
99
- * Updates GHS model attribute for a specified view element name, so it does not include a given style.
100
- *
101
- * @param viewElementName A view element name.
102
- * @param properties The style (or styles list) to remove.
103
- * @param selectable The selection or element to update.
104
- */
105
- private removeModelHtmlStyles;
106
- }
@@ -1,81 +0,0 @@
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-licensing-options
8
- */
9
- /**
10
- * @module html-support/generalhtmlsupportconfig
11
- */
12
- import type { MatcherObjectPattern } from 'ckeditor5/src/engine.js';
13
- /**
14
- * The configuration of the General HTML Support feature.
15
- * The option is used by the {@link module:html-support/generalhtmlsupport~GeneralHtmlSupport} feature.
16
- *
17
- * ```ts
18
- * ClassicEditor
19
- * .create( {
20
- * htmlSupport: ... // General HTML Support feature config.
21
- * } )
22
- * .then( ... )
23
- * .catch( ... );
24
- * ```
25
- *
26
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
27
- */
28
- export interface GeneralHtmlSupportConfig {
29
- /**
30
- * The configuration of allowed content rules used by General HTML Support.
31
- *
32
- * Setting this configuration option will enable HTML features that are not explicitly supported by any other
33
- * dedicated CKEditor 5 features.
34
- *
35
- * ```ts
36
- * const htmlSupportConfig.allow = [
37
- * {
38
- * name: 'div', // Enable 'div' element support,
39
- * classes: [ 'special-container' ], // allow 'special-container' class,
40
- * styles: 'background', // allow 'background' style,
41
- * attributes: true // allow any attribute (can be empty).
42
- * },
43
- * {
44
- * name: 'p', // Extend existing Paragraph feature,
45
- * classes: 'highlighted' // with 'highlighted' class,
46
- * attributes: [
47
- * { key: 'data-i18n-context, value: true } // and i18n attribute.
48
- * ]
49
- * }
50
- * ];
51
- * ```
52
- */
53
- allow?: Array<MatcherObjectPattern>;
54
- /**
55
- * The configuration of disallowed content rules used by General HTML Support.
56
- *
57
- * Setting this configuration option will disable listed HTML features.
58
- *
59
- * ```ts
60
- * const htmlSupportConfig.disallow = [
61
- * {
62
- * name: /[\s\S]+/ // For every HTML feature,
63
- * attributes: {
64
- * key: /^on.*$/ // disable 'on*' attributes, like 'onClick', 'onError' etc.
65
- * }
66
- * }
67
- * ];
68
- * ```
69
- */
70
- disallow?: Array<MatcherObjectPattern>;
71
- /**
72
- * The configuration of allowed empty inline elements that should not be removed.
73
- *
74
- * Note that you should also add an appropriate entry to {@link #allow} list.
75
- *
76
- * ```ts
77
- * const htmlSupportConfig.allowEmpty = [ 'i', 'span' ];
78
- * ```
79
- */
80
- allowEmpty?: Array<string>;
81
- }
@@ -1,79 +0,0 @@
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-licensing-options
8
- */
9
- /**
10
- * @module html-support/htmlcomment
11
- */
12
- import type { Position, Range } from 'ckeditor5/src/engine.js';
13
- import { Plugin } from 'ckeditor5/src/core.js';
14
- /**
15
- * The HTML comment feature. It preserves the HTML comments (`<!-- -->`) in the editor data.
16
- *
17
- * For a detailed overview, check the {@glink features/html/html-comments HTML comment feature documentation}.
18
- */
19
- export default class HtmlComment extends Plugin {
20
- /**
21
- * @inheritDoc
22
- */
23
- static get pluginName(): "HtmlComment";
24
- /**
25
- * @inheritDoc
26
- */
27
- static get isOfficialPlugin(): true;
28
- /**
29
- * @inheritDoc
30
- */
31
- init(): void;
32
- /**
33
- * Creates an HTML comment on the specified position and returns its ID.
34
- *
35
- * *Note*: If two comments are created at the same position, the second comment will be inserted before the first one.
36
- *
37
- * @returns Comment ID. This ID can be later used to e.g. remove the comment from the content.
38
- */
39
- createHtmlComment(position: Position, content: string): string;
40
- /**
41
- * Removes an HTML comment with the given comment ID.
42
- *
43
- * It does nothing and returns `false` if the comment with the given ID does not exist.
44
- * Otherwise it removes the comment and returns `true`.
45
- *
46
- * Note that a comment can be removed also by removing the content around the comment.
47
- *
48
- * @param commentID The ID of the comment to be removed.
49
- * @returns `true` when the comment with the given ID was removed, `false` otherwise.
50
- */
51
- removeHtmlComment(commentID: string): boolean;
52
- /**
53
- * Gets the HTML comment data for the comment with a given ID.
54
- *
55
- * Returns `null` if the comment does not exist.
56
- */
57
- getHtmlCommentData(commentID: string): HtmlCommentData | null;
58
- /**
59
- * Gets all HTML comments in the given range.
60
- *
61
- * By default, it includes comments at the range boundaries.
62
- *
63
- * @param range
64
- * @param options.skipBoundaries When set to `true` the range boundaries will be skipped.
65
- * @returns HTML comment IDs
66
- */
67
- getHtmlCommentsInRange(range: Range, { skipBoundaries }?: {
68
- skipBoundaries?: boolean | undefined;
69
- }): Array<string>;
70
- }
71
- /**
72
- * An interface for the HTML comments data.
73
- *
74
- * It consists of the {@link module:engine/model/position~Position `position`} and `content`.
75
- */
76
- export interface HtmlCommentData {
77
- position: Position;
78
- content: string;
79
- }
@@ -1,26 +0,0 @@
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-licensing-options
8
- */
9
- /**
10
- * @module html-support/htmlpagedataprocessor
11
- */
12
- import { HtmlDataProcessor, type ViewDocumentFragment } from 'ckeditor5/src/engine.js';
13
- /**
14
- * The full page HTML data processor class.
15
- * This data processor implementation uses HTML as input and output data.
16
- */
17
- export default class HtmlPageDataProcessor extends HtmlDataProcessor {
18
- /**
19
- * @inheritDoc
20
- */
21
- toView(data: string): ViewDocumentFragment;
22
- /**
23
- * @inheritDoc
24
- */
25
- toData(viewFragment: ViewDocumentFragment): string;
26
- }
package/dist/index.d.ts DELETED
@@ -1,29 +0,0 @@
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-licensing-options
8
- */
9
- /**
10
- * @module html-support
11
- */
12
- export { default as GeneralHtmlSupport } from './generalhtmlsupport.js';
13
- export { default as DataFilter } from './datafilter.js';
14
- export { default as DataSchema, type DataSchemaBlockElementDefinition } from './dataschema.js';
15
- export { default as HtmlComment } from './htmlcomment.js';
16
- export { default as FullPage } from './fullpage.js';
17
- export { default as HtmlPageDataProcessor } from './htmlpagedataprocessor.js';
18
- export type { GeneralHtmlSupportConfig } from './generalhtmlsupportconfig.js';
19
- export type { default as CodeBlockElementSupport } from './integrations/codeblock.js';
20
- export type { default as CustomElementSupport } from './integrations/customelement.js';
21
- export type { default as ListElementSupport } from './integrations/list.js';
22
- export type { default as DualContentModelElementSupport } from './integrations/dualcontent.js';
23
- export type { default as HeadingElementSupport } from './integrations/heading.js';
24
- export type { default as ImageElementSupport } from './integrations/image.js';
25
- export type { default as MediaEmbedElementSupport } from './integrations/mediaembed.js';
26
- export type { default as ScriptElementSupport } from './integrations/script.js';
27
- export type { default as StyleElementSupport } from './integrations/style.js';
28
- export type { default as TableElementSupport } from './integrations/table.js';
29
- import './augmentation.js';
@@ -1,31 +0,0 @@
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-licensing-options
8
- */
9
- import { Plugin } from 'ckeditor5/src/core.js';
10
- import DataFilter from '../datafilter.js';
11
- /**
12
- * Provides the General HTML Support integration with {@link module:code-block/codeblock~CodeBlock Code Block} feature.
13
- */
14
- export default class CodeBlockElementSupport extends Plugin {
15
- /**
16
- * @inheritDoc
17
- */
18
- static get requires(): readonly [typeof DataFilter];
19
- /**
20
- * @inheritDoc
21
- */
22
- static get pluginName(): "CodeBlockElementSupport";
23
- /**
24
- * @inheritDoc
25
- */
26
- static get isOfficialPlugin(): true;
27
- /**
28
- * @inheritDoc
29
- */
30
- init(): void;
31
- }
@@ -1,35 +0,0 @@
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-licensing-options
8
- */
9
- /**
10
- * @module html-support/integrations/customelement
11
- */
12
- import { Plugin } from 'ckeditor5/src/core.js';
13
- import DataSchema from '../dataschema.js';
14
- import DataFilter from '../datafilter.js';
15
- /**
16
- * Provides the General HTML Support for custom elements (not registered in the {@link module:html-support/dataschema~DataSchema}).
17
- */
18
- export default class CustomElementSupport extends Plugin {
19
- /**
20
- * @inheritDoc
21
- */
22
- static get requires(): readonly [typeof DataFilter, typeof DataSchema];
23
- /**
24
- * @inheritDoc
25
- */
26
- static get pluginName(): "CustomElementSupport";
27
- /**
28
- * @inheritDoc
29
- */
30
- static get isOfficialPlugin(): true;
31
- /**
32
- * @inheritDoc
33
- */
34
- init(): void;
35
- }
@@ -1,53 +0,0 @@
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-licensing-options
8
- */
9
- import { Plugin } from 'ckeditor5/src/core.js';
10
- import DataFilter from '../datafilter.js';
11
- /**
12
- * Provides the General HTML Support integration for elements which can behave like sectioning element (e.g. article) or
13
- * element accepting only inline content (e.g. paragraph).
14
- *
15
- * The distinction between this two content models is important for choosing correct schema model and proper content conversion.
16
- * As an example, it ensures that:
17
- *
18
- * * children elements paragraphing is enabled for sectioning elements only,
19
- * * element and its content can be correctly handled by editing view (splitting and merging elements),
20
- * * model element HTML is semantically correct and easier to work with.
21
- *
22
- * If element contains any block element, it will be treated as a sectioning element and registered using
23
- * {@link module:html-support/dataschema~DataSchemaDefinition#model} and
24
- * {@link module:html-support/dataschema~DataSchemaDefinition#modelSchema} in editor schema.
25
- * Otherwise, it will be registered under {@link module:html-support/dataschema~DataSchemaBlockElementDefinition#paragraphLikeModel} model
26
- * name with model schema accepting only inline content (inheriting from `$block`).
27
- */
28
- export default class DualContentModelElementSupport extends Plugin {
29
- /**
30
- * @inheritDoc
31
- */
32
- static get requires(): readonly [typeof DataFilter];
33
- /**
34
- * @inheritDoc
35
- */
36
- static get pluginName(): "DualContentModelElementSupport";
37
- /**
38
- * @inheritDoc
39
- */
40
- static get isOfficialPlugin(): true;
41
- /**
42
- * @inheritDoc
43
- */
44
- init(): void;
45
- /**
46
- * Checks whether the given view element includes any other block element.
47
- */
48
- private _hasBlockContent;
49
- /**
50
- * Adds attribute filtering conversion for the given data schema.
51
- */
52
- private _addAttributeConversion;
53
- }