Realtime editing in (AppWithinMinutes) class “page” field?

Help / Discuss
1

Hi all,

I recently got XWiki realtime collaboration working (Netflux/WebSocket etc.), and it works correctly when editing pages through the standard WYSIWYG editor.

Now I’m trying to use it in an AppWithinMinutes (AWM) app, and I’m running into a limitation.

Setup:

  • XWiki 17.10

  • Realtime extensions enabled and working

  • AWM application with a class that includes a “page” field (used to store/edit page content)

When editing content through that “page” field (inside the AWM-generated form), I was hoping the realtime WYSIWYG editor would kick in.

What actually happens:

  • The field renders, but realtime editing is not active

  • No Netflux/WebSocket usage from that editor instance

  • Realtime does work fine when editing the page directly (standard edit mode)

Question:
Is realtime editing supported inside AWM object editors (e.g. textarea/WYSIWYG fields in class forms)?

Or is realtime strictly limited to the standard page editing UI?

If not supported out of the box:

  • Is there a recommended way to enable it?

  • Or a pattern to follow (e.g. redirecting to page edit instead of inline editing)?

Any pointers or examples would be appreciated!

Thanks!

2

This is unfortunately not supported at the moment. See XWIKI-21624. I don’t know if there are any plans to work on this in the near future as our main focus regarding the WYSIWYG editor is currently to switch to BlockNote so any effort to implement this would likely need to be duplicated to also make it work with BlockNote. Further, there is also the question of how to handle this with other form fields etc.

1 Like
3

Precisely. Enabling realtime editing in a form only for one field is problematic. We already have this problem with the page title that is not synchronized. This becomes even more serious for inline form edit mode. Without knowing that another user is editing or has edited a field you can overwrite their value. Moreover, the “Saved” (dirty) state would have to take into account all the form fields, not just the page content field. So no, currently there’s no easy way to enable realtime for inline form edit mode. We hope to implement this on top of the new Yjs-based collaboration API that we’re using for the BlockNote integration (the new WYSIWYG editor).

1 Like
4

Ok, I understand the challenge and current situation then.

Thank you both for the quick and insightfull reply!

BR