Content minimap MVP2 - Githubissues

ckeditor / ckeditor5

Powerful rich text editor framework with a modular architecture, modern integrations, and features like collaborative editing.

https://ckeditor.com/ckeditor-5

Other

9.36k stars 3.68k forks source link

Content minimap MVP2 #10089

Open oleq opened 3 years ago

oleq commented 3 years ago

📝 Provide a description of the improvement

Note: Demo of the feature is available in the documentation.

This issue is a follow-up of #10079 mainly to collect ideas, comments, bugs, and feature requests.

If you'd like to see this improvement implemented, add a 👍 reaction to this post.

oleq commented 3 years ago

Things missing after MVP1 (+bugs):

[ ] Tests
[ ] Code coverage
[ ] Support for multi-root
[ ] Dynamic root width support
[ ] Integration with frameworks (React, Angular, etc.)
[ ] Performance optimization
[ ] Manual test descriptions
[ ] Moving RectDrawer somewhere else so it can be shared
[ ] Moving cloneEditingViewDomRoot() somewhere else so it can be shared
[ ] Some way to display the selection (as a marker?)
[ ] Glitching when dragging on Safari in full page (in-body) mode with some long content.
[ ] Integration with focus tracker (clicking the minimap should not blur the editor).
[ ] Because of the scale() in CSS, the content width is wrong unless set declaratively in px for .ck-content (text wraps like scale is 1, then it is downscaled). Possible solution: get computed style width from .ck-content and pass it to the minimap.

wimleers commented 3 years ago

Holy crap 🤩 This is EPIC!

Ideally this would be enabled in lieu of increasing the height of the CKE5 instance as soon as the length hits a certain threshold… but that doesn’t seem configurable yet according to https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/module_minimap_minimap-MinimapConfig.html.

If I go to https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/features/general-html-support.html and delete all content in the demo and type a single phrase, the mini map just looks really weird — which is why I'm suggesting to only make it appear once a threshold is hit:

P.S.: long time no see, @oleq! 😊 👋

oleq commented 3 years ago

Ideally this would be enabled in lieu of increasing the height of the CKE5 instance as soon as the length hits a certain threshold… but that doesn’t seem configurable yet according to https://ckeditor5.github.io/docs/nightly/ckeditor5/latest/api/module_minimap_minimap-MinimapConfig.html.

I agree this would make sense in some itegrations.

OTOH, since the minimap requires its own container (it consumes the horizontal space), this might be surprising or even troublesome for some integrators if it showed up on its own depending on the content of the edited document they have little-to-no control over.

OTTH, this is pretty easy to implement on the integration side, all you need is to measure the height of the content (getBoundingClientRect() of the editing root) and show/hide the minimap container accordingly. There could be a dedicated editor plugin that manages this behavior.

P.S.: long time no see, @oleq! 😊 👋

Nice to see you, too 😛

108signals commented 3 years ago

@oleq amazing work!

+1 for multiroot support

projectitis commented 2 years ago

Also just came here to say: +1 for multiroot support :)

privateOmega commented 2 years ago

+1 for React Integration.

Thanks

zgpnuaa commented 2 years ago

An error occurred after the webpack package was deployed on the production.

someqq commented 1 year ago

催更

CKEditorBot commented 7 months ago

There has been no activity on this issue for the past year. We've marked it as stale and will close it in 30 days. We understand it may still be relevant, so if you're interested in the solution, leave a comment or reaction under this issue.

wimleers commented 7 months ago

What?

Please don’t adopt this horrendously unempathetic autoclosebot policy 🤐👎