https://github.com/agence-adeliom/easy-editor-bundle

A Symfony bundle for EasyAdmin that provide a flexible content editor
https://github.com/agence-adeliom/easy-editor-bundle

easyadmin editor flexible-content symfony

Last synced: 28 days ago
JSON representation

A Symfony bundle for EasyAdmin that provide a flexible content editor

• Host: GitHub
• URL: https://github.com/agence-adeliom/easy-editor-bundle
• Owner: agence-adeliom
• License: mit
• Created: 2021-08-23T12:11:10.000Z (over 3 years ago)
• Default Branch: 2.x
• Last Pushed: 2024-05-29T09:46:30.000Z (7 months ago)
• Last Synced: 2024-11-24T17:49:08.215Z (about 1 month ago)
• Topics: easyadmin, editor, flexible-content, symfony
• Language: PHP
• Homepage:
• Size: 461 KB
• Stars: 11
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        

![Adeliom](https://adeliom.com/public/uploads/2017/09/Adeliom_logo.png)

[![Quality gate](https://sonarcloud.io/api/project_badges/quality_gate?project=agence-adeliom_easy-editor-bundle)](https://sonarcloud.io/dashboard?id=agence-adeliom_easy-editor-bundle)

# 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

```json

{

  "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

```bash

composer require agence-adeliom/easy-editor-bundle

```

## Documentation

### Usage

#### Entity

```php

class Article

{

    #[ORM\Column(name: 'content', type: \Doctrine\DBAL\Types\Types::JSON, nullable: true)]

    private $content = [];

}

```

#### CRUD Controller

```php

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

```php

{% for block in object.content %}

    {{ easy_editor_block(block) }}

{% endfor %}

```

### Create a new type

```bash

bin/console make:block

```

### Events

#### easy_editor.render_block

```php

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](https://choosealicense.com/licenses/mit/)

## Authors

- [@arnaud-ritti](https://github.com/arnaud-ritti)