agence-adeliom/easy-editor-bundle

A Symfony bundle for EasyAdmin that provide a flexible content editor

2.0.88 2023-03-22 11:54 UTC

Requires

• php: >=8.0.2
• ext-json: *
• agence-adeliom/easy-common-bundle: ^2.0.88
• agence-adeliom/easy-fields-bundle: ^2.0.88
• easycorp/easyadmin-bundle: ^3.4 || ^v4.0
• symfony/config: ^5.4 || ^6.0
• symfony/dependency-injection: ^5.4 || ^6.0
• symfony/deprecation-contracts: ^2.2 || ^v3.0
• symfony/event-dispatcher: ^5.4 || ^6.0
• symfony/form: ^5.4 || ^6.0
• symfony/framework-bundle: ^5.4 || ^6.0
• symfony/http-kernel: ^5.4 || ^6.0
• symfony/options-resolver: ^5.4 || ^6.0
• symfony/property-access: ^5.4 || ^6.0

MIT

• Arnaud RITTI

• symfony
• editor
• easyadmin
• flexible-content

README

Easy Editor Bundle

Provide a flexible content editor for Easyadmin.

Features

• Ability to create custom blocks
• Twig extension to render the content

Versions

Repository Branch	Version	Symfony Compatibility	PHP Compatibility	Status
2.x	2.x	5.4, and 6.x	8.0.2 or higher	New features and bug fixes
1.x	1.x	4.4, and 5.x	7.2.5 or higher	No longer maintained

Installation with Symfony Flex

Add our recipes endpoint

{
  "extra": {
    "symfony": {
      "endpoint": [
        "https://api.github.com/repos/agence-adeliom/symfony-recipes/contents/index.json?ref=flex/main",
        ...
        "flex://defaults"
      ],
      "allow-contrib": true
    }
  }
}

Install with composer

composer require agence-adeliom/easy-editor-bundle

Documentation

Usage

Entity

class Article
{
    #[ORM\Column(name: 'content', type: \Doctrine\DBAL\Types\Types::JSON, nullable: true)]
    private $content = [];
}

CRUD Controller

class ArticleCrudController extends AbstractCrudController
{
    // Add the custom form theme
    public function configureCrud(Crud $crud): Crud
    {
        return $crud
            ->addFormTheme('@EasyEditor/form/editor_widget.html.twig')
            ;
    }

    public function configureFields(string $pageName): iterable
    {
        yield EasyEditorField::new('content');
    }
}

Twig template

{% for block in object.content %}
    {{ easy_editor_block(block) }}
{% endfor %}

Create a new type

bin/console make:block

Events

easy_editor.render_block

use Symfony\Contracts\EventDispatcher\Event;

$dispatcher->addListener('easy_editor.render_block', function (Event $event) {
    // will be executed when the easy_editor.render_block event is dispatched

    // Get
    $block = $event->getArgument('block');
    $settings = $event->getArgument('settings');

    // Set
    $event->setArgument("block", $block);
    $event->setArgument("settings", $settings);
});

License

MIT

Authors

• @arnaud-ritti