Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/VanOns/laraberg
A Gutenberg implementation for Laravel
https://github.com/VanOns/laraberg
gutenberg laravel
Last synced: about 1 month ago
JSON representation
A Gutenberg implementation for Laravel
- Host: GitHub
- URL: https://github.com/VanOns/laraberg
- Owner: VanOns
- License: gpl-3.0
- Created: 2019-02-05T09:52:08.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-07T08:11:56.000Z (3 months ago)
- Last Synced: 2024-10-29T15:27:50.212Z (about 2 months ago)
- Topics: gutenberg, laravel
- Language: PHP
- Homepage:
- Size: 72 MB
- Stars: 1,332
- Watchers: 49
- Forks: 144
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
[](https://packagist.org/packages/van-ons/laraberg)
Laraberg aims to provide an easy way to integrate the Gutenberg editor with your Laravel projects. It takes the Gutenberg editor and adds all the communication and data it needs function in a Laravel environment.
# Table of Contents
- [Installation](#installation)
- [JavaScript and CSS files](#javascript-and-css-files)
- [Dependencies](#dependencies)
- [Updating](#updating)
- [Usage](#usage)
- [Initializing the Editor](#initializing-the-editor)
- [Configuration options](#configuration-options)
- [Models](#models)
- [Custom Blocks](#custom-blocks)
- [Server-side blocks](#server-side-blocks)
- [WordPress exports](#wordpress-exports)
# Installation
Install package using composer:
```bash
composer require van-ons/laraberg
```
Add vendor files to your project (CSS, JS & Config):
```bash
php artisan vendor:publish --provider="VanOns\Laraberg\LarabergServiceProvider"
```
## JavaScript and CSS files
The package provides a JS and CSS file that should be present on the page you want to use the editor on:
```html
```
## Dependencies
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:
```html
```
# Updating
When updating Laraberg you have to publish the vendor files again by running this command:
```bash
php artisan vendor:publish --provider="VanOns\Laraberg\LarabergServiceProvider" --tag="public" --force
```
# Usage
## Initializing the Editor
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.
```html
```
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.
```html
{{ $model->content }}
```
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 inside 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.
```js
Laraberg.init('[id_here]')
```
## Configuration options
The `init()` function takes an optional configuration object which can be used to change Laraberg's behaviour in some ways.
```js
const options = {}
Laraberg.init('[id_here]', options)
```
The `options` object should be a EditorSettings object.
```typescript
interface EditorSettings {
height?: string;
mediaUpload?: (upload: MediaUpload) => void;
fetchHandler?: FetchHandler;
disabledCoreBlocks?: string[];
alignWide?: boolean;
supportsLayout?: boolean;
maxWidth?: number;
imageEditing?: boolean;
colors?: Color[];
gradients?: Gradient[];
fontSizes?: FontSize[];
}
```
## Models
In order to add the editor content to a model Laraberg provides the 'RendersContent' trait.
```php
use VanOns\Laraberg\Traits\RendersContent;
class MyModel extends Model {
use RendersContent;
}
```
This adds the `render` method to your model which takes care of rendering the raw editor content. By default the `render` methods renders the content in the `content` column, the column can be changed by changing the `$contentColumn` property on your model to the column that you want to use instead.
```php
use VanOns\Laraberg\Traits\RendersContent;
class MyModel extends Model {
use RendersContent;
protected $contentColumn = 'my_column';
}
```
Or by passing the column name to the render method.
```php
$model->render('my_column');
```
## Custom Blocks
Gutenberg allows developers to create custom blocks. For information on how to create a custom block you should read the [Gutenberg documentation.](https://wordpress.org/gutenberg/handbook/designers-developers/developers/tutorials/block-tutorial/writing-your-first-block-type/)
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()`.
```js
const myBlock = {
title: 'My First Block!',
icon: 'universal-access-alt',
category: 'my-category',
edit() {
return
Hello editor.
},
save() {
return
Hello saved content.
}
}
Laraberg.registerBlockType('my-namespace/my-block', myBlock)
```
### Server-side blocks
Server-side blocks can be registered in Laravel. You probably want to create a ServiceProvider and register your server-side blocks in it's `boot` method.
```php
class BlockServiceProvider extends ServiceProvider {
public function boot() {
Laraberg::registerBlockType(
'my-namespace/my-block',
[],
function ($attributes, $content) {
return view('blocks.my-block', compact('attributes', 'content'));
}
);
}
}
```
## WordPress exports
Laraberg uses the WordPress Gutenberg packages under the hood, a lot of those packages expose functionality that let's you customize the editor. You can find these packages in Javascript in the global `Laraberg` object.
- `Laraberg.wordpress.blockEditor`
- `Laraberg.wordpress.blocks`
- `Laraberg.wordpress.components`
- `Laraberg.wordpress.data`
- `Laraberg.wordpress.element`
- `Laraberg.wordpress.hooks`
- `Laraberg.wordpress.serverSideRender`
