@ckeditor/ckeditor5-comments 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.
- package/LICENSE.md +1 -2
- package/README.md +1 -1
- package/build/comments.js +2 -2
- package/dist/index-content.css +2 -2
- package/dist/index-editor.css +2 -2
- package/dist/index.css +15 -15
- package/dist/index.js +10 -10
- package/dist/translations/af.d.ts +2 -2
- package/dist/translations/af.js +2 -2
- package/dist/translations/af.umd.js +2 -2
- package/dist/translations/ar.d.ts +2 -2
- package/dist/translations/ar.js +2 -2
- package/dist/translations/ar.umd.js +2 -2
- package/dist/translations/ast.d.ts +2 -2
- package/dist/translations/ast.js +2 -2
- package/dist/translations/ast.umd.js +2 -2
- package/dist/translations/az.d.ts +2 -2
- package/dist/translations/az.js +2 -2
- package/dist/translations/az.umd.js +2 -2
- package/dist/translations/bg.d.ts +2 -2
- package/dist/translations/bg.js +2 -2
- package/dist/translations/bg.umd.js +2 -2
- package/dist/translations/bn.d.ts +2 -2
- package/dist/translations/bn.js +2 -2
- package/dist/translations/bn.umd.js +2 -2
- package/dist/translations/bs.d.ts +2 -2
- package/dist/translations/bs.js +2 -2
- package/dist/translations/bs.umd.js +2 -2
- package/dist/translations/ca.d.ts +2 -2
- package/dist/translations/ca.js +2 -2
- package/dist/translations/ca.umd.js +2 -2
- package/dist/translations/cs.d.ts +2 -2
- package/dist/translations/cs.js +2 -2
- package/dist/translations/cs.umd.js +2 -2
- package/dist/translations/da.d.ts +2 -2
- package/dist/translations/da.js +2 -2
- package/dist/translations/da.umd.js +2 -2
- package/dist/translations/de-ch.d.ts +2 -2
- package/dist/translations/de-ch.js +2 -2
- package/dist/translations/de-ch.umd.js +2 -2
- package/dist/translations/de.d.ts +2 -2
- package/dist/translations/de.js +2 -2
- package/dist/translations/de.umd.js +2 -2
- package/dist/translations/el.d.ts +2 -2
- package/dist/translations/el.js +2 -2
- package/dist/translations/el.umd.js +2 -2
- package/dist/translations/en-au.d.ts +2 -2
- package/dist/translations/en-au.js +2 -2
- package/dist/translations/en-au.umd.js +2 -2
- package/dist/translations/en-gb.d.ts +2 -2
- package/dist/translations/en-gb.js +2 -2
- package/dist/translations/en-gb.umd.js +2 -2
- package/dist/translations/en.d.ts +2 -2
- package/dist/translations/en.js +2 -2
- package/dist/translations/en.umd.js +2 -2
- package/dist/translations/eo.d.ts +2 -2
- package/dist/translations/eo.js +2 -2
- package/dist/translations/eo.umd.js +2 -2
- package/dist/translations/es-co.d.ts +2 -2
- package/dist/translations/es-co.js +2 -2
- package/dist/translations/es-co.umd.js +2 -2
- package/dist/translations/es.d.ts +2 -2
- package/dist/translations/es.js +2 -2
- package/dist/translations/es.umd.js +2 -2
- package/dist/translations/et.d.ts +2 -2
- package/dist/translations/et.js +2 -2
- package/dist/translations/et.umd.js +2 -2
- package/dist/translations/eu.d.ts +2 -2
- package/dist/translations/eu.js +2 -2
- package/dist/translations/eu.umd.js +2 -2
- package/dist/translations/fa.d.ts +2 -2
- package/dist/translations/fa.js +2 -2
- package/dist/translations/fa.umd.js +2 -2
- package/dist/translations/fi.d.ts +2 -2
- package/dist/translations/fi.js +2 -2
- package/dist/translations/fi.umd.js +2 -2
- package/dist/translations/fr.d.ts +2 -2
- package/dist/translations/fr.js +2 -2
- package/dist/translations/fr.umd.js +2 -2
- package/dist/translations/gl.d.ts +2 -2
- package/dist/translations/gl.js +2 -2
- package/dist/translations/gl.umd.js +2 -2
- package/dist/translations/gu.d.ts +2 -2
- package/dist/translations/gu.js +2 -2
- package/dist/translations/gu.umd.js +2 -2
- package/dist/translations/he.d.ts +2 -2
- package/dist/translations/he.js +2 -2
- package/dist/translations/he.umd.js +2 -2
- package/dist/translations/hi.d.ts +2 -2
- package/dist/translations/hi.js +2 -2
- package/dist/translations/hi.umd.js +2 -2
- package/dist/translations/hr.d.ts +2 -2
- package/dist/translations/hr.js +2 -2
- package/dist/translations/hr.umd.js +2 -2
- package/dist/translations/hu.d.ts +2 -2
- package/dist/translations/hu.js +2 -2
- package/dist/translations/hu.umd.js +2 -2
- package/dist/translations/hy.d.ts +2 -2
- package/dist/translations/hy.js +2 -2
- package/dist/translations/hy.umd.js +2 -2
- package/dist/translations/id.d.ts +2 -2
- package/dist/translations/id.js +2 -2
- package/dist/translations/id.umd.js +2 -2
- package/dist/translations/it.d.ts +2 -2
- package/dist/translations/it.js +2 -2
- package/dist/translations/it.umd.js +2 -2
- package/dist/translations/ja.d.ts +2 -2
- package/dist/translations/ja.js +2 -2
- package/dist/translations/ja.umd.js +2 -2
- package/dist/translations/jv.d.ts +2 -2
- package/dist/translations/jv.js +2 -2
- package/dist/translations/jv.umd.js +2 -2
- package/dist/translations/kk.d.ts +2 -2
- package/dist/translations/kk.js +2 -2
- package/dist/translations/kk.umd.js +2 -2
- package/dist/translations/km.d.ts +2 -2
- package/dist/translations/km.js +2 -2
- package/dist/translations/km.umd.js +2 -2
- package/dist/translations/kn.d.ts +2 -2
- package/dist/translations/kn.js +2 -2
- package/dist/translations/kn.umd.js +2 -2
- package/dist/translations/ko.d.ts +2 -2
- package/dist/translations/ko.js +2 -2
- package/dist/translations/ko.umd.js +2 -2
- package/dist/translations/ku.d.ts +2 -2
- package/dist/translations/ku.js +2 -2
- package/dist/translations/ku.umd.js +2 -2
- package/dist/translations/lt.d.ts +2 -2
- package/dist/translations/lt.js +2 -2
- package/dist/translations/lt.umd.js +2 -2
- package/dist/translations/lv.d.ts +2 -2
- package/dist/translations/lv.js +2 -2
- package/dist/translations/lv.umd.js +2 -2
- package/dist/translations/ms.d.ts +2 -2
- package/dist/translations/ms.js +2 -2
- package/dist/translations/ms.umd.js +2 -2
- package/dist/translations/nb.d.ts +2 -2
- package/dist/translations/nb.js +2 -2
- package/dist/translations/nb.umd.js +2 -2
- package/dist/translations/ne.d.ts +2 -2
- package/dist/translations/ne.js +2 -2
- package/dist/translations/ne.umd.js +2 -2
- package/dist/translations/nl.d.ts +2 -2
- package/dist/translations/nl.js +2 -2
- package/dist/translations/nl.umd.js +2 -2
- package/dist/translations/no.d.ts +2 -2
- package/dist/translations/no.js +2 -2
- package/dist/translations/no.umd.js +2 -2
- package/dist/translations/oc.d.ts +2 -2
- package/dist/translations/oc.js +2 -2
- package/dist/translations/oc.umd.js +2 -2
- package/dist/translations/pl.d.ts +2 -2
- package/dist/translations/pl.js +2 -2
- package/dist/translations/pl.umd.js +2 -2
- package/dist/translations/pt-br.d.ts +2 -2
- package/dist/translations/pt-br.js +2 -2
- package/dist/translations/pt-br.umd.js +2 -2
- package/dist/translations/pt.d.ts +2 -2
- package/dist/translations/pt.js +2 -2
- package/dist/translations/pt.umd.js +2 -2
- package/dist/translations/ro.d.ts +2 -2
- package/dist/translations/ro.js +2 -2
- package/dist/translations/ro.umd.js +2 -2
- package/dist/translations/ru.d.ts +2 -2
- package/dist/translations/ru.js +2 -2
- package/dist/translations/ru.umd.js +2 -2
- package/dist/translations/si.d.ts +2 -2
- package/dist/translations/si.js +2 -2
- package/dist/translations/si.umd.js +2 -2
- package/dist/translations/sk.d.ts +2 -2
- package/dist/translations/sk.js +2 -2
- package/dist/translations/sk.umd.js +2 -2
- package/dist/translations/sl.d.ts +2 -2
- package/dist/translations/sl.js +2 -2
- package/dist/translations/sl.umd.js +2 -2
- package/dist/translations/sq.d.ts +2 -2
- package/dist/translations/sq.js +2 -2
- package/dist/translations/sq.umd.js +2 -2
- package/dist/translations/sr-latn.d.ts +2 -2
- package/dist/translations/sr-latn.js +2 -2
- package/dist/translations/sr-latn.umd.js +2 -2
- package/dist/translations/sr.d.ts +2 -2
- package/dist/translations/sr.js +2 -2
- package/dist/translations/sr.umd.js +2 -2
- package/dist/translations/sv.d.ts +2 -2
- package/dist/translations/sv.js +2 -2
- package/dist/translations/sv.umd.js +2 -2
- package/dist/translations/th.d.ts +2 -2
- package/dist/translations/th.js +2 -2
- package/dist/translations/th.umd.js +2 -2
- package/dist/translations/ti.d.ts +2 -2
- package/dist/translations/ti.js +2 -2
- package/dist/translations/ti.umd.js +2 -2
- package/dist/translations/tk.d.ts +2 -2
- package/dist/translations/tk.js +2 -2
- package/dist/translations/tk.umd.js +2 -2
- package/dist/translations/tr.d.ts +2 -2
- package/dist/translations/tr.js +2 -2
- package/dist/translations/tr.umd.js +2 -2
- package/dist/translations/tt.d.ts +2 -2
- package/dist/translations/tt.js +2 -2
- package/dist/translations/tt.umd.js +2 -2
- package/dist/translations/ug.d.ts +2 -2
- package/dist/translations/ug.js +2 -2
- package/dist/translations/ug.umd.js +2 -2
- package/dist/translations/uk.d.ts +2 -2
- package/dist/translations/uk.js +2 -2
- package/dist/translations/uk.umd.js +2 -2
- package/dist/translations/ur.d.ts +2 -2
- package/dist/translations/ur.js +2 -2
- package/dist/translations/ur.umd.js +2 -2
- package/dist/translations/uz.d.ts +2 -2
- package/dist/translations/uz.js +2 -2
- package/dist/translations/uz.umd.js +2 -2
- package/dist/translations/vi.d.ts +2 -2
- package/dist/translations/vi.js +2 -2
- package/dist/translations/vi.umd.js +2 -2
- package/dist/translations/zh-cn.d.ts +2 -2
- package/dist/translations/zh-cn.js +2 -2
- package/dist/translations/zh-cn.umd.js +2 -2
- package/dist/translations/zh.d.ts +2 -2
- package/dist/translations/zh.js +2 -2
- package/dist/translations/zh.umd.js +2 -2
- package/lang/translations/af.po +1 -1
- package/lang/translations/ar.po +1 -1
- package/lang/translations/ast.po +1 -1
- package/lang/translations/az.po +1 -1
- package/lang/translations/bg.po +1 -1
- package/lang/translations/bn.po +1 -1
- package/lang/translations/bs.po +1 -1
- package/lang/translations/ca.po +1 -1
- package/lang/translations/cs.po +1 -1
- package/lang/translations/da.po +1 -1
- package/lang/translations/de-ch.po +1 -1
- package/lang/translations/de.po +1 -1
- package/lang/translations/el.po +1 -1
- package/lang/translations/en-au.po +1 -1
- package/lang/translations/en-gb.po +1 -1
- package/lang/translations/en.po +1 -1
- package/lang/translations/eo.po +1 -1
- package/lang/translations/es-co.po +1 -1
- package/lang/translations/es.po +1 -1
- package/lang/translations/et.po +1 -1
- package/lang/translations/eu.po +1 -1
- package/lang/translations/fa.po +1 -1
- package/lang/translations/fi.po +1 -1
- package/lang/translations/fr.po +1 -1
- package/lang/translations/gl.po +1 -1
- package/lang/translations/gu.po +1 -1
- package/lang/translations/he.po +1 -1
- package/lang/translations/hi.po +1 -1
- package/lang/translations/hr.po +1 -1
- package/lang/translations/hu.po +1 -1
- package/lang/translations/hy.po +1 -1
- package/lang/translations/id.po +1 -1
- package/lang/translations/it.po +1 -1
- package/lang/translations/ja.po +1 -1
- package/lang/translations/jv.po +1 -1
- package/lang/translations/kk.po +1 -1
- package/lang/translations/km.po +1 -1
- package/lang/translations/kn.po +1 -1
- package/lang/translations/ko.po +1 -1
- package/lang/translations/ku.po +1 -1
- package/lang/translations/lt.po +1 -1
- package/lang/translations/lv.po +1 -1
- package/lang/translations/ms.po +1 -1
- package/lang/translations/nb.po +1 -1
- package/lang/translations/ne.po +1 -1
- package/lang/translations/nl.po +1 -1
- package/lang/translations/no.po +1 -1
- package/lang/translations/oc.po +1 -1
- package/lang/translations/pl.po +1 -1
- package/lang/translations/pt-br.po +1 -1
- package/lang/translations/pt.po +1 -1
- package/lang/translations/ro.po +1 -1
- package/lang/translations/ru.po +1 -1
- package/lang/translations/si.po +1 -1
- package/lang/translations/sk.po +1 -1
- package/lang/translations/sl.po +1 -1
- package/lang/translations/sq.po +1 -1
- package/lang/translations/sr-latn.po +1 -1
- package/lang/translations/sr.po +1 -1
- package/lang/translations/sv.po +1 -1
- package/lang/translations/th.po +1 -1
- package/lang/translations/ti.po +1 -1
- package/lang/translations/tk.po +1 -1
- package/lang/translations/tr.po +1 -1
- package/lang/translations/tt.po +1 -1
- package/lang/translations/ug.po +1 -1
- package/lang/translations/uk.po +1 -1
- package/lang/translations/ur.po +1 -1
- package/lang/translations/uz.po +1 -1
- package/lang/translations/vi.po +1 -1
- package/lang/translations/zh-cn.po +1 -1
- package/lang/translations/zh.po +1 -1
- package/package.json +39 -16
- package/src/annotations/annotation.d.ts +1 -1
- package/src/annotations/annotation.js +3 -3
- package/src/annotations/annotationcollection.d.ts +1 -1
- package/src/annotations/annotationcollection.js +2 -2
- package/src/annotations/annotations.d.ts +1 -1
- package/src/annotations/annotations.js +2 -2
- package/src/annotations/annotationsuis.d.ts +2 -2
- package/src/annotations/annotationsuis.js +2 -2
- package/src/annotations/editorannotations.d.ts +1 -1
- package/src/annotations/editorannotations.js +2 -2
- package/src/annotations/inlineannotations.d.ts +1 -1
- package/src/annotations/inlineannotations.js +2 -2
- package/src/annotations/narrowsidebar.d.ts +1 -1
- package/src/annotations/narrowsidebar.js +2 -2
- package/src/annotations/sidebar.d.ts +1 -1
- package/src/annotations/sidebar.js +2 -2
- package/src/annotations/view/annotationcounterbuttonview.d.ts +1 -1
- package/src/annotations/view/annotationcounterbuttonview.js +2 -2
- package/src/annotations/view/annotationview.d.ts +1 -1
- package/src/annotations/view/annotationview.js +2 -2
- package/src/annotations/view/sidebaritemview.d.ts +1 -1
- package/src/annotations/view/sidebaritemview.js +2 -2
- package/src/annotations/view/sidebarview.d.ts +1 -1
- package/src/annotations/view/sidebarview.js +2 -2
- package/src/annotations/widesidebar.d.ts +1 -1
- package/src/annotations/widesidebar.js +2 -2
- package/src/augmentation.d.ts +1 -1
- package/src/augmentation.js +1 -1
- package/src/comments/addcommentthreadcommand.d.ts +1 -1
- package/src/comments/addcommentthreadcommand.js +2 -2
- package/src/comments/commentsarchive.d.ts +1 -1
- package/src/comments/commentsarchive.js +2 -2
- package/src/comments/commentsarchiveui.d.ts +1 -1
- package/src/comments/commentsarchiveui.js +2 -2
- package/src/comments/commentsediting.d.ts +1 -1
- package/src/comments/commentsediting.js +2 -2
- package/src/comments/commentsrepository.d.ts +1 -1
- package/src/comments/commentsrepository.js +4 -4
- package/src/comments/commentsui.d.ts +1 -1
- package/src/comments/commentsui.js +2 -2
- package/src/comments/integrations/clipboard.d.ts +1 -1
- package/src/comments/integrations/clipboard.js +2 -2
- package/src/comments/integrations/commentsrestrictededitingmode.d.ts +1 -1
- package/src/comments/integrations/commentsrestrictededitingmode.js +2 -2
- package/src/comments/integrations/importword.d.ts +1 -1
- package/src/comments/integrations/importword.js +2 -2
- package/src/comments/integrations/showcommenthighlights.d.ts +1 -1
- package/src/comments/integrations/showcommenthighlights.js +2 -2
- package/src/comments/ui/commenteditor/commenteditor.d.ts +1 -1
- package/src/comments/ui/commenteditor/commenteditor.js +3 -3
- package/src/comments/ui/commenteditor/commenteditorui.d.ts +1 -1
- package/src/comments/ui/commenteditor/commenteditorui.js +2 -2
- package/src/comments/ui/commenteditor/commenteditoruiview.d.ts +1 -1
- package/src/comments/ui/commenteditor/commenteditoruiview.js +2 -2
- package/src/comments/ui/commentthreadcontroller.d.ts +1 -1
- package/src/comments/ui/commentthreadcontroller.js +3 -3
- package/src/comments/ui/view/basecommentthreadview.d.ts +1 -1
- package/src/comments/ui/view/basecommentthreadview.js +2 -2
- package/src/comments/ui/view/basecommentview.d.ts +1 -1
- package/src/comments/ui/view/basecommentview.js +2 -2
- package/src/comments/ui/view/collapsedcommentsview.d.ts +1 -1
- package/src/comments/ui/view/collapsedcommentsview.js +2 -2
- package/src/comments/ui/view/commentcontentview.d.ts +1 -1
- package/src/comments/ui/view/commentcontentview.js +2 -2
- package/src/comments/ui/view/commentinputview.d.ts +1 -1
- package/src/comments/ui/view/commentinputview.js +2 -2
- package/src/comments/ui/view/commentsarchiveview.d.ts +1 -1
- package/src/comments/ui/view/commentsarchiveview.js +2 -2
- package/src/comments/ui/view/commentslistview.d.ts +1 -1
- package/src/comments/ui/view/commentslistview.js +2 -2
- package/src/comments/ui/view/commentthreadheadercontextview.d.ts +1 -1
- package/src/comments/ui/view/commentthreadheadercontextview.js +2 -2
- package/src/comments/ui/view/commentthreadheaderview.d.ts +1 -1
- package/src/comments/ui/view/commentthreadheaderview.js +2 -2
- package/src/comments/ui/view/commentthreadinputview.d.ts +1 -1
- package/src/comments/ui/view/commentthreadinputview.js +2 -2
- package/src/comments/ui/view/commentthreadview.d.ts +1 -1
- package/src/comments/ui/view/commentthreadview.js +3 -3
- package/src/comments/ui/view/commentview.d.ts +1 -1
- package/src/comments/ui/view/commentview.js +3 -3
- package/src/comments.d.ts +1 -1
- package/src/comments.js +2 -2
- package/src/commentsonly.d.ts +1 -1
- package/src/commentsonly.js +2 -2
- package/src/config.d.ts +1 -1
- package/src/config.js +1 -1
- package/src/index.d.ts +2 -2
- package/src/index.js +2 -2
- package/src/utils/common-translations.d.ts +1 -1
- package/src/utils/common-translations.js +2 -2
- package/src/utils/createmutationobserver.d.ts +1 -1
- package/src/utils/createmutationobserver.js +2 -2
- package/theme/annotation-inline.css +1 -1
- package/theme/annotation.css +1 -1
- package/theme/comment.css +1 -1
- package/theme/commentinput.css +1 -1
- package/theme/commentmarker.css +1 -1
- package/theme/commentsarchive.css +1 -1
- package/theme/commentthread.css +1 -1
- package/theme/icons/add-comment.svg +1 -1
- package/theme/icons/comments-archive.svg +1 -1
- package/theme/icons/edit-comment.svg +1 -1
- package/theme/icons/remove-comment.svg +1 -1
- package/theme/sidebar-narrow.css +1 -1
- package/theme/sidebar.css +1 -1
- package/dist/annotations/annotation.d.ts +0 -101
- package/dist/annotations/annotationcollection.d.ts +0 -102
- package/dist/annotations/annotations.d.ts +0 -166
- package/dist/annotations/annotationsuis.d.ts +0 -244
- package/dist/annotations/editorannotations.d.ts +0 -79
- package/dist/annotations/inlineannotations.d.ts +0 -102
- package/dist/annotations/narrowsidebar.d.ts +0 -97
- package/dist/annotations/sidebar.d.ts +0 -112
- package/dist/annotations/view/annotationcounterbuttonview.d.ts +0 -33
- package/dist/annotations/view/annotationview.d.ts +0 -94
- package/dist/annotations/view/sidebaritemview.d.ts +0 -63
- package/dist/annotations/view/sidebarview.d.ts +0 -57
- package/dist/annotations/widesidebar.d.ts +0 -89
- package/dist/augmentation.d.ts +0 -63
- package/dist/comments/addcommentthreadcommand.d.ts +0 -39
- package/dist/comments/commentsarchive.d.ts +0 -43
- package/dist/comments/commentsarchiveui.d.ts +0 -57
- package/dist/comments/commentsediting.d.ts +0 -106
- package/dist/comments/commentsrepository.d.ts +0 -1137
- package/dist/comments/commentsui.d.ts +0 -49
- package/dist/comments/integrations/clipboard.d.ts +0 -30
- package/dist/comments/integrations/commentsrestrictededitingmode.d.ts +0 -21
- package/dist/comments/integrations/importword.d.ts +0 -25
- package/dist/comments/integrations/showcommenthighlights.d.ts +0 -23
- package/dist/comments/ui/commenteditor/commenteditor.d.ts +0 -40
- package/dist/comments/ui/commenteditor/commenteditorui.d.ts +0 -35
- package/dist/comments/ui/commenteditor/commenteditoruiview.d.ts +0 -40
- package/dist/comments/ui/commentthreadcontroller.d.ts +0 -68
- package/dist/comments/ui/view/basecommentthreadview.d.ts +0 -152
- package/dist/comments/ui/view/basecommentview.d.ts +0 -154
- package/dist/comments/ui/view/collapsedcommentsview.d.ts +0 -17
- package/dist/comments/ui/view/commentcontentview.d.ts +0 -18
- package/dist/comments/ui/view/commentinputview.d.ts +0 -105
- package/dist/comments/ui/view/commentsarchiveview.d.ts +0 -50
- package/dist/comments/ui/view/commentslistview.d.ts +0 -116
- package/dist/comments/ui/view/commentthreadheadercontextview.d.ts +0 -25
- package/dist/comments/ui/view/commentthreadheaderview.d.ts +0 -80
- package/dist/comments/ui/view/commentthreadinputview.d.ts +0 -60
- package/dist/comments/ui/view/commentthreadview.d.ts +0 -127
- package/dist/comments/ui/view/commentview.d.ts +0 -244
- package/dist/comments.d.ts +0 -47
- package/dist/commentsonly.d.ts +0 -45
- package/dist/config.d.ts +0 -199
- package/dist/index.d.ts +0 -33
- package/dist/utils/common-translations.d.ts +0 -13
- package/dist/utils/createmutationobserver.d.ts +0 -18
|
@@ -1,244 +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 comments/annotations/annotationsuis
|
|
11
|
-
* @publicApi
|
|
12
|
-
*/
|
|
13
|
-
import { ContextPlugin, type Plugin, type Editor, type Context } from 'ckeditor5/src/core.js';
|
|
14
|
-
import { type Emitter } from 'ckeditor5/src/utils.js';
|
|
15
|
-
import AnnotationCollection from './annotationcollection.js';
|
|
16
|
-
import Annotations from './annotations.js';
|
|
17
|
-
import type Annotation from './annotation.js';
|
|
18
|
-
/**
|
|
19
|
-
* A repository of annotations UIs.
|
|
20
|
-
*
|
|
21
|
-
* The main entry point for {@link module:comments/annotations/annotationsuis~AnnotationsUIs#register registering} UIs
|
|
22
|
-
* and activating the annotations UI(s), which display annotation views.
|
|
23
|
-
*
|
|
24
|
-
* To register a custom annotations UI use following code in the annotations UI plugin `init()` function:
|
|
25
|
-
*
|
|
26
|
-
* ```ts
|
|
27
|
-
* const annotationsUIs = editor.plugins.get( 'annotationsUIs' );
|
|
28
|
-
*
|
|
29
|
-
* annotationsUIs.register( customAnnotationsUIPlugin );
|
|
30
|
-
* ```
|
|
31
|
-
*
|
|
32
|
-
* Note that the custom annotations UI must implement {@link module:comments/annotations/annotationsuis~AnnotationsUI
|
|
33
|
-
* the `AnnotationsUI` interface}.
|
|
34
|
-
*
|
|
35
|
-
* To activate an annotations UI, use the {@link module:comments/annotations/annotationsuis~AnnotationsUIs#switchTo
|
|
36
|
-
* `switchTo( uiName )`} method. This method activates the given UI and deactivates all the other UIs.
|
|
37
|
-
* All annotations will be handled by the activated UI.
|
|
38
|
-
*
|
|
39
|
-
* It is also possible to activate multiple annotations UIs at the same time and make the UIs handle different sets of annotations.
|
|
40
|
-
* To do that, use the {@link module:comments/annotations/annotationsuis~AnnotationsUIs#activate `activate( uiName, filter )`} method.
|
|
41
|
-
*
|
|
42
|
-
* ```ts
|
|
43
|
-
* // Suggestions annotations are shown inline in a balloon:
|
|
44
|
-
* annotationsUIs.activate( 'inline', annotation => annotation.type.startsWith( 'suggestion' ) );
|
|
45
|
-
*
|
|
46
|
-
* // At the same time, comments annotations are shown in a sidebar:
|
|
47
|
-
* annotationsUIs.activate( 'wideSidebar', annotation => annotation.type === 'comment' );
|
|
48
|
-
* ```
|
|
49
|
-
*
|
|
50
|
-
* Limitations:
|
|
51
|
-
*
|
|
52
|
-
* * Some annotations UI plugins might collide with each other (like {@link module:comments/annotations/narrowsidebar~NarrowSidebar} and
|
|
53
|
-
* {@link module:comments/annotations/widesidebar~WideSidebar} that operates on the same sidebar). They cannot be activated at the same
|
|
54
|
-
* time.
|
|
55
|
-
* * It is not possible to display the same annotation in two different annotations UIs. In this scenario an error will be thrown.
|
|
56
|
-
*/
|
|
57
|
-
export default class AnnotationsUIs extends ContextPlugin {
|
|
58
|
-
/**
|
|
59
|
-
* A set of names of the active annotations UIs.
|
|
60
|
-
*
|
|
61
|
-
* To activate the annotations UI, use {@link module:comments/annotations/annotationsuis~AnnotationsUIs#activate}
|
|
62
|
-
* or {@link #switchTo} methods.
|
|
63
|
-
*/
|
|
64
|
-
activeUIs: Set<string>;
|
|
65
|
-
/**
|
|
66
|
-
* @inheritDoc
|
|
67
|
-
*/
|
|
68
|
-
static get requires(): readonly [typeof Annotations];
|
|
69
|
-
/**
|
|
70
|
-
* @inheritDoc
|
|
71
|
-
*/
|
|
72
|
-
static get pluginName(): "AnnotationsUIs";
|
|
73
|
-
/**
|
|
74
|
-
* @inheritDoc
|
|
75
|
-
*/
|
|
76
|
-
static get isOfficialPlugin(): true;
|
|
77
|
-
/**
|
|
78
|
-
* @inheritDoc
|
|
79
|
-
*/
|
|
80
|
-
static get isPremiumPlugin(): true;
|
|
81
|
-
/**
|
|
82
|
-
* @inheritDoc
|
|
83
|
-
*/
|
|
84
|
-
constructor(context: Context | Editor);
|
|
85
|
-
/**
|
|
86
|
-
* @inheritDoc
|
|
87
|
-
*/
|
|
88
|
-
init(): void;
|
|
89
|
-
/**
|
|
90
|
-
* Returns `true` if at least one registered UI is active.
|
|
91
|
-
*/
|
|
92
|
-
hasActive(): boolean;
|
|
93
|
-
/**
|
|
94
|
-
* Returns `true` if the given UI is active.
|
|
95
|
-
*/
|
|
96
|
-
isActive(uiName: string): boolean;
|
|
97
|
-
/**
|
|
98
|
-
* Activates an annotations UI.
|
|
99
|
-
*
|
|
100
|
-
* Note that the custom annotations UI should be {@link #register registered} before the activation.
|
|
101
|
-
*
|
|
102
|
-
* The `filter` parameter can be used to display on some of the annotations in the given annotations UI. Thanks to that,
|
|
103
|
-
* all annotations can be split into various annotations UIs.
|
|
104
|
-
*
|
|
105
|
-
* The `filter` function takes an {@link module:comments/annotations/annotation~Annotation} instance as the first and only parameter,
|
|
106
|
-
* and should return `true` if that annotation should be placed in the given annotations UI.
|
|
107
|
-
*
|
|
108
|
-
* @param uiName The name of the annotations UI to activate.
|
|
109
|
-
* @param filter The annotation filter function. If not specified, the UI will use all annotations.
|
|
110
|
-
*/
|
|
111
|
-
activate(uiName: string, filter?: () => boolean): void;
|
|
112
|
-
/**
|
|
113
|
-
* Deactivates annotations UI with given name.
|
|
114
|
-
*
|
|
115
|
-
* @param uiName The name of the annotations UI to deactivate.
|
|
116
|
-
*/
|
|
117
|
-
deactivate(uiName: string): void;
|
|
118
|
-
/**
|
|
119
|
-
* Switches the annotations UI to the one with given name.
|
|
120
|
-
*
|
|
121
|
-
* It preserves the currently active annotation.
|
|
122
|
-
*
|
|
123
|
-
* @param uiName The name of the annotations UI to switch to.
|
|
124
|
-
*/
|
|
125
|
-
switchTo(uiName: string): void;
|
|
126
|
-
/**
|
|
127
|
-
* Deactivates all annotations UIs.
|
|
128
|
-
*/
|
|
129
|
-
deactivateAll(): void;
|
|
130
|
-
/**
|
|
131
|
-
* Registers an annotations UI. It might be one of:
|
|
132
|
-
*
|
|
133
|
-
* * {@link module:comments/annotations/widesidebar~WideSidebar},
|
|
134
|
-
* * {@link module:comments/annotations/narrowsidebar~NarrowSidebar},
|
|
135
|
-
* * {@link module:comments/annotations/inlineannotations~InlineAnnotations}.
|
|
136
|
-
*
|
|
137
|
-
* It is possible to provide your own, custom annotations UI plugin. It has to implement
|
|
138
|
-
* {@link module:comments/annotations/annotationsuis~AnnotationsUI the `AnnotationsUI` interface}.
|
|
139
|
-
*
|
|
140
|
-
* @param uiName Annotations UI name.
|
|
141
|
-
* @param annotationsUI Annotations UI plugin instance.
|
|
142
|
-
*/
|
|
143
|
-
register(uiName: string, annotationsUI: AnnotationsUI<ContextPlugin | Plugin>): void;
|
|
144
|
-
/**
|
|
145
|
-
* Refilters annotations to proper UIs based on filters provided earlier during the
|
|
146
|
-
* {@link module:comments/annotations/annotationsuis~AnnotationsUIs#activate annotations UIs activation}.
|
|
147
|
-
*
|
|
148
|
-
* This method should be used if the annotations UIs filtering functions return different results than before
|
|
149
|
-
* for some annotations. It only reattaches these annotations, which should change their UIs.
|
|
150
|
-
*/
|
|
151
|
-
refilterAnnotations(): void;
|
|
152
|
-
/**
|
|
153
|
-
* @inheritDoc
|
|
154
|
-
*/
|
|
155
|
-
destroy(): void;
|
|
156
|
-
}
|
|
157
|
-
/**
|
|
158
|
-
* An interface for the annotations UI plugin class.
|
|
159
|
-
*
|
|
160
|
-
* The annotations UI class handles displaying, focusing, activating and hiding annotations views.
|
|
161
|
-
*
|
|
162
|
-
* The annotations UI class must be a plugin, so it has to extend the {@link module:core/plugin~Plugin} or
|
|
163
|
-
* {@link module:core/contextplugin~ContextPlugin} class.
|
|
164
|
-
*
|
|
165
|
-
* Examples of `AnnotationsUI` are:
|
|
166
|
-
*
|
|
167
|
-
* * {@link module:comments/annotations/widesidebar~WideSidebar},
|
|
168
|
-
* * {@link module:comments/annotations/narrowsidebar~NarrowSidebar},
|
|
169
|
-
* * {@link module:comments/annotations/inlineannotations~InlineAnnotations}.
|
|
170
|
-
*
|
|
171
|
-
* You can use the following snippet as a base for your own annotations UI:
|
|
172
|
-
*
|
|
173
|
-
* ```ts
|
|
174
|
-
* class MyAnnotationsUI extends ContextPlugin {
|
|
175
|
-
* constructor( ...args ) {
|
|
176
|
-
* super( ...args );
|
|
177
|
-
*
|
|
178
|
-
* this.set( 'activeAnnotation', null );
|
|
179
|
-
* }
|
|
180
|
-
*
|
|
181
|
-
* attach( annotations ) {
|
|
182
|
-
* // Do something when an annotation is added.
|
|
183
|
-
* this.listenTo( annotations, 'add', ( evt, annotation ) => { ... } );
|
|
184
|
-
*
|
|
185
|
-
* // Do something when an annotation is removed.
|
|
186
|
-
* this.listenTo( annotations, 'remove', ( evt, annotation ) => { ... } );
|
|
187
|
-
* }
|
|
188
|
-
*
|
|
189
|
-
* detach() {
|
|
190
|
-
* this.stopListening();
|
|
191
|
-
* }
|
|
192
|
-
*
|
|
193
|
-
* setActiveAnnotation( annotation ) {
|
|
194
|
-
* if ( this.activeAnnotation ) {
|
|
195
|
-
* this.activeAnnotation.isActive = false;
|
|
196
|
-
*
|
|
197
|
-
* // You can do something in your UI with the annotation that is no longer active.
|
|
198
|
-
* }
|
|
199
|
-
*
|
|
200
|
-
* this.activeAnnotation = annotation;
|
|
201
|
-
* this.activeAnnotation.isActive = true;
|
|
202
|
-
*
|
|
203
|
-
* // You can do something in your UI to highlight the active annotation.
|
|
204
|
-
* }
|
|
205
|
-
* }
|
|
206
|
-
* ```
|
|
207
|
-
*/
|
|
208
|
-
export interface AnnotationUI {
|
|
209
|
-
/**
|
|
210
|
-
* Observable `activeAnnotation` property. {@link module:comments/annotations/annotationsuis~AnnotationsUIs} listens to changes on that
|
|
211
|
-
* property.
|
|
212
|
-
*
|
|
213
|
-
* To make this property observable use `this.set( 'activeAnnotation', null )` in the constructor.
|
|
214
|
-
*/
|
|
215
|
-
activeAnnotation: Annotation | null;
|
|
216
|
-
/**
|
|
217
|
-
* Creates everything needed for the UI and attaches all listeners. This method is called when the UI is activated.
|
|
218
|
-
*
|
|
219
|
-
* The observable collection of annotations is passed as the first argument,
|
|
220
|
-
* and the annotations UI is responsible for reacting to its changes.
|
|
221
|
-
*/
|
|
222
|
-
attach: (annotationCollection: AnnotationCollection) => void;
|
|
223
|
-
/**
|
|
224
|
-
* Destroys the UI and removes all listeners. This method is called when the UI is deactivated.
|
|
225
|
-
*/
|
|
226
|
-
detach: () => void;
|
|
227
|
-
/**
|
|
228
|
-
* Sets or unsets the active annotation. This method is called when an annotation is activated, for example, user puts their
|
|
229
|
-
* selection into a marker connected with given annotation.
|
|
230
|
-
*
|
|
231
|
-
* This method should change the UI so the new active annotation is differentiated from other annotations.
|
|
232
|
-
*
|
|
233
|
-
* This method should set the
|
|
234
|
-
* {@link #activeAnnotation `AnnotationUI#activeAnnotation`} property.
|
|
235
|
-
*
|
|
236
|
-
* It also should set {@link module:comments/annotations/annotation~Annotation#isActive `Annotation#isActive`} of the deactivated
|
|
237
|
-
* and the activated annotation.
|
|
238
|
-
*
|
|
239
|
-
* @param annotation The new active annotation or null when no annotation is active.
|
|
240
|
-
*/
|
|
241
|
-
setActiveAnnotation: (annotation: Annotation | null) => void;
|
|
242
|
-
_setSelectedAnnotations?: (annotations: Array<Annotation>) => void;
|
|
243
|
-
}
|
|
244
|
-
export type AnnotationsUI<T extends Emitter> = T & AnnotationUI;
|
|
@@ -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 comments/annotations/editorannotations
|
|
11
|
-
* @publicApi
|
|
12
|
-
*/
|
|
13
|
-
import { Plugin, type Editor } from 'ckeditor5/src/core.js';
|
|
14
|
-
import Annotations from './annotations.js';
|
|
15
|
-
import type Annotation from './annotation.js';
|
|
16
|
-
import type AnnotationCollection from './annotationcollection.js';
|
|
17
|
-
/**
|
|
18
|
-
* Integrates {@link module:comments/annotations/annotations~Annotations annotations} with the editor to provide proper behavior
|
|
19
|
-
* for annotations created through the editor features.
|
|
20
|
-
*
|
|
21
|
-
* *Note: The API of this class might change in the near future.*
|
|
22
|
-
*
|
|
23
|
-
* Collects all types of the annotations created through the editor features and their markers and decides which annotation is currently
|
|
24
|
-
* selected by the selection.
|
|
25
|
-
*
|
|
26
|
-
* Every editor plugin that adds an annotation should also
|
|
27
|
-
* {@link module:comments/annotations/editorannotations~EditorAnnotations#addSourceCollector register a callback}
|
|
28
|
-
* in which it will check whether given annotation should be marked as selected.
|
|
29
|
-
*/
|
|
30
|
-
export default class EditorAnnotations extends Plugin {
|
|
31
|
-
/**
|
|
32
|
-
* @inheritDoc
|
|
33
|
-
*/
|
|
34
|
-
static get requires(): readonly [typeof Annotations];
|
|
35
|
-
/**
|
|
36
|
-
* @inheritDoc
|
|
37
|
-
*/
|
|
38
|
-
static get pluginName(): "EditorAnnotations";
|
|
39
|
-
/**
|
|
40
|
-
* @inheritDoc
|
|
41
|
-
*/
|
|
42
|
-
static get isOfficialPlugin(): true;
|
|
43
|
-
/**
|
|
44
|
-
* @inheritDoc
|
|
45
|
-
*/
|
|
46
|
-
static get isPremiumPlugin(): true;
|
|
47
|
-
/**
|
|
48
|
-
* @inheritDoc
|
|
49
|
-
*/
|
|
50
|
-
constructor(editor: Editor);
|
|
51
|
-
/**
|
|
52
|
-
* @inheritDoc
|
|
53
|
-
*/
|
|
54
|
-
init(): void;
|
|
55
|
-
/**
|
|
56
|
-
* Registers given annotation as an editor annotation, that is an annotation that is linked with a target inside the editor content.
|
|
57
|
-
*/
|
|
58
|
-
registerAnnotation(annotation: Annotation): void;
|
|
59
|
-
hasDomSelection(): boolean;
|
|
60
|
-
/**
|
|
61
|
-
* Registers a callback that collects annotations and their markers.
|
|
62
|
-
*/
|
|
63
|
-
addSourceCollector(callback: Function): void;
|
|
64
|
-
/**
|
|
65
|
-
* Finds all annotations selected by the editor selection and marks the most inner one as the active annotation.
|
|
66
|
-
*/
|
|
67
|
-
refreshSelectedViews(): void;
|
|
68
|
-
/**
|
|
69
|
-
* Finds all annotations for selected markers in order from the most inner marker to the most outer marker.
|
|
70
|
-
*
|
|
71
|
-
* @param options.annotations The collection of annotations for given UI.
|
|
72
|
-
* @param options.activeAnnotation The given UI active annotation.
|
|
73
|
-
* It is used to determine the order if the selection contains the active annotation's marker.
|
|
74
|
-
*/
|
|
75
|
-
getOrderedSelectedAnnotations({ activeAnnotation, annotations }: {
|
|
76
|
-
activeAnnotation: Annotation | null;
|
|
77
|
-
annotations: AnnotationCollection;
|
|
78
|
-
}): Array<Annotation>;
|
|
79
|
-
}
|
|
@@ -1,102 +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 comments/annotations/inlineannotations
|
|
11
|
-
* @publicApi
|
|
12
|
-
*/
|
|
13
|
-
import { Plugin, type Editor } from 'ckeditor5/src/core.js';
|
|
14
|
-
import AnnotationsUIs, { type AnnotationsUI } from './annotationsuis.js';
|
|
15
|
-
import EditorAnnotations from './editorannotations.js';
|
|
16
|
-
import { ContextualBalloon } from 'ckeditor5/src/ui.js';
|
|
17
|
-
import './../../theme/annotation-inline.css';
|
|
18
|
-
import type Annotation from './annotation.js';
|
|
19
|
-
import type AnnotationCollection from './annotationcollection.js';
|
|
20
|
-
/**
|
|
21
|
-
* The popup-style UI for displaying annotations next to editor target elements.
|
|
22
|
-
*
|
|
23
|
-
* It displays {@link module:comments/annotations/annotation~Annotation annotations} in the
|
|
24
|
-
* {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon balloon} where the current
|
|
25
|
-
* {@link module:comments/annotations/inlineannotations~InlineAnnotations#activeAnnotation} is the displayed one.
|
|
26
|
-
*
|
|
27
|
-
* Note: this UI type works only with {@link module:core/editor/editor~Editor the Editor} and cannot be used in integrations where
|
|
28
|
-
* there is only {@link module:core/context~Context context} without any editor.
|
|
29
|
-
*
|
|
30
|
-
* This UI is intended for narrow screens.
|
|
31
|
-
*
|
|
32
|
-
* To activate this UI use one of the following:
|
|
33
|
-
*
|
|
34
|
-
* ```ts
|
|
35
|
-
* editor.plugins.get( 'AnnotationsUIs' ).switchTo( 'inline' );
|
|
36
|
-
* editor.plugins.get( 'AnnotationsUIs' ).activate( 'inline', filter );
|
|
37
|
-
* ```
|
|
38
|
-
*
|
|
39
|
-
* See {@link module:comments/annotations/annotationsuis~AnnotationsUIs}.
|
|
40
|
-
*/
|
|
41
|
-
export default class InlineAnnotations extends Plugin implements AnnotationsUI<Plugin> {
|
|
42
|
-
/**
|
|
43
|
-
* An active annotation tracked by this UI.
|
|
44
|
-
*
|
|
45
|
-
* @observable
|
|
46
|
-
*/
|
|
47
|
-
activeAnnotation: Annotation | null;
|
|
48
|
-
isAttached: boolean;
|
|
49
|
-
/**
|
|
50
|
-
* A collection of annotations controlled by this UI.
|
|
51
|
-
*
|
|
52
|
-
* This property is readonly and should not be operated on directly. Use it only to read which annotations are added to this UI.
|
|
53
|
-
*
|
|
54
|
-
* It is set to `null` if `InlineAnnotations` is not
|
|
55
|
-
* {@link module:comments/annotations/inlineannotations~InlineAnnotations#attach attached}.
|
|
56
|
-
*/
|
|
57
|
-
annotations: AnnotationCollection | null;
|
|
58
|
-
/**
|
|
59
|
-
* @inheritDoc
|
|
60
|
-
*/
|
|
61
|
-
static get requires(): readonly [typeof EditorAnnotations, typeof ContextualBalloon, typeof AnnotationsUIs];
|
|
62
|
-
/**
|
|
63
|
-
* @inheritDoc
|
|
64
|
-
*/
|
|
65
|
-
static get pluginName(): "InlineAnnotations";
|
|
66
|
-
/**
|
|
67
|
-
* @inheritDoc
|
|
68
|
-
*/
|
|
69
|
-
static get isOfficialPlugin(): true;
|
|
70
|
-
/**
|
|
71
|
-
* @inheritDoc
|
|
72
|
-
*/
|
|
73
|
-
static get isPremiumPlugin(): true;
|
|
74
|
-
/**
|
|
75
|
-
* @inheritDoc
|
|
76
|
-
*/
|
|
77
|
-
constructor(editor: Editor);
|
|
78
|
-
/**
|
|
79
|
-
* @inheritDoc
|
|
80
|
-
*/
|
|
81
|
-
init(): void;
|
|
82
|
-
/**
|
|
83
|
-
* @inheritDoc
|
|
84
|
-
*/
|
|
85
|
-
afterInit(): void;
|
|
86
|
-
/**
|
|
87
|
-
* Sets the active annotation for this UI.
|
|
88
|
-
*/
|
|
89
|
-
setActiveAnnotation(annotation: Annotation | null): void;
|
|
90
|
-
/**
|
|
91
|
-
* @inheritDoc
|
|
92
|
-
*/
|
|
93
|
-
attach(annotations: AnnotationCollection): void;
|
|
94
|
-
/**
|
|
95
|
-
* @inheritDoc
|
|
96
|
-
*/
|
|
97
|
-
detach(): void;
|
|
98
|
-
/**
|
|
99
|
-
* @inheritDoc
|
|
100
|
-
*/
|
|
101
|
-
destroy(): void;
|
|
102
|
-
}
|
|
@@ -1,97 +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 comments/annotations/narrowsidebar
|
|
11
|
-
* @publicApi
|
|
12
|
-
*/
|
|
13
|
-
import { ContextPlugin, Context, type Editor } from 'ckeditor5/src/core.js';
|
|
14
|
-
import AnnotationsUIs, { type AnnotationsUI } from './annotationsuis.js';
|
|
15
|
-
import Sidebar from './sidebar.js';
|
|
16
|
-
import { BalloonPanelView, BodyCollection } from 'ckeditor5/src/ui.js';
|
|
17
|
-
import '../../theme/sidebar-narrow.css';
|
|
18
|
-
import type Annotation from './annotation.js';
|
|
19
|
-
import type { default as AnnotationCollection } from './annotationcollection.js';
|
|
20
|
-
/**
|
|
21
|
-
* The narrow sidebar UI for displaying annotations.
|
|
22
|
-
*
|
|
23
|
-
* Binds {@link module:comments/annotations/annotations~Annotations} plugin with
|
|
24
|
-
* {@link module:comments/annotations/sidebar~Sidebar} plugin to display annotations in the sidebar as
|
|
25
|
-
* {@link module:comments/annotations/view/annotationcounterbuttonview~AnnotationCounterButtonView small icons}.
|
|
26
|
-
*
|
|
27
|
-
* After selecting an annotation the {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView} with an
|
|
28
|
-
* {@link module:comments/annotations/view/annotationview~AnnotationView} appears attached to the sidebar item.
|
|
29
|
-
*
|
|
30
|
-
* This UI is intended for medium-sized viewports.
|
|
31
|
-
*
|
|
32
|
-
* To activate this UI use one of the following:
|
|
33
|
-
*
|
|
34
|
-
* ```ts
|
|
35
|
-
* editor.plugins.get( 'AnnotationsUIs' ).switchTo( 'narrowSidebar' );
|
|
36
|
-
* editor.plugins.get( 'AnnotationsUIs' ).activate( 'narrowSidebar', filter );
|
|
37
|
-
* ```
|
|
38
|
-
*
|
|
39
|
-
* See {@link module:comments/annotations/annotationsuis~AnnotationsUIs}.
|
|
40
|
-
*/
|
|
41
|
-
export default class NarrowSidebar extends ContextPlugin implements AnnotationsUI<ContextPlugin> {
|
|
42
|
-
/**
|
|
43
|
-
* An active annotation tracked by this UI.
|
|
44
|
-
*/
|
|
45
|
-
activeAnnotation: Annotation | null;
|
|
46
|
-
bodyCollection: BodyCollection;
|
|
47
|
-
balloonPanelView: BalloonPanelView;
|
|
48
|
-
isAttached: boolean;
|
|
49
|
-
/**
|
|
50
|
-
* A collection of annotations controlled by this UI.
|
|
51
|
-
*
|
|
52
|
-
* This property is readonly and should not be operated on directly. Use it only to read which annotations are added to this UI.
|
|
53
|
-
*
|
|
54
|
-
* It is set to `null` if `NarrowSidebar` is not {@link module:comments/annotations/narrowsidebar~NarrowSidebar#attach attached}.
|
|
55
|
-
*/
|
|
56
|
-
annotations: AnnotationCollection | null;
|
|
57
|
-
/**
|
|
58
|
-
* @inheritDoc
|
|
59
|
-
*/
|
|
60
|
-
static get requires(): readonly [typeof Sidebar, typeof AnnotationsUIs];
|
|
61
|
-
/**
|
|
62
|
-
* @inheritDoc
|
|
63
|
-
*/
|
|
64
|
-
static get pluginName(): "NarrowSidebar";
|
|
65
|
-
/**
|
|
66
|
-
* @inheritDoc
|
|
67
|
-
*/
|
|
68
|
-
static get isOfficialPlugin(): true;
|
|
69
|
-
/**
|
|
70
|
-
* @inheritDoc
|
|
71
|
-
*/
|
|
72
|
-
static get isPremiumPlugin(): true;
|
|
73
|
-
/**
|
|
74
|
-
* @inheritDoc
|
|
75
|
-
*/
|
|
76
|
-
constructor(context: Context | Editor);
|
|
77
|
-
/**
|
|
78
|
-
* @inheritDoc
|
|
79
|
-
*/
|
|
80
|
-
init(): void;
|
|
81
|
-
/**
|
|
82
|
-
* @inheritDoc
|
|
83
|
-
*/
|
|
84
|
-
attach(annotations: AnnotationCollection): void;
|
|
85
|
-
/**
|
|
86
|
-
* Sets the active annotation for this UI.
|
|
87
|
-
*/
|
|
88
|
-
setActiveAnnotation(annotation: Annotation | null): void;
|
|
89
|
-
/**
|
|
90
|
-
* @inheritDoc
|
|
91
|
-
*/
|
|
92
|
-
detach(): void;
|
|
93
|
-
/**
|
|
94
|
-
* @inheritDoc
|
|
95
|
-
*/
|
|
96
|
-
destroy(): void;
|
|
97
|
-
}
|
|
@@ -1,112 +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 comments/annotations/sidebar
|
|
11
|
-
* @publicApi
|
|
12
|
-
*/
|
|
13
|
-
import { ContextPlugin, type Context, type Editor } from 'ckeditor5/src/core.js';
|
|
14
|
-
import type { FocusableView } from 'ckeditor5/src/ui.js';
|
|
15
|
-
import SidebarView from './view/sidebarview.js';
|
|
16
|
-
import SidebarItemView from './view/sidebaritemview.js';
|
|
17
|
-
import type Annotation from './annotation.js';
|
|
18
|
-
/**
|
|
19
|
-
* Displays {@link module:comments/annotations/annotationcollection~AnnotationCollection annotations} inside a sidebar.
|
|
20
|
-
*
|
|
21
|
-
* `Sidebar` provides a {@link module:comments/annotations/view/sidebarview~SidebarView} which can be injected at any place on a website.
|
|
22
|
-
*
|
|
23
|
-
* It's main role is to display and correctly position annotation views added to the sidebar, accordingly to their target elements
|
|
24
|
-
* or `Rect`s.
|
|
25
|
-
*
|
|
26
|
-
* The following plugins use `Sidebar` to provide annotations UI:
|
|
27
|
-
*
|
|
28
|
-
* * {@link module:comments/annotations/widesidebar~WideSidebar}
|
|
29
|
-
* * {@link module:comments/annotations/narrowsidebar~NarrowSidebar}
|
|
30
|
-
*
|
|
31
|
-
* The sidebar plugin introduces {@link module:comments/annotations/view/sidebaritemview~SidebarItemView} which is a wrapper view for
|
|
32
|
-
* {@link module:comments/annotations/view/annotationview~AnnotationView}. It adds an interface needed for positioning views inside
|
|
33
|
-
* the sidebar.
|
|
34
|
-
*
|
|
35
|
-
* Structure of items:
|
|
36
|
-
*
|
|
37
|
-
* |-> SidebarItemView -> AnnotationView -> added View
|
|
38
|
-
* Sidebar#view#list -|-> SidebarItemView -> AnnotationView -> added View
|
|
39
|
-
* |-> ...
|
|
40
|
-
*/
|
|
41
|
-
export default class Sidebar extends ContextPlugin {
|
|
42
|
-
/**
|
|
43
|
-
* Container element into which sidebar is injected (in the DOM).
|
|
44
|
-
*
|
|
45
|
-
* @observable
|
|
46
|
-
*/
|
|
47
|
-
container: HTMLElement | null;
|
|
48
|
-
/**
|
|
49
|
-
* Sidebar view.
|
|
50
|
-
*/
|
|
51
|
-
view: SidebarView;
|
|
52
|
-
/**
|
|
53
|
-
* @inheritDoc
|
|
54
|
-
*/
|
|
55
|
-
static get pluginName(): "Sidebar";
|
|
56
|
-
/**
|
|
57
|
-
* @inheritDoc
|
|
58
|
-
*/
|
|
59
|
-
static get isOfficialPlugin(): true;
|
|
60
|
-
/**
|
|
61
|
-
* @inheritDoc
|
|
62
|
-
*/
|
|
63
|
-
static get isPremiumPlugin(): true;
|
|
64
|
-
/**
|
|
65
|
-
* @inheritDoc
|
|
66
|
-
*/
|
|
67
|
-
constructor(context: Context | Editor);
|
|
68
|
-
/**
|
|
69
|
-
* @inheritDoc
|
|
70
|
-
*/
|
|
71
|
-
init(): void;
|
|
72
|
-
/**
|
|
73
|
-
* Sets a new sidebar container.
|
|
74
|
-
*/
|
|
75
|
-
setContainer(container: HTMLElement): void;
|
|
76
|
-
/**
|
|
77
|
-
* Rearranges annotations when the annotation is removed.
|
|
78
|
-
*/
|
|
79
|
-
rearrange({ removedAnnotation, previousAnnotation, nextAnnotation }: {
|
|
80
|
-
removedAnnotation: Annotation;
|
|
81
|
-
previousAnnotation: Annotation | null;
|
|
82
|
-
nextAnnotation: Annotation | null;
|
|
83
|
-
}): void;
|
|
84
|
-
/**
|
|
85
|
-
* Refreshes sidebar items when one of the annotations is activated.
|
|
86
|
-
*
|
|
87
|
-
* @param options.activatedAnnotation The activated annotation.
|
|
88
|
-
* @param options.blurredAnnotation The previously active annotation.
|
|
89
|
-
* @param options.disableAnimationOnActivatedAnnotation Disables animation on the activated annotation.
|
|
90
|
-
*/
|
|
91
|
-
refresh({ blurredAnnotation, activatedAnnotation, disableAnimationOnActivatedAnnotation }: {
|
|
92
|
-
blurredAnnotation: Annotation | null;
|
|
93
|
-
activatedAnnotation: Annotation | null;
|
|
94
|
-
disableAnimationOnActivatedAnnotation?: boolean;
|
|
95
|
-
}): void;
|
|
96
|
-
/**
|
|
97
|
-
* Creates new {@link module:comments/annotations/view/sidebaritemview~SidebarItemView} and binds its
|
|
98
|
-
* position with {@link module:comments/annotations/view/annotationview~AnnotationView} target position.
|
|
99
|
-
*
|
|
100
|
-
* By default, annotation's view will be displayed in the sidebar. However, you can provide any other view
|
|
101
|
-
* to be displayed instead using `annotationToDisplay`. `annotation` will be then used only to gather data needed by `Sidebar`.
|
|
102
|
-
*/
|
|
103
|
-
addAnnotation(annotation: Annotation, viewToDisplay?: FocusableView): SidebarItemView;
|
|
104
|
-
/**
|
|
105
|
-
* Returns sidebar item view that wraps given annotation view.
|
|
106
|
-
*/
|
|
107
|
-
getSidebarItemView(annotation: Annotation): SidebarItemView | undefined;
|
|
108
|
-
/**
|
|
109
|
-
* @inheritDoc
|
|
110
|
-
*/
|
|
111
|
-
destroy(): void;
|
|
112
|
-
}
|
|
@@ -1,33 +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 comments/annotations/view/annotationcounterbuttonview
|
|
11
|
-
* @publicApi
|
|
12
|
-
*/
|
|
13
|
-
import { ButtonView, View } from 'ckeditor5/src/ui.js';
|
|
14
|
-
import type { Locale } from 'ckeditor5/src/utils.js';
|
|
15
|
-
/**
|
|
16
|
-
* A view used in the sidebar by {@link module:comments/annotations/narrowsidebar~NarrowSidebar}.
|
|
17
|
-
*/
|
|
18
|
-
export default class AnnotationCounterButtonView extends ButtonView {
|
|
19
|
-
/**
|
|
20
|
-
* @observable
|
|
21
|
-
*/
|
|
22
|
-
isDirty: boolean;
|
|
23
|
-
/**
|
|
24
|
-
* @observable
|
|
25
|
-
*/
|
|
26
|
-
number: number;
|
|
27
|
-
/**
|
|
28
|
-
* @observable
|
|
29
|
-
*/
|
|
30
|
-
annotationType: string;
|
|
31
|
-
counterView: View;
|
|
32
|
-
constructor(locale: Locale);
|
|
33
|
-
}
|