hovornyan/laravel-grapesjs

A package for use Grapes.js in Laravel

2.0.8 2021-09-28 11:29 UTC

Requires

• php: ^7.3|^8.0
• illuminate/support: ~5.6.0|~5.7.0|~5.8.0|^6.0|^7.0|^8.0
• jd-dotlogics/laravel-media: ^2

MIT

• Dotlogics

README

composer require hovornyan/laravel-grapesjs

Publish files

php artisan vendor:publish --provider="Dotlogics\Grapesjs\GrapesjsServiceProvider"

php artisan vendor:publish --provider="Spatie\MediaLibrary\MediaLibraryServiceProvider" --tag="migrations"

php artisan migrate

npm i grapesjs

npm i grapesjs-blocks-basic

npm i grapesjs-blocks-bootstrap4

npm i grapesjs-tui-image-editor

npm i toastr

Get Start

1. Add 'gjs_data' column to the model's database table (e.g Page), for which you are going to use the editor.

2. Implement Editable Interface and use the EditableTrait trait for the Model class

use Illuminate\Database\Eloquent\Model;
use Dotlogics\Grapesjs\App\Traits\EditableTrait;
use Dotlogics\Grapesjs\App\Contracts\Editable;

class Page extends Model implements Editable
{
    use EditableTrait;

    ...
}

1. Next Create a Route for editor

Route::get('pages/{page}/editor', 'PageController@editor');

1. In your controller, use the EditorTrait and add the editor method

<?php

namespace App\Http\Controllers;

use App\Models\Page;
use Illuminate\Http\Request;
use Dotlogics\Grapesjs\App\Traits\EditorTrait;

class PageController extends Controller
{
    use EditorTrait;

    ...


    public function editor(Request $request, Page $page)
    {
        return $this->show_gjs_editor($request, $page);
    }

    ...
}

1. Open this route /pages/:page_id/editor (where the :page_id is the id of your model)

Placeholders

Placeholders are like short-code in wordpress. The synax of placeholder is

[[This-Is-Placeholder]]

Create a file named "this-is-placeholder.blade.php" in "/resources/views/vendor/grapesjs/placeholders" directory.

The the placeholder will be replaced by the content of the relative blade file "this-is-placeholder.blade.php"

Templates

You can create a template (a block) in the "/resources/views/vendor/grapesjs/templates" directory. And the templates will be availabe in the block section of edittor.

Display output

The "Editable" model (e.g. Page) will have two public properties, css and html. In your blade file you can use these properties to display the content.

<style type="text/css">
	{!! $page->css !!}
</style>

{!! $page->html !!}

Thank you for using.