XWiki

Last modified by Manuel Leduc on 2025/12/01 15:01

Developer

This module provides a CollaborationManager for an xwiki yjs real-time server.

Note that currently connecting to a websocket server from a domain different from the one where the Javascript is executed is not supported.
Therefore, this is only supported when Blocknote Headless is deployed in an XWiki extension.

APIs

XWiki 0.21+

Function createXWikiWebSocketProvider

Initialize a websocket provider for a XWiki yjs endpoint.

createXWikiWebSocketProvider(url: string, room: string): WebsocketProvider
Parameters
  • url: string

    the url of the websocket endpoint

  • room: string

    the string serialization of the room

Returns WebsocketProvider
Warning

This method was named createXWikiWebsocketProvider at its introduction in Cristal 0.20.

XWiki 0.20+

Class ComponentInit

Initialize the components for the package.

new ComponentInit(container: Container): ComponentInit
Parameters
  • container: Container
France 2030 Logo

This project is being financed by the French State as part of the France 2030 program

Ce projet est financé par l’État Français dans le cadre de France 2030

  • Powered by XWiki 17.10.9-node2. Hosted and managed by XWiki SAS

Get Connected