@ckeditor/ckeditor5-list 0.0.0-internal-20241017.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 (505) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/LICENSE.md +17 -0
  3. package/README.md +26 -0
  4. package/build/list.js +5 -0
  5. package/build/translations/ar.js +1 -0
  6. package/build/translations/ast.js +1 -0
  7. package/build/translations/az.js +1 -0
  8. package/build/translations/bg.js +1 -0
  9. package/build/translations/bn.js +1 -0
  10. package/build/translations/ca.js +1 -0
  11. package/build/translations/cs.js +1 -0
  12. package/build/translations/da.js +1 -0
  13. package/build/translations/de-ch.js +1 -0
  14. package/build/translations/de.js +1 -0
  15. package/build/translations/el.js +1 -0
  16. package/build/translations/en-au.js +1 -0
  17. package/build/translations/en-gb.js +1 -0
  18. package/build/translations/eo.js +1 -0
  19. package/build/translations/es.js +1 -0
  20. package/build/translations/et.js +1 -0
  21. package/build/translations/eu.js +1 -0
  22. package/build/translations/fa.js +1 -0
  23. package/build/translations/fi.js +1 -0
  24. package/build/translations/fr.js +1 -0
  25. package/build/translations/gl.js +1 -0
  26. package/build/translations/he.js +1 -0
  27. package/build/translations/hi.js +1 -0
  28. package/build/translations/hr.js +1 -0
  29. package/build/translations/hu.js +1 -0
  30. package/build/translations/id.js +1 -0
  31. package/build/translations/it.js +1 -0
  32. package/build/translations/ja.js +1 -0
  33. package/build/translations/jv.js +1 -0
  34. package/build/translations/km.js +1 -0
  35. package/build/translations/kn.js +1 -0
  36. package/build/translations/ko.js +1 -0
  37. package/build/translations/ku.js +1 -0
  38. package/build/translations/lt.js +1 -0
  39. package/build/translations/lv.js +1 -0
  40. package/build/translations/ms.js +1 -0
  41. package/build/translations/nb.js +1 -0
  42. package/build/translations/ne.js +1 -0
  43. package/build/translations/nl.js +1 -0
  44. package/build/translations/no.js +1 -0
  45. package/build/translations/pl.js +1 -0
  46. package/build/translations/pt-br.js +1 -0
  47. package/build/translations/pt.js +1 -0
  48. package/build/translations/ro.js +1 -0
  49. package/build/translations/ru.js +1 -0
  50. package/build/translations/si.js +1 -0
  51. package/build/translations/sk.js +1 -0
  52. package/build/translations/sq.js +1 -0
  53. package/build/translations/sr-latn.js +1 -0
  54. package/build/translations/sr.js +1 -0
  55. package/build/translations/sv.js +1 -0
  56. package/build/translations/th.js +1 -0
  57. package/build/translations/ti.js +1 -0
  58. package/build/translations/tk.js +1 -0
  59. package/build/translations/tr.js +1 -0
  60. package/build/translations/tt.js +1 -0
  61. package/build/translations/ug.js +1 -0
  62. package/build/translations/uk.js +1 -0
  63. package/build/translations/ur.js +1 -0
  64. package/build/translations/uz.js +1 -0
  65. package/build/translations/vi.js +1 -0
  66. package/build/translations/zh-cn.js +1 -0
  67. package/build/translations/zh.js +1 -0
  68. package/ckeditor5-metadata.json +193 -0
  69. package/dist/augmentation.d.ts +57 -0
  70. package/dist/documentlist.d.ts +36 -0
  71. package/dist/documentlistproperties.d.ts +36 -0
  72. package/dist/index-content.css +116 -0
  73. package/dist/index-editor.css +82 -0
  74. package/dist/index.css +238 -0
  75. package/dist/index.css.map +1 -0
  76. package/dist/index.d.ts +49 -0
  77. package/dist/index.js +7994 -0
  78. package/dist/index.js.map +1 -0
  79. package/dist/legacylist/legacyconverters.d.ts +200 -0
  80. package/dist/legacylist/legacyindentcommand.d.ts +41 -0
  81. package/dist/legacylist/legacylistcommand.d.ts +60 -0
  82. package/dist/legacylist/legacylistediting.d.ts +40 -0
  83. package/dist/legacylist/legacylistutils.d.ts +49 -0
  84. package/dist/legacylist/legacyutils.d.ts +105 -0
  85. package/dist/legacylist.d.ts +34 -0
  86. package/dist/legacylistproperties/legacylistpropertiesediting.d.ts +80 -0
  87. package/dist/legacylistproperties/legacylistreversedcommand.d.ts +42 -0
  88. package/dist/legacylistproperties/legacyliststartcommand.d.ts +41 -0
  89. package/dist/legacylistproperties/legacyliststylecommand.d.ts +71 -0
  90. package/dist/legacylistproperties.d.ts +35 -0
  91. package/dist/legacytodolist/legacychecktodolistcommand.d.ts +56 -0
  92. package/dist/legacytodolist/legacytodolistconverters.d.ts +87 -0
  93. package/dist/legacytodolist/legacytodolistediting.d.ts +54 -0
  94. package/dist/legacytodolist.d.ts +35 -0
  95. package/dist/list/adjacentlistssupport.d.ts +23 -0
  96. package/dist/list/converters.d.ts +69 -0
  97. package/dist/list/listcommand.d.ts +96 -0
  98. package/dist/list/listediting.d.ts +230 -0
  99. package/dist/list/listindentcommand.d.ts +66 -0
  100. package/dist/list/listmergecommand.d.ts +80 -0
  101. package/dist/list/listsplitcommand.d.ts +71 -0
  102. package/dist/list/listui.d.ts +27 -0
  103. package/dist/list/listutils.d.ts +60 -0
  104. package/dist/list/utils/listwalker.d.ts +146 -0
  105. package/dist/list/utils/model.d.ts +213 -0
  106. package/dist/list/utils/postfixers.d.ts +41 -0
  107. package/dist/list/utils/view.d.ts +86 -0
  108. package/dist/list/utils.d.ts +22 -0
  109. package/dist/list.d.ts +34 -0
  110. package/dist/listconfig.d.ts +164 -0
  111. package/dist/listproperties/converters.d.ts +23 -0
  112. package/dist/listproperties/listpropertiesediting.d.ts +96 -0
  113. package/dist/listproperties/listpropertiesui.d.ts +31 -0
  114. package/dist/listproperties/listpropertiesutils.d.ts +41 -0
  115. package/dist/listproperties/listreversedcommand.d.ts +40 -0
  116. package/dist/listproperties/liststartcommand.d.ts +42 -0
  117. package/dist/listproperties/liststylecommand.d.ts +76 -0
  118. package/dist/listproperties/ui/listpropertiesview.d.ts +160 -0
  119. package/dist/listproperties/utils/config.d.ts +39 -0
  120. package/dist/listproperties/utils/style.d.ts +24 -0
  121. package/dist/listproperties.d.ts +35 -0
  122. package/dist/tododocumentlist.d.ts +36 -0
  123. package/dist/todolist/checktodolistcommand.d.ts +53 -0
  124. package/dist/todolist/todocheckboxchangeobserver.d.ts +45 -0
  125. package/dist/todolist/todolistediting.d.ts +53 -0
  126. package/dist/todolist/todolistui.d.ts +27 -0
  127. package/dist/todolist.d.ts +35 -0
  128. package/dist/translations/ar.d.ts +8 -0
  129. package/dist/translations/ar.js +5 -0
  130. package/dist/translations/ar.umd.js +11 -0
  131. package/dist/translations/ast.d.ts +8 -0
  132. package/dist/translations/ast.js +5 -0
  133. package/dist/translations/ast.umd.js +11 -0
  134. package/dist/translations/az.d.ts +8 -0
  135. package/dist/translations/az.js +5 -0
  136. package/dist/translations/az.umd.js +11 -0
  137. package/dist/translations/bg.d.ts +8 -0
  138. package/dist/translations/bg.js +5 -0
  139. package/dist/translations/bg.umd.js +11 -0
  140. package/dist/translations/bn.d.ts +8 -0
  141. package/dist/translations/bn.js +5 -0
  142. package/dist/translations/bn.umd.js +11 -0
  143. package/dist/translations/ca.d.ts +8 -0
  144. package/dist/translations/ca.js +5 -0
  145. package/dist/translations/ca.umd.js +11 -0
  146. package/dist/translations/cs.d.ts +8 -0
  147. package/dist/translations/cs.js +5 -0
  148. package/dist/translations/cs.umd.js +11 -0
  149. package/dist/translations/da.d.ts +8 -0
  150. package/dist/translations/da.js +5 -0
  151. package/dist/translations/da.umd.js +11 -0
  152. package/dist/translations/de-ch.d.ts +8 -0
  153. package/dist/translations/de-ch.js +5 -0
  154. package/dist/translations/de-ch.umd.js +11 -0
  155. package/dist/translations/de.d.ts +8 -0
  156. package/dist/translations/de.js +5 -0
  157. package/dist/translations/de.umd.js +11 -0
  158. package/dist/translations/el.d.ts +8 -0
  159. package/dist/translations/el.js +5 -0
  160. package/dist/translations/el.umd.js +11 -0
  161. package/dist/translations/en-au.d.ts +8 -0
  162. package/dist/translations/en-au.js +5 -0
  163. package/dist/translations/en-au.umd.js +11 -0
  164. package/dist/translations/en-gb.d.ts +8 -0
  165. package/dist/translations/en-gb.js +5 -0
  166. package/dist/translations/en-gb.umd.js +11 -0
  167. package/dist/translations/en.d.ts +8 -0
  168. package/dist/translations/en.js +5 -0
  169. package/dist/translations/en.umd.js +11 -0
  170. package/dist/translations/eo.d.ts +8 -0
  171. package/dist/translations/eo.js +5 -0
  172. package/dist/translations/eo.umd.js +11 -0
  173. package/dist/translations/es.d.ts +8 -0
  174. package/dist/translations/es.js +5 -0
  175. package/dist/translations/es.umd.js +11 -0
  176. package/dist/translations/et.d.ts +8 -0
  177. package/dist/translations/et.js +5 -0
  178. package/dist/translations/et.umd.js +11 -0
  179. package/dist/translations/eu.d.ts +8 -0
  180. package/dist/translations/eu.js +5 -0
  181. package/dist/translations/eu.umd.js +11 -0
  182. package/dist/translations/fa.d.ts +8 -0
  183. package/dist/translations/fa.js +5 -0
  184. package/dist/translations/fa.umd.js +11 -0
  185. package/dist/translations/fi.d.ts +8 -0
  186. package/dist/translations/fi.js +5 -0
  187. package/dist/translations/fi.umd.js +11 -0
  188. package/dist/translations/fr.d.ts +8 -0
  189. package/dist/translations/fr.js +5 -0
  190. package/dist/translations/fr.umd.js +11 -0
  191. package/dist/translations/gl.d.ts +8 -0
  192. package/dist/translations/gl.js +5 -0
  193. package/dist/translations/gl.umd.js +11 -0
  194. package/dist/translations/he.d.ts +8 -0
  195. package/dist/translations/he.js +5 -0
  196. package/dist/translations/he.umd.js +11 -0
  197. package/dist/translations/hi.d.ts +8 -0
  198. package/dist/translations/hi.js +5 -0
  199. package/dist/translations/hi.umd.js +11 -0
  200. package/dist/translations/hr.d.ts +8 -0
  201. package/dist/translations/hr.js +5 -0
  202. package/dist/translations/hr.umd.js +11 -0
  203. package/dist/translations/hu.d.ts +8 -0
  204. package/dist/translations/hu.js +5 -0
  205. package/dist/translations/hu.umd.js +11 -0
  206. package/dist/translations/id.d.ts +8 -0
  207. package/dist/translations/id.js +5 -0
  208. package/dist/translations/id.umd.js +11 -0
  209. package/dist/translations/it.d.ts +8 -0
  210. package/dist/translations/it.js +5 -0
  211. package/dist/translations/it.umd.js +11 -0
  212. package/dist/translations/ja.d.ts +8 -0
  213. package/dist/translations/ja.js +5 -0
  214. package/dist/translations/ja.umd.js +11 -0
  215. package/dist/translations/jv.d.ts +8 -0
  216. package/dist/translations/jv.js +5 -0
  217. package/dist/translations/jv.umd.js +11 -0
  218. package/dist/translations/km.d.ts +8 -0
  219. package/dist/translations/km.js +5 -0
  220. package/dist/translations/km.umd.js +11 -0
  221. package/dist/translations/kn.d.ts +8 -0
  222. package/dist/translations/kn.js +5 -0
  223. package/dist/translations/kn.umd.js +11 -0
  224. package/dist/translations/ko.d.ts +8 -0
  225. package/dist/translations/ko.js +5 -0
  226. package/dist/translations/ko.umd.js +11 -0
  227. package/dist/translations/ku.d.ts +8 -0
  228. package/dist/translations/ku.js +5 -0
  229. package/dist/translations/ku.umd.js +11 -0
  230. package/dist/translations/lt.d.ts +8 -0
  231. package/dist/translations/lt.js +5 -0
  232. package/dist/translations/lt.umd.js +11 -0
  233. package/dist/translations/lv.d.ts +8 -0
  234. package/dist/translations/lv.js +5 -0
  235. package/dist/translations/lv.umd.js +11 -0
  236. package/dist/translations/ms.d.ts +8 -0
  237. package/dist/translations/ms.js +5 -0
  238. package/dist/translations/ms.umd.js +11 -0
  239. package/dist/translations/nb.d.ts +8 -0
  240. package/dist/translations/nb.js +5 -0
  241. package/dist/translations/nb.umd.js +11 -0
  242. package/dist/translations/ne.d.ts +8 -0
  243. package/dist/translations/ne.js +5 -0
  244. package/dist/translations/ne.umd.js +11 -0
  245. package/dist/translations/nl.d.ts +8 -0
  246. package/dist/translations/nl.js +5 -0
  247. package/dist/translations/nl.umd.js +11 -0
  248. package/dist/translations/no.d.ts +8 -0
  249. package/dist/translations/no.js +5 -0
  250. package/dist/translations/no.umd.js +11 -0
  251. package/dist/translations/pl.d.ts +8 -0
  252. package/dist/translations/pl.js +5 -0
  253. package/dist/translations/pl.umd.js +11 -0
  254. package/dist/translations/pt-br.d.ts +8 -0
  255. package/dist/translations/pt-br.js +5 -0
  256. package/dist/translations/pt-br.umd.js +11 -0
  257. package/dist/translations/pt.d.ts +8 -0
  258. package/dist/translations/pt.js +5 -0
  259. package/dist/translations/pt.umd.js +11 -0
  260. package/dist/translations/ro.d.ts +8 -0
  261. package/dist/translations/ro.js +5 -0
  262. package/dist/translations/ro.umd.js +11 -0
  263. package/dist/translations/ru.d.ts +8 -0
  264. package/dist/translations/ru.js +5 -0
  265. package/dist/translations/ru.umd.js +11 -0
  266. package/dist/translations/si.d.ts +8 -0
  267. package/dist/translations/si.js +5 -0
  268. package/dist/translations/si.umd.js +11 -0
  269. package/dist/translations/sk.d.ts +8 -0
  270. package/dist/translations/sk.js +5 -0
  271. package/dist/translations/sk.umd.js +11 -0
  272. package/dist/translations/sq.d.ts +8 -0
  273. package/dist/translations/sq.js +5 -0
  274. package/dist/translations/sq.umd.js +11 -0
  275. package/dist/translations/sr-latn.d.ts +8 -0
  276. package/dist/translations/sr-latn.js +5 -0
  277. package/dist/translations/sr-latn.umd.js +11 -0
  278. package/dist/translations/sr.d.ts +8 -0
  279. package/dist/translations/sr.js +5 -0
  280. package/dist/translations/sr.umd.js +11 -0
  281. package/dist/translations/sv.d.ts +8 -0
  282. package/dist/translations/sv.js +5 -0
  283. package/dist/translations/sv.umd.js +11 -0
  284. package/dist/translations/th.d.ts +8 -0
  285. package/dist/translations/th.js +5 -0
  286. package/dist/translations/th.umd.js +11 -0
  287. package/dist/translations/ti.d.ts +8 -0
  288. package/dist/translations/ti.js +5 -0
  289. package/dist/translations/ti.umd.js +11 -0
  290. package/dist/translations/tk.d.ts +8 -0
  291. package/dist/translations/tk.js +5 -0
  292. package/dist/translations/tk.umd.js +11 -0
  293. package/dist/translations/tr.d.ts +8 -0
  294. package/dist/translations/tr.js +5 -0
  295. package/dist/translations/tr.umd.js +11 -0
  296. package/dist/translations/tt.d.ts +8 -0
  297. package/dist/translations/tt.js +5 -0
  298. package/dist/translations/tt.umd.js +11 -0
  299. package/dist/translations/ug.d.ts +8 -0
  300. package/dist/translations/ug.js +5 -0
  301. package/dist/translations/ug.umd.js +11 -0
  302. package/dist/translations/uk.d.ts +8 -0
  303. package/dist/translations/uk.js +5 -0
  304. package/dist/translations/uk.umd.js +11 -0
  305. package/dist/translations/ur.d.ts +8 -0
  306. package/dist/translations/ur.js +5 -0
  307. package/dist/translations/ur.umd.js +11 -0
  308. package/dist/translations/uz.d.ts +8 -0
  309. package/dist/translations/uz.js +5 -0
  310. package/dist/translations/uz.umd.js +11 -0
  311. package/dist/translations/vi.d.ts +8 -0
  312. package/dist/translations/vi.js +5 -0
  313. package/dist/translations/vi.umd.js +11 -0
  314. package/dist/translations/zh-cn.d.ts +8 -0
  315. package/dist/translations/zh-cn.js +5 -0
  316. package/dist/translations/zh-cn.umd.js +11 -0
  317. package/dist/translations/zh.d.ts +8 -0
  318. package/dist/translations/zh.js +5 -0
  319. package/dist/translations/zh.umd.js +11 -0
  320. package/lang/contexts.json +35 -0
  321. package/lang/translations/ar.po +150 -0
  322. package/lang/translations/ast.po +150 -0
  323. package/lang/translations/az.po +150 -0
  324. package/lang/translations/bg.po +150 -0
  325. package/lang/translations/bn.po +150 -0
  326. package/lang/translations/ca.po +150 -0
  327. package/lang/translations/cs.po +150 -0
  328. package/lang/translations/da.po +150 -0
  329. package/lang/translations/de-ch.po +150 -0
  330. package/lang/translations/de.po +150 -0
  331. package/lang/translations/el.po +150 -0
  332. package/lang/translations/en-au.po +150 -0
  333. package/lang/translations/en-gb.po +150 -0
  334. package/lang/translations/en.po +150 -0
  335. package/lang/translations/eo.po +150 -0
  336. package/lang/translations/es.po +150 -0
  337. package/lang/translations/et.po +150 -0
  338. package/lang/translations/eu.po +150 -0
  339. package/lang/translations/fa.po +150 -0
  340. package/lang/translations/fi.po +150 -0
  341. package/lang/translations/fr.po +150 -0
  342. package/lang/translations/gl.po +150 -0
  343. package/lang/translations/he.po +150 -0
  344. package/lang/translations/hi.po +150 -0
  345. package/lang/translations/hr.po +150 -0
  346. package/lang/translations/hu.po +150 -0
  347. package/lang/translations/id.po +150 -0
  348. package/lang/translations/it.po +150 -0
  349. package/lang/translations/ja.po +150 -0
  350. package/lang/translations/jv.po +150 -0
  351. package/lang/translations/km.po +150 -0
  352. package/lang/translations/kn.po +150 -0
  353. package/lang/translations/ko.po +150 -0
  354. package/lang/translations/ku.po +150 -0
  355. package/lang/translations/lt.po +150 -0
  356. package/lang/translations/lv.po +150 -0
  357. package/lang/translations/ms.po +150 -0
  358. package/lang/translations/nb.po +150 -0
  359. package/lang/translations/ne.po +150 -0
  360. package/lang/translations/nl.po +150 -0
  361. package/lang/translations/no.po +150 -0
  362. package/lang/translations/pl.po +150 -0
  363. package/lang/translations/pt-br.po +150 -0
  364. package/lang/translations/pt.po +150 -0
  365. package/lang/translations/ro.po +150 -0
  366. package/lang/translations/ru.po +150 -0
  367. package/lang/translations/si.po +150 -0
  368. package/lang/translations/sk.po +150 -0
  369. package/lang/translations/sq.po +150 -0
  370. package/lang/translations/sr-latn.po +150 -0
  371. package/lang/translations/sr.po +150 -0
  372. package/lang/translations/sv.po +150 -0
  373. package/lang/translations/th.po +150 -0
  374. package/lang/translations/ti.po +150 -0
  375. package/lang/translations/tk.po +150 -0
  376. package/lang/translations/tr.po +150 -0
  377. package/lang/translations/tt.po +150 -0
  378. package/lang/translations/ug.po +150 -0
  379. package/lang/translations/uk.po +150 -0
  380. package/lang/translations/ur.po +150 -0
  381. package/lang/translations/uz.po +150 -0
  382. package/lang/translations/vi.po +150 -0
  383. package/lang/translations/zh-cn.po +150 -0
  384. package/lang/translations/zh.po +150 -0
  385. package/package.json +45 -0
  386. package/src/augmentation.d.ts +53 -0
  387. package/src/augmentation.js +5 -0
  388. package/src/documentlist.d.ts +32 -0
  389. package/src/documentlist.js +47 -0
  390. package/src/documentlistproperties.d.ts +32 -0
  391. package/src/documentlistproperties.js +47 -0
  392. package/src/index.d.ts +45 -0
  393. package/src/index.js +39 -0
  394. package/src/legacylist/legacyconverters.d.ts +196 -0
  395. package/src/legacylist/legacyconverters.js +905 -0
  396. package/src/legacylist/legacyindentcommand.d.ts +37 -0
  397. package/src/legacylist/legacyindentcommand.js +107 -0
  398. package/src/legacylist/legacylistcommand.d.ts +56 -0
  399. package/src/legacylist/legacylistcommand.js +274 -0
  400. package/src/legacylist/legacylistediting.d.ts +36 -0
  401. package/src/legacylist/legacylistediting.js +167 -0
  402. package/src/legacylist/legacylistutils.d.ts +45 -0
  403. package/src/legacylist/legacylistutils.js +52 -0
  404. package/src/legacylist/legacyutils.d.ts +101 -0
  405. package/src/legacylist/legacyutils.js +347 -0
  406. package/src/legacylist.d.ts +30 -0
  407. package/src/legacylist.js +36 -0
  408. package/src/legacylistproperties/legacylistpropertiesediting.d.ts +76 -0
  409. package/src/legacylistproperties/legacylistpropertiesediting.js +702 -0
  410. package/src/legacylistproperties/legacylistreversedcommand.d.ts +38 -0
  411. package/src/legacylistproperties/legacylistreversedcommand.js +52 -0
  412. package/src/legacylistproperties/legacyliststartcommand.d.ts +37 -0
  413. package/src/legacylistproperties/legacyliststartcommand.js +51 -0
  414. package/src/legacylistproperties/legacyliststylecommand.d.ts +67 -0
  415. package/src/legacylistproperties/legacyliststylecommand.js +100 -0
  416. package/src/legacylistproperties.d.ts +31 -0
  417. package/src/legacylistproperties.js +37 -0
  418. package/src/legacytodolist/legacychecktodolistcommand.d.ts +52 -0
  419. package/src/legacytodolist/legacychecktodolistcommand.js +76 -0
  420. package/src/legacytodolist/legacytodolistconverters.d.ts +83 -0
  421. package/src/legacytodolist/legacytodolistconverters.js +261 -0
  422. package/src/legacytodolist/legacytodolistediting.d.ts +50 -0
  423. package/src/legacytodolist/legacytodolistediting.js +199 -0
  424. package/src/legacytodolist.d.ts +31 -0
  425. package/src/legacytodolist.js +37 -0
  426. package/src/list/adjacentlistssupport.d.ts +19 -0
  427. package/src/list/adjacentlistssupport.js +87 -0
  428. package/src/list/converters.d.ts +65 -0
  429. package/src/list/converters.js +491 -0
  430. package/src/list/listcommand.d.ts +92 -0
  431. package/src/list/listcommand.js +163 -0
  432. package/src/list/listediting.d.ts +226 -0
  433. package/src/list/listediting.js +678 -0
  434. package/src/list/listindentcommand.d.ts +62 -0
  435. package/src/list/listindentcommand.js +129 -0
  436. package/src/list/listmergecommand.d.ts +76 -0
  437. package/src/list/listmergecommand.js +174 -0
  438. package/src/list/listsplitcommand.d.ts +67 -0
  439. package/src/list/listsplitcommand.js +70 -0
  440. package/src/list/listui.d.ts +23 -0
  441. package/src/list/listui.js +41 -0
  442. package/src/list/listutils.d.ts +56 -0
  443. package/src/list/listutils.js +62 -0
  444. package/src/list/utils/listwalker.d.ts +142 -0
  445. package/src/list/utils/listwalker.js +182 -0
  446. package/src/list/utils/model.d.ts +209 -0
  447. package/src/list/utils/model.js +464 -0
  448. package/src/list/utils/postfixers.d.ts +37 -0
  449. package/src/list/utils/postfixers.js +126 -0
  450. package/src/list/utils/view.d.ts +82 -0
  451. package/src/list/utils/view.js +117 -0
  452. package/src/list/utils.d.ts +18 -0
  453. package/src/list/utils.js +51 -0
  454. package/src/list.d.ts +30 -0
  455. package/src/list.js +36 -0
  456. package/src/listconfig.d.ts +160 -0
  457. package/src/listconfig.js +5 -0
  458. package/src/listproperties/converters.d.ts +19 -0
  459. package/src/listproperties/converters.js +43 -0
  460. package/src/listproperties/listpropertiesediting.d.ts +92 -0
  461. package/src/listproperties/listpropertiesediting.js +275 -0
  462. package/src/listproperties/listpropertiesui.d.ts +27 -0
  463. package/src/listproperties/listpropertiesui.js +371 -0
  464. package/src/listproperties/listpropertiesutils.d.ts +37 -0
  465. package/src/listproperties/listpropertiesutils.js +50 -0
  466. package/src/listproperties/listreversedcommand.d.ts +36 -0
  467. package/src/listproperties/listreversedcommand.js +55 -0
  468. package/src/listproperties/liststartcommand.d.ts +38 -0
  469. package/src/listproperties/liststartcommand.js +60 -0
  470. package/src/listproperties/liststylecommand.d.ts +72 -0
  471. package/src/listproperties/liststylecommand.js +113 -0
  472. package/src/listproperties/ui/listpropertiesview.d.ts +156 -0
  473. package/src/listproperties/ui/listpropertiesview.js +301 -0
  474. package/src/listproperties/utils/config.d.ts +35 -0
  475. package/src/listproperties/utils/config.js +70 -0
  476. package/src/listproperties/utils/style.d.ts +20 -0
  477. package/src/listproperties/utils/style.js +54 -0
  478. package/src/listproperties.d.ts +31 -0
  479. package/src/listproperties.js +37 -0
  480. package/src/tododocumentlist.d.ts +32 -0
  481. package/src/tododocumentlist.js +47 -0
  482. package/src/todolist/checktodolistcommand.d.ts +49 -0
  483. package/src/todolist/checktodolistcommand.js +82 -0
  484. package/src/todolist/todocheckboxchangeobserver.d.ts +41 -0
  485. package/src/todolist/todocheckboxchangeobserver.js +37 -0
  486. package/src/todolist/todolistediting.d.ts +49 -0
  487. package/src/todolist/todolistediting.js +470 -0
  488. package/src/todolist/todolistui.d.ts +23 -0
  489. package/src/todolist/todolistui.js +34 -0
  490. package/src/todolist.d.ts +31 -0
  491. package/src/todolist.js +37 -0
  492. package/theme/documentlist.css +8 -0
  493. package/theme/icons/liststylecircle.svg +1 -0
  494. package/theme/icons/liststyledecimal.svg +1 -0
  495. package/theme/icons/liststyledecimalleadingzero.svg +1 -0
  496. package/theme/icons/liststyledisc.svg +1 -0
  497. package/theme/icons/liststylelowerlatin.svg +1 -0
  498. package/theme/icons/liststylelowerroman.svg +1 -0
  499. package/theme/icons/liststylesquare.svg +1 -0
  500. package/theme/icons/liststyleupperlatin.svg +1 -0
  501. package/theme/icons/liststyleupperroman.svg +1 -0
  502. package/theme/list.css +40 -0
  503. package/theme/listproperties.css +10 -0
  504. package/theme/liststyles.css +8 -0
  505. package/theme/todolist.css +140 -0
