Laraberg aims to provide an easy way to integrate the Gutenberg editor with your Laravel projects. It is built on top of the GutenbergJS project, implements all the necessary communication and adds an easy to use API.
Install package using composer:
composer require van-ons/larabergAdd vendor files to your project (CSS, JS & Config):
php artisan vendor:publish --provider='VanOns\Laraberg\LarabergServiceProvider'In order to store the data for the Gutenberg editor, Laraberg needs to run a database migration:
php artisan migrate
This will create the 'lb_contents' and 'lb_blocks' tables.
The package provides a JS and CSS file that should be present on the page you want to use the editor on:
<link rel="stylesheet" href="{{asset('vendor/laraberg/css/laraberg.css')}}">
<script src="{{ asset('vendor/laraberg/js/laraberg.js') }}"></script>The Gutenberg editor expects React, ReactDOM, Moment and JQuery to be in the environment it runs in. An easy way to do this would be to add the following lines to your page:
<script src="https://unpkg.com/[email protected]/umd/react.production.min.js"></script>
<script src="https://unpkg.com/[email protected]/umd/react-dom.production.min.js"></script>
<script src="https://unpkg.com/[email protected]/min/moment.min.js"></script>
<script src="https://code.jquery.com/jquery-1.12.4.min.js" integrity="sha256-ZosEbRLbNQzLpnKIkEdrPv7lOy9C27hHQ+Xp8a4MxAQ=" crossorigin="anonymous"></script>When initializing the editor there are a number of configuration options you can provide. This is still a work in progress!
It is possible to set the height, maxHeight, and minHeight of the editor by providing the desired values in the options object:
Laraberg.initGutenberg('[id_here]', { height: '500px' })
Laraberg.initGutenberg('[id_here]', { maxHeight: '500px' })
Laraberg.initGutenberg('[id_here]', { minHeight: '500px' })After publishing the vendor files you can find the 'laraberg.php' file in your config folder. This file allows you to configure the API Routes. Here you can change the URL prefix and the middleware for the routes.
If you wish to define the routes yourself you can do that by setting 'use_package_routes' to 'false' in the config. Then you can take the following routes and make changes as you see fit:
Route::group(['prefix' => 'laraberg', 'middleware' => ['web', 'auth']], function() {
Route::apiResource('blocks', 'VanOns\Laraberg\Http\Controllers\BlockController');
Route::get('oembed', 'VanOns\Laraberg\Http\Controllers\OEmbedController');
});Laraberg supports Laravel File Manager for uploading files. To enable uploading media through Laravel File Manager the laravelFilemanager field should be set to true. This will add a 'File Manager' button to the Gutenberg media blocks that will open Laravel File Manager for uploading and selecting media files.
Laraberg.initGutenberg('[id_here]', { laravelFilemanager: true })If you are not using the default routes for Laravel File Manager you can provide the location of your Laravel File Manager endpoints in the options object like this:
Laraberg.initGutenberg('[id_here]', { laravelFilemanager: { prefix: '/[lfm_prefix_here]' } })Note: Laraberg does not do any configuration on your Laravel File Manager setup. By default a lot of media filetypes can not be uploaded unless they are whitelisted in the Laravel File Manager configuration file. For more information on this you can check the Laravel File Manager documentation.
The Gutenberg editor should replace an existing textarea in a form. On submit the raw content from the editor will be put in the 'value' attribute of this textarea.
<input id="[id_here]" type="textarea" name="[name_here]" hidden>In order to edit content on an already existing model we have to set the value of the textarea to the raw content that the Gutenberg editor provided.
<input id="[id_here]" type="textarea" name="[name_here]" value="{{$model->getRawContent()}}" hidden>To initialize the editor all we have to do is call the initialize function with the id of the textarea. You probably want to do this insde a DOMContentLoaded event.
And that's it! The editor will replace the textarea in the DOM and on a form submit the editor content will be available in the textarea's value attribute.
Laraberg.initGutenberg('[id_here]')If you want to use the editor, but for some reason do not want to deal with submitting forms there is a way to get the content from the editor through JavaScript:
let content = Laraberg.getContent()In order to add the editor content to a model Laraberg provides the 'Gutenbergable' trait.
use VanOns\Laraberg\Models\Gutenbergable;
class MyModel extends Model {
use Gutenbergable;
}This adds multiple methods to your model that will help you with creating/updating/rendering the Gutenberg content.
$content // This is the raw content from the Gutenberg editor
$model = new MyModel;
// Add or update the content & (if true is provided) call save() on the content object
$model->setContent($content, true);
// Get the rendered HTML inside of a container
// This is the function you should use for rendering the content on a page
$model->renderContent();
// Get the rendered content
$model->getRenderedContent();
// Get the raw content
$model->getRawContent();There is always the possibility that your model already implements a method with the same name as one of the Gutenbergable methods. Luckily PHP Traits provide an easy way to rename the methods from a trait:
class MyModel extends Model {
use Gutenbergable {
renderContent as renderLBContent;
}
public function renderContent() {
// Your method
}
}In this example you can just call the 'renderLBContent' method to render the content.
Rendering the Gutenberg content is very simple and happens like this:
<div id="your_container"> <!-- The element you want to render the content in -->
{!! $page->renderContent() !!}
</div>Keep in mind that in order to correctly display some of the Wordpress styling the Laraberg CSS has to be present on the page:
<link rel="stylesheet" href="{{asset('vendor/laraberg/css/laraberg.css')}}">Gutenberg allows developers to create custom blocks. For information on how to create a custom block you should read the Gutenberg documentation.
Registering custom blocks is fairly easy. A Gutenberg block requires the properties title, icon, and categories. It also needs to implement the functions edit() and save().
const myBlock = {
title: 'My First Block!',
icon: 'universal-access-alt',
category: 'my-category',
edit() {
return <h1>Hello editor.</h1>
},
save() {
return <h1>Hello saved content.</h1>
}
}
Laraberg.registerBlock('my-namespace/my-block', myBlock)If you want to add your custom block to a new category you need to add that category first:
let title = 'My Category'
let slug = 'my-category'
Laraberg.registerCategory(title, slug)Laraberg implements Laravel events that you can use to implement your own listeners. The events contain a 'content' attribute that contains the relevant Content object. For information on how Laravel events work you can read the Laravel documentation.
- VanOns\Laraberg\Events\ContentCreated
- VanOns\Laraberg\Events\ContentRendered
- VanOns\Laraberg\Events\ContentUpdated
 |
|---|
| Maurice Wijnia |
