@lapilli-ui/block-editor v1.0.0-beta.2

Lapilli UI - Block Editor

You can use the Gutenberg block editor through the BlockEditor component.

Requirements

Enqueue styles and scripts

To use it in WordPress, you need to enqueue the following styles and scripts:

wp_enqueue_style( 'wp-edit-blocks' );
wp_enqueue_style( 'wp-format-library' );

wp_enqueue_editor();
wp_enqueue_media();

do_action( 'enqueue_block_editor_assets' );

// Preload server-registered block schemas.
wp_add_inline_script(
	'wp-blocks',
	'wp.blocks.unstable__bootstrapServerSideBlockDefinitions(' . wp_json_encode( get_block_editor_server_block_settings() ) . ');'
);

$block_editor_context = new \WP_Block_Editor_Context( array( 'name' => 'my-plugin/context' ) );

$editor_settings = get_block_editor_settings(
	array(
		'styles'            => get_block_editor_theme_styles(),
		'allowedBlockTypes' => array(
			'core/paragraph',
			'core/heading',
			'core/list',
			'core/list-item',
			'core/quote',
			'core/image',
		),
	),
	$block_editor_context
);

wp_add_inline_script(
	'wp-blocks',
	sprintf( 'wp.blocks.setCategories( %s );', wp_json_encode( $editor_settings['blockCategories'] ?? array() ) ),
	'after'
);

You should also enable the loading of the block editor scripts and styles in the admin area, by using the should_load_block_editor_scripts_and_styles filter:

add_action( 'should_load_block_editor_scripts_and_styles', array( $this, 'should_load_block_editor_scripts_and_styles' ), 10 );

public function should_load_block_editor_scripts_and_styles( $should_load ) {
		if ( ! $should_load ) {
			$screen    = function_exists( 'get_current_screen' ) ? get_current_screen() : false;
			$screen_id = $screen ? $screen->id : false;

			if ( 'your_page_screen_id' === $screen_id ) {
				$should_load = true;
			}
		}


		return $should_load;
	}

Register blocks

Before using it, you need to register the blocks you want to use.

For example, you can register all WordPress blocks with the following code:

import { registerCoreBlocks } from '@wordpress/block-library';

registerCoreBlocks();

Please note: the core/paragraph block is required.

Set block editor settings

You should also set the settings for the BlockEditor, by using its settings prop.

You could use wp_localize_script to pass the settings to your React code, as follows:

$block_editor_context = new \WP_Block_Editor_Context( array( 'name' => 'my-plugin/context' ) );

$editor_settings = get_block_editor_settings(
	array(
		'styles'            => get_block_editor_theme_styles(),
		'allowedBlockTypes' => array(
			'core/paragraph',
			'core/heading',
			'core/list',
			'core/list-item',
			'core/quote',
			'core/image',
		),
	),
	$block_editor_context
);

wp_localize_script(
	'my-plugin-script',
	'myPluginOptions',
	array(
		'blockEditorSettings' => $editor_settings,
	)
);

Media Library

In addition, if you want to enable the WordPress media library, you need to add the following filter to your React code:

import { addFilter }   from '@wordpress/hooks';
import { MediaUpload } from '@wordpress/media-utils';

const replaceMediaUpload = () => MediaUpload;

addFilter(
	'editor.MediaUpload',
	'my-plugin/replace-media-upload',
	replaceMediaUpload
);

Use the block editor

To use the block editor, you need to add the BlockEditor component to your React code, as follows:

import { useState }         from 'react';
import { BlockEditor }      from '@lapilli-ui/block-editor';
import { parse, serialize } from '@wordpress/blocks';

export default function MyOptions() {
	const [description, setDescription] = useState(
		parse( `
			<!-- wp:paragraph -->
			<p>This is an example!</p>
			<!-- /wp:paragraph -->
			`
		)
	);

	return (
		<div>
			<BlockEditor
				blocks={description}
				onChange={setDescription}
				settings={myPluginOptions.blockEditorSettings}
			/>
		</div>
	);
}

You can use the parse and serialize functions from @wordpress/blocks to convert the blocks to HTML and vice versa.

Documentation

See the main Lapilli UI website for the list of available components, API and usage documentation.