@@ -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
+ /**
10
+ * @module list/listproperties/listpropertiesui
11
+ */
12
+ import { Plugin } from 'ckeditor5/src/core.js';
13
+ import '../../theme/liststyles.css';
14
+ /**
15
+ * The list properties UI plugin. It introduces the extended `'bulletedList'` and `'numberedList'` toolbar
16
+ * buttons that allow users to control such aspects of list as the marker, start index or order.
17
+ *
18
+ * **Note**: Buttons introduced by this plugin override implementations from the {@link module:list/list/listui~ListUI}
19
+ * (because they share the same names).
20
+ */
21
+ export default class ListPropertiesUI extends Plugin {
22
+ /**
23
+ * @inheritDoc
24
+ */
25
+ static get pluginName(): "ListPropertiesUI";
26
+ /**
27
+ * @inheritDoc
28
+ */
29
+ static get isOfficialPlugin(): true;
30
+ init(): void;
31
+ }
@@ -0,0 +1,41 @@
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 list/listproperties/listpropertiesutils
11
+ */
12
+ import { Plugin } from 'ckeditor5/src/core.js';
13
+ /**
14
+ * A set of helpers related to document lists.
15
+ */
16
+ export default class ListPropertiesUtils extends Plugin {
17
+ /**
18
+ * @inheritDoc
19
+ */
20
+ static get pluginName(): "ListPropertiesUtils";
21
+ /**
22
+ * @inheritDoc
23
+ */
24
+ static get isOfficialPlugin(): true;
25
+ /**
26
+ * Gets all the style types supported by given list type.
27
+ */
28
+ getAllSupportedStyleTypes(): Array<string>;
29
+ /**
30
+ * Checks whether the given list-style-type is supported by numbered or bulleted list.
31
+ */
32
+ getListTypeFromListStyleType(listStyleType: string): 'bulleted' | 'numbered' | null;
33
+ /**
34
+ * Converts `type` attribute of `<ul>` or `<ol>` elements to `list-style-type` equivalent.
35
+ */
36
+ getListStyleTypeFromTypeAttribute(value: string): string | null;
37
+ /**
38
+ * Converts `list-style-type` style to `type` attribute of `<ul>` or `<ol>` elements.
39
+ */
40
+ getTypeAttributeFromListStyleType(value: string): string | null;
41
+ }
@@ -0,0 +1,40 @@
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 list/listproperties/listreversedcommand
11
+ */
12
+ import { Command } from 'ckeditor5/src/core.js';
13
+ /**
14
+ * The list reversed command. It changes the `listReversed` attribute of the selected list items,
15
+ * letting the user to choose the order of an ordered list.
16
+ * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
17
+ */
18
+ export default class ListReversedCommand extends Command {
19
+ /**
20
+ * @inheritDoc
21
+ */
22
+ value: boolean | null;
23
+ /**
24
+ * @inheritDoc
25
+ */
26
+ refresh(): void;
27
+ /**
28
+ * Executes the command.
29
+ *
30
+ * @fires execute
31
+ * @param options.reversed Whether the list should be reversed.
32
+ */
33
+ execute(options?: {
34
+ reversed?: boolean;
35
+ }): void;
36
+ /**
37
+ * Checks the command's {@link #value}.
38
+ */
39
+ private _getValue;
40
+ }
@@ -0,0 +1,42 @@
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 list/listproperties/liststartcommand
11
+ */
12
+ import { Command } from 'ckeditor5/src/core.js';
13
+ /**
14
+ * The list start index command. It changes the `listStart` attribute of the selected list items,
15
+ * letting the user to choose the starting point of an ordered list.
16
+ * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
17
+ */
18
+ export default class ListStartCommand extends Command {
19
+ /**
20
+ * @inheritDoc
21
+ */
22
+ value: number | null;
23
+ /**
24
+ * @inheritDoc
25
+ */
26
+ refresh(): void;
27
+ /**
28
+ * Executes the command.
29
+ *
30
+ * @fires execute
31
+ * @param options.startIndex The list start index.
32
+ */
33
+ execute({ startIndex }?: {
34
+ startIndex?: number;
35
+ }): void;
36
+ /**
37
+ * Checks the command's {@link #value}.
38
+ *
39
+ * @returns The current value.
40
+ */
41
+ private _getValue;
42
+ }
@@ -0,0 +1,76 @@
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 list/listproperties/liststylecommand
11
+ */
12
+ import { Command, type Editor } from 'ckeditor5/src/core.js';
13
+ /**
14
+ * The list style command. It changes `listStyle` attribute of the selected list items,
15
+ * letting the user choose styles for the list item markers.
16
+ * It is used by the {@link module:list/listproperties~ListProperties list properties feature}.
17
+ */
18
+ export default class ListStyleCommand extends Command {
19
+ /**
20
+ * @inheritDoc
21
+ */
22
+ value: string | null;
23
+ /**
24
+ * The default type of the list style.
25
+ */
26
+ readonly defaultType: string;
27
+ /**
28
+ * The list of supported style types by this command.
29
+ */
30
+ private _supportedTypes;
31
+ /**
32
+ * Creates an instance of the command.
33
+ *
34
+ * @param editor The editor instance.
35
+ * @param defaultType The list type that will be used by default if the value was not specified during
36
+ * the command execution.
37
+ * @param supportedTypes The list of supported style types by this command.
38
+ */
39
+ constructor(editor: Editor, defaultType: string, supportedTypes?: Array<string>);
40
+ /**
41
+ * @inheritDoc
42
+ */
43
+ refresh(): void;
44
+ /**
45
+ * Executes the command.
46
+ *
47
+ * @fires execute
48
+ * @param options.type The type of the list style, e.g. `'disc'` or `'square'`. If `null` is specified, the default
49
+ * style will be applied.
50
+ */
51
+ execute(options?: {
52
+ type?: string | null;
53
+ }): void;
54
+ /**
55
+ * Checks if the given style type is supported by this plugin.
56
+ */
57
+ isStyleTypeSupported(value: string): boolean;
58
+ /**
59
+ * Checks the command's {@link #value}.
60
+ *
61
+ * @returns The current value.
62
+ */
63
+ private _getValue;
64
+ /**
65
+ * Checks whether the command can be enabled in the current context.
66
+ *
67
+ * @returns Whether the command should be enabled.
68
+ */
69
+ private _checkEnabled;
70
+ /**
71
+ * Check if the provided list style is valid. Also change the selection to a list if it's not set yet.
72
+ *
73
+ * @param options.type The type of the list style. If `null` is specified, the function does nothing.
74
+ */
75
+ private _tryToConvertItemsToList;
76
+ }
@@ -0,0 +1,160 @@
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 list/listproperties/ui/listpropertiesview
11
+ */
12
+ import { View, ViewCollection, FocusCycler, SwitchButtonView, LabeledFieldView, CollapsibleView, type ButtonView, type InputNumberView, type FocusableView } from 'ckeditor5/src/ui.js';
13
+ import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils.js';
14
+ import type { NormalizedListPropertiesConfig } from '../utils/config.js';
15
+ import '../../../theme/listproperties.css';
16
+ /**
17
+ * The list properties view to be displayed in the list dropdown.
18
+ *
19
+ * Contains a grid of available list styles and, for numbered list, also the list start index and reversed fields.
20
+ *
21
+ * @internal
22
+ */
23
+ export default class ListPropertiesView extends View {
24
+ /**
25
+ * @inheritDoc
26
+ */
27
+ locale: Locale;
28
+ /**
29
+ * A collection of the child views.
30
+ */
31
+ readonly children: ViewCollection;
32
+ /**
33
+ * A view that renders the grid of list styles.
34
+ */
35
+ readonly stylesView: StylesView | null;
36
+ /**
37
+ * A collapsible view that hosts additional list property fields ({@link #startIndexFieldView} and
38
+ * {@link #reversedSwitchButtonView}) to visually separate them from the {@link #stylesView grid of styles}.
39
+ *
40
+ * **Note**: Only present when:
41
+ * * the view represents **numbered** list properties,
42
+ * * and the {@link #stylesView} is rendered,
43
+ * * and either {@link #startIndexFieldView} or {@link #reversedSwitchButtonView} is rendered.
44
+ *
45
+ * @readonly
46
+ */
47
+ additionalPropertiesCollapsibleView: CollapsibleView | null;
48
+ /**
49
+ * A labeled number field allowing the user to set the start index of the list.
50
+ *
51
+ * **Note**: Only present when the view represents **numbered** list properties.
52
+ *
53
+ * @readonly
54
+ */
55
+ startIndexFieldView: LabeledFieldView<InputNumberView> | null;
56
+ /**
57
+ * A switch button allowing the user to make the edited list reversed.
58
+ *
59
+ * **Note**: Only present when the view represents **numbered** list properties.
60
+ *
61
+ * @readonly
62
+ */
63
+ reversedSwitchButtonView: SwitchButtonView | null;
64
+ /**
65
+ * Tracks information about the DOM focus in the view.
66
+ */
67
+ readonly focusTracker: FocusTracker;
68
+ /**
69
+ * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
70
+ */
71
+ readonly keystrokes: KeystrokeHandler;
72
+ /**
73
+ * A collection of views that can be focused in the properties view.
74
+ */
75
+ readonly focusables: ViewCollection<FocusableView>;
76
+ /**
77
+ * Helps cycling over {@link #focusables} in the view.
78
+ */
79
+ readonly focusCycler: FocusCycler;
80
+ /**
81
+ * Creates an instance of the list properties view.
82
+ *
83
+ * @param locale The {@link module:core/editor/editor~Editor#locale} instance.
84
+ * @param options Options of the view.
85
+ * @param options.enabledProperties An object containing the configuration of enabled list property names.
86
+ * Allows conditional rendering the sub-components of the properties view.
87
+ * @param options.styleButtonViews A list of style buttons to be rendered
88
+ * inside the styles grid. The grid will not be rendered when `enabledProperties` does not include the `'styles'` key.
89
+ * @param options.styleGridAriaLabel An assistive technologies label set on the grid of styles (if the grid is rendered).
90
+ */
91
+ constructor(locale: Locale, { enabledProperties, styleButtonViews, styleGridAriaLabel }: {
92
+ enabledProperties: NormalizedListPropertiesConfig;
93
+ styleButtonViews: Array<ButtonView> | null;
94
+ styleGridAriaLabel: string;
95
+ });
96
+ /**
97
+ * @inheritDoc
98
+ */
99
+ render(): void;
100
+ /**
101
+ * @inheritDoc
102
+ */
103
+ focus(): void;
104
+ /**
105
+ * @inheritDoc
106
+ */
107
+ focusLast(): void;
108
+ /**
109
+ * @inheritDoc
110
+ */
111
+ destroy(): void;
112
+ /**
113
+ * Creates the list styles grid.
114
+ *
115
+ * @param styleButtons Buttons to be placed in the grid.
116
+ * @param styleGridAriaLabel The assistive technology label of the grid.
117
+ */
118
+ private _createStylesView;
119
+ /**
120
+ * Renders {@link #startIndexFieldView} and/or {@link #reversedSwitchButtonView} depending on the configuration of the properties view.
121
+ *
122
+ * @param enabledProperties An object containing the configuration of enabled list property names
123
+ * (see {@link #constructor}).
124
+ */
125
+ private _addNumberedListPropertyViews;
126
+ /**
127
+ * Creates the list start index labeled field.
128
+ */
129
+ private _createStartIndexField;
130
+ /**
131
+ * Creates the reversed list switch button.
132
+ */
133
+ private _createReversedSwitchButton;
134
+ }
135
+ export type StylesView = View & {
136
+ children: ViewCollection;
137
+ focusTracker: FocusTracker;
138
+ keystrokes: KeystrokeHandler;
139
+ focus(): void;
140
+ };
141
+ /**
142
+ * Fired when the list start index value has changed via {@link ~ListPropertiesView#startIndexFieldView}.
143
+ *
144
+ * @eventName ~ListPropertiesView#listStart
145
+ */
146
+ export type ListPropertiesViewListStartEvent = {
147
+ name: 'listStart';
148
+ args: [data: {
149
+ startIndex: number;
150
+ }];
151
+ };
152
+ /**
153
+ * Fired when the list order has changed (reversed) via {@link ~ListPropertiesView#reversedSwitchButtonView}.
154
+ *
155
+ * @eventName ~ListPropertiesView#listReversed
156
+ */
157
+ export type ListPropertiesViewListReversedEvent = {
158
+ name: 'listReversed';
159
+ args: [];
160
+ };
@@ -0,0 +1,39 @@
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 { ListPropertiesConfig, ListPropertiesStyleListType } from '../../listconfig.js';
10
+ /**
11
+ * Normalizes {@link module:list/listconfig~ListPropertiesConfig} in the configuration of the list properties feature.
12
+ * The structure of normalized list properties options looks as follows:
13
+ *
14
+ * ```ts
15
+ * {
16
+ * styles: {
17
+ * listTypes: [ 'bulleted', 'numbered' ],
18
+ * useAttribute: false
19
+ * },
20
+ * startIndex: true,
21
+ * reversed: true
22
+ * }
23
+ * ```
24
+ *
25
+ * @param config The list properties {@link module:list/listconfig~ListPropertiesConfig config}.
26
+ * @returns An object with normalized list properties options.
27
+ */
28
+ export declare function getNormalizedConfig(config: ListPropertiesConfig): NormalizedListPropertiesConfig;
29
+ /**
30
+ * Normalized list properties config.
31
+ */
32
+ export type NormalizedListPropertiesConfig = {
33
+ styles: {
34
+ listTypes: Array<ListPropertiesStyleListType>;
35
+ useAttribute: boolean;
36
+ };
37
+ startIndex: boolean;
38
+ reversed: boolean;
39
+ };
@@ -0,0 +1,24 @@
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
+ * Gets all the style types supported by given list type.
11
+ */
12
+ export declare function getAllSupportedStyleTypes(): Array<string>;
13
+ /**
14
+ * Checks whether the given list-style-type is supported by numbered or bulleted list.
15
+ */
16
+ export declare function getListTypeFromListStyleType(listStyleType: string): 'bulleted' | 'numbered' | null;
17
+ /**
18
+ * Converts `type` attribute of `<ul>` or `<ol>` elements to `list-style-type` equivalent.
19
+ */
20
+ export declare function getListStyleTypeFromTypeAttribute(value: string): string | null;
21
+ /**
22
+ * Converts `list-style-type` style to `type` attribute of `<ul>` or `<ol>` elements.
23
+ */
24
+ export declare function getTypeAttributeFromListStyleType(value: string): string | null;
@@ -0,0 +1,35 @@
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 list/listproperties
11
+ */
12
+ import { Plugin } from 'ckeditor5/src/core.js';
13
+ import ListPropertiesEditing from './listproperties/listpropertiesediting.js';
14
+ import ListPropertiesUI from './listproperties/listpropertiesui.js';
15
+ /**
16
+ * The list properties feature.
17
+ *
18
+ * This is a "glue" plugin that loads the
19
+ * {@link module:list/listproperties/listpropertiesediting~ListPropertiesEditing list properties
20
+ * editing feature} and the {@link module:list/listproperties/listpropertiesui~ListPropertiesUI list properties UI feature}.
21
+ */
22
+ export default class ListProperties extends Plugin {
23
+ /**
24
+ * @inheritDoc
25
+ */
26
+ static get requires(): readonly [typeof ListPropertiesEditing, typeof ListPropertiesUI];
27
+ /**
28
+ * @inheritDoc
29
+ */
30
+ static get pluginName(): "ListProperties";
31
+ /**
32
+ * @inheritDoc
33
+ */
34
+ static get isOfficialPlugin(): true;
35
+ }
@@ -0,0 +1,36 @@
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 list/tododocumentlist
11
+ */
12
+ import { Plugin, type Editor } from 'ckeditor5/src/core.js';
13
+ import TodoList from './todolist.js';
14
+ /**
15
+ * The to-do list feature.
16
+ *
17
+ * This is an obsolete plugin that exists for backward compatibility only.
18
+ * Use the {@link module:list/todolist~TodoList `TodoList`} instead.
19
+ *
20
+ * @deprecated
21
+ */
22
+ export default class TodoDocumentList extends Plugin {
23
+ /**
24
+ * @inheritDoc
25
+ */
26
+ static get requires(): readonly [typeof TodoList];
27
+ /**
28
+ * @inheritDoc
29
+ */
30
+ static get pluginName(): "TodoDocumentList";
31
+ /**
32
+ * @inheritDoc
33
+ */
34
+ static get isOfficialPlugin(): true;
35
+ constructor(editor: Editor);
36
+ }
@@ -0,0 +1,53 @@
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 list/todolist/checktodolistcommand
11
+ */
12
+ import { Command, type Editor } from 'ckeditor5/src/core.js';
13
+ /**
14
+ * The check to-do command.
15
+ *
16
+ * The command is registered by the {@link module:list/todolist/todolistediting~TodoListEditing} as
17
+ * the `checkTodoList` editor command.
18
+ */
19
+ export default class CheckTodoListCommand extends Command {
20
+ /**
21
+ * A list of to-do list items selected by the {@link module:engine/model/selection~Selection}.
22
+ *
23
+ * @observable
24
+ * @readonly
25
+ */
26
+ value: boolean;
27
+ /**
28
+ * @inheritDoc
29
+ */
30
+ constructor(editor: Editor);
31
+ /**
32
+ * Updates the command's {@link #value} and {@link #isEnabled} properties based on the current selection.
33
+ */
34
+ refresh(): void;
35
+ /**
36
+ * Executes the command.
37
+ *
38
+ * @param options.forceValue If set, it will force the command behavior. If `true`, the command will apply
39
+ * the attribute. Otherwise, the command will remove the attribute. If not set, the command will look for its current
40
+ * value to decide what it should do.
41
+ */
42
+ execute(options?: {
43
+ forceValue?: boolean;
44
+ }): void;
45
+ /**
46
+ * Returns a value for the command.
47
+ */
48
+ private _getValue;
49
+ /**
50
+ * Gets all to-do list items selected by the {@link module:engine/model/selection~Selection}.
51
+ */
52
+ private _getSelectedItems;
53
+ }
@@ -0,0 +1,45 @@
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 list/todolist/todocheckboxchangeobserver
11
+ */
12
+ import { DomEventObserver, type DomEventData } from 'ckeditor5/src/engine.js';
13
+ /**
14
+ * Observes all to-do list checkboxes state changes.
15
+ *
16
+ * Note that this observer is not available by default. To make it available it needs to be added to
17
+ * {@link module:engine/view/view~View} by {@link module:engine/view/view~View#addObserver} method.
18
+ */
19
+ export default class TodoCheckboxChangeObserver extends DomEventObserver<'change'> {
20
+ /**
21
+ * @inheritDoc
22
+ */
23
+ readonly domEventType: readonly ["change"];
24
+ /**
25
+ * @inheritDoc
26
+ */
27
+ onDomEvent(domEvent: Event): void;
28
+ }
29
+ /**
30
+ * Fired when the to-do list checkbox is toggled.
31
+ *
32
+ * Introduced by {@link module:list/todolist/todocheckboxchangeobserver~TodoCheckboxChangeObserver}.
33
+ *
34
+ * Note that this event is not available by default. To make it available,
35
+ * {@link module:list/todolist/todocheckboxchangeobserver~TodoCheckboxChangeObserver}
36
+ * needs to be added to {@link module:engine/view/view~View} by the {@link module:engine/view/view~View#addObserver} method.
37
+ *
38
+ * @see module:list/todolist/todocheckboxchangeobserver~TodoCheckboxChangeObserver
39
+ * @eventName module:engine/view/document~Document#todoCheckboxChange
40
+ * @param data The event data.
41
+ */
42
+ export type ViewDocumentTodoCheckboxChangeEvent = {
43
+ name: 'todoCheckboxChange';
44
+ args: [data: DomEventData<Event>];
45
+ };
@@ -0,0 +1,53 @@
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 { Plugin } from 'ckeditor5/src/core.js';
10
+ import ListEditing from '../list/listediting.js';
11
+ /**
12
+ * The engine of the to-do list feature. It handles creating, editing and removing to-do lists and their items.
13
+ *
14
+ * It registers the entire functionality of the {@link module:list/list/listediting~ListEditing list editing plugin}
15
+ * and extends it with the commands:
16
+ *
17
+ * - `'todoList'`,
18
+ * - `'checkTodoList'`,
19
+ */
20
+ export default class TodoListEditing extends Plugin {
21
+ /**
22
+ * @inheritDoc
23
+ */
24
+ static get pluginName(): "TodoListEditing";
25
+ /**
26
+ * @inheritDoc
27
+ */
28
+ static get isOfficialPlugin(): true;
29
+ /**
30
+ * @inheritDoc
31
+ */
32
+ static get requires(): readonly [typeof ListEditing];
33
+ /**
34
+ * @inheritDoc
35
+ */
36
+ init(): void;
37
+ /**
38
+ * Handles the checkbox element change, moves the selection to the corresponding model item to make it possible
39
+ * to toggle the `todoListChecked` attribute using the command, and restores the selection position.
40
+ *
41
+ * Some say it's a hack :) Moving the selection only for executing the command on a certain node and restoring it after,
42
+ * is not a clear solution. We need to design an API for using commands beyond the selection range.
43
+ * See https://github.com/ckeditor/ckeditor5/issues/1954.
44
+ */
45
+ private _handleCheckmarkChange;
46
+ /**
47
+ * Observe when user enters or leaves todo list and set proper aria value in global live announcer.
48
+ * This allows screen readers to indicate when the user has entered and left the specified todo list.
49
+ *
50
+ * @internal
51
+ */
52
+ private _initAriaAnnouncements;
53
+ }