manifest / editor / gutenberg-collaborative-editing

Gutenberg Collaborative Editing

A plugin to enhance Gutenberg with collaborative editing features.

by DotOrg · github.com/ashfame/gutenberg-collaborative-editing

★ 0stars

0forks

Install

No release zip yet. The repository archive installs, but the folder name will carry the branch suffix and updates will not flow:

wp plugin install https://github.com/ashfame/gutenberg-collaborative-editing/archive/refs/heads/main.zip

Readme github.com/ashfame/gutenberg-collaborative-editing ↗

GitHub Plugin URI: https://github.com/ashfame/gutenberg-collaborative-editing

Enable collaborative editing in Gutenberg

Description

Enable collaborative editing in Gutenberg.

Settings

This plugin adds a settings page under Settings > Collaborative Editing in the WordPress admin.

Collaboration Mode:
- Read-only Follow: The first user to open a post gets editing rights, and subsequent users can only view the post in real-time.
- Block-level Locks: Multiple users can edit the same post, just not the same block. (🚧Functional, but still a Work in Progress)

Screenshots

Example

How to run this locally?

After cloning the GIT repo locally, run nvm use, npm install.
Run npm run build once or can also run npm run start.
Run npm run wp-env start (you will need docker running).
Login into WordPress (http://localhost:8888/wp-admin) with username admin and password as password.
Configure the collaboration mode on Settings > Collaborative Editing.
Create two or more users and log in from these user accounts in separate browser instances.
Edit the same post or page for editing.
Being on a call, these users can meaningfully participate already as of today.

How to get the plugin zip file?

Run nvm use, npm run package to generate the zip file in the dist directory.

Frequently Asked Questions

How do I use it?

Install this plugin, configure the collaboration mode and have more than one user edit the same post or page.

Can I programmatically control what post or page I have this enabled on?

Not yet. I need to figure out a good way to enable that. But eventually I would like it to be configurable as follows:

// functions.php
add_filter( 'gutenberg_collabrative_editing_enabled', function ( $post, $user_ids_collaborating, $user_id_initiating_collaboration ) {
    // Add logic here
    return $true;
} );