Repository files navigation

This plugin adds a rich editor on the fields you want. Now you can manage your content very easily!

ℹ️ For Sylius 1.x, see our branch [branch 2.x] (https://github.com/monsieurbiz/SyliusRichEditorPlugin/tree/2.0) and all 2.x releases.

If you want to use our recipes, you can configure your composer.json by running:

composer config --no-plugins --json extra.symfony.endpoint'["https://api.github.com/repos/monsieurbiz/symfony-recipes/contents/index.json?ref=flex/master","flex://defaults"]'

composer require monsieurbiz/sylius-rich-editor-plugin

<?phpreturn [//..Twig\Extra\TwigExtraBundle\TwigExtraBundle::class => ['all' =>true],MonsieurBiz\SyliusRichEditorPlugin\MonsieurBizSyliusRichEditorPlugin::class => ['all' =>true],];

imports:    -{ resource: "@MonsieurBizSyliusRichEditorPlugin/Resources/config/config.yaml" }

monsieurbiz_richeditor_admin:resource:"@MonsieurBizSyliusRichEditorPlugin/Resources/config/routing/admin.yaml"prefix:/%sylius_admin.path_name%

If the recipe did not comment it, update the fileconfig/packages/twig.yaml to comment or remove theIntlExtension andStringExtension declarations :

# Twig\Extra\Intl\IntlExtension: ~#Twig\Extra\String\StringExtension: ~

If theauto-script is not in yourcomposer.json project, you can install the assets with the following command:

bin/console asset:install

You don't need to do something, everything is compatible !

composer require monsieurbiz/sylius-media-manager-plugin="^2.0"

To make a field use the rich editor, you must use theRichEditorType type for it.
We have an example of implementation in thefile for the test application.

If your field has some data already, like some previous text before installing this plugin,then we will convert it for you as an HTML Element which contains… HTML.

This way you will be able to use our plugin right away without risking any data lost!

⚠️ To have rich editor for original admin fields, likeProduct description,Taxon desription etc. you have to update each form type by an extension as the example shows above.

To display the content of the rich editor field you must call the twig filter:

{{content |monsieurbiz_richeditor_render_field }}

You can see an example in thefile for the test application

You can also render your elements with some custom DOM around that. To do so, you have access to a twig filter thatgives you the elements list :

{%setelements= monsieurbiz_richeditor_get_elements(content) %}

And then you can either render them all :

{{elements|monsieurbiz_richeditor_render_elements }}

Or one by one :

{%forelementinelements %}    {{element|monsieurbiz_richeditor_render_element }}{%endfor %}

If you want to filter the elements which are available for your field, you can use thetags option when you build your form.
As example:

$builder->add('description', RichEditorType::class, ['required' =>false,'label' =>'sylius.form.product.description','tags' => ['-default','product'],]);

In that example, all Ui Elements with the tagdefault will be excluded, then the Ui Elements with the tagproduct will be included.
Don't worry, you can add this filter afterwards, we won't remove the already present Ui Elements of your field. But wewon't allow to add more if they don't have one of the allowed tags!

The order of the tags matters! The first tag will be less important then the second.
As example, if you have 3 Ui Elements with the following tags:

• element1: tag1, tag2, tag3
• element2: tag1, tag2
• element3: tag2, tag3

And you set the tags of your field to-tag1, tag2, -tag3, then the only available Ui Element will be:element2.
They all have the tag2 to include them, but the element1 and element3 have the tag3 which is excluding them after being both included.

monsieurbiz_sylius_richeditor:ui_elements:app.my_element:# …tags:['product']

Here is what really happens when deactivating an Ui Element:

• it's not displayed anymore in frontend
• it's still editable in backend for old contents but you can't add a new one
• if the element has an alias, the alias is treated the same way

Define the overload of a proposed UiElement in your configuration folder, let's say inconfig/packages/monsieurbiz_sylius_richeditor_plugin.yaml as example.

monsieurbiz_sylius_richeditor:ui_elements:monsieurbiz.youtube:enabled:false

• Two columns element (Layout)
• Row Element (Layout)
• Column Element (Layout)
• HTML Element
• Markdown Element
• Text element
• Quote element
• Image element
• Video element
• Button element
• Title element
• Separator element
• Youtube element
• Image collection element
• Anchor element

In this example, we will add a Google Maps element.

With the Maker Bundle, you can create a new UiElement very easily:

bin/console make:ui-element

Then you will have to answer some questions, or you can add arguments to the command to avoid the questions.

bin/console make:ui-element app.google_maps"map pin"

Just add the translations!

Tips: If you are using PHP 8.1 or newer, you can use the#[AsUiElement] attribute to define your UiElement. You can skip this step.

Define your UiElement in your configuration folder, let's say inconfig/packages/monsieurbiz_sylius_richeditor_plugin.yaml as example.

monsieurbiz_sylius_richeditor:ui_elements:app.google_maps:title:'app.ui_element.google_maps.title'description:'app.ui_element.google_maps.description'icon:tabler:brand-google-mapsclasses:form:App\Form\Type\UiElement\GoogleMapsType#ui_element: App\UiElement\MyUiElementtemplates:admin_render:'/admin/ui_element/google_maps.html.twig'front_render:'/shop/ui_element/google_maps.html.twig'tags:[]

You can use your own Ui Element object if needed. Be sure to implement the\MonsieurBiz\SyliusRichEditorPlugin\UiElement\UiElementInterface interface.
A trait is there for you 🤗 as well. This is very useful when you need to do some custom work in your templates, it's likehaving a helper around. The Ui Element is then available via theui_element variable in your templates.

<?phpdeclare(strict_types=1);namespaceApp\Form\Type\UiElement;useSymfony\Component\Form\AbstractType;useSymfony\Component\Form\Extension\Core\Type\TextType;useSymfony\Component\Form\FormBuilderInterface;useSymfony\Component\Validator\ConstraintsasAssert;class GoogleMapsTypeextends AbstractType{publicfunctionbuildForm(FormBuilderInterface$builder,array$options)    {$builder            ->add('link', TextType::class, ['label' =>'app.ui_element.google_maps.link','required' =>true,'constraints' => [newAssert\NotBlank(),                ],            ])        ;    }}

For PHP 8.1 and newer, you can use the#[AsUiElement] attribute to define your UiElement. For example:

<?php// ...useMonsieurBiz\SyliusRichEditorPlugin\Attribute\AsUiElement;#[AsUiElement(    code:'app.google_maps',    icon:'tabler:brand-google-maps',)]class GoogleMapsTypeextends AbstractType// ...

The title, description and templates values are generated automatically from the code. In this example :

• the title will beapp.ui_element.google_maps.title,
• the description will beapp.ui_element.google_maps.description,
• the admin template will be/admin/ui_element/google_maps.html.twig,
• and the front template will be/shop/ui_element/google_maps.html.twig.

But you can override them if you want:

#[AsUiElement(    code:'app.google_maps',    title:'my_cusom.title',// Use your own translation key or a string    description:'my_custom.description',    icon:'tabler:brand-google-maps',    templates:newTemplatesUiElement(        adminRender:'admin/my_custom_path/google_maps.html.twig',        frontRender:'shop/my_custom_path/google_maps.html.twig',    ),    uiElement: GoogleMapsUiElement::class,// Use your own UiElement class    tags: ['map'],// Add some tags to filter the UiElement    wireframe:'google_maps',// Add a wireframe to help the user to understand the UiElement, see below)]

Here is an example of possible translation for the GMap element :

app:ui_element:google_maps:title:'Google Maps Element'short_description:'Include a Google Maps'description:'An element with a Google Maps link'link:'Link'

You have to create a template for the front and also for the admin's preview.

Here is an example of a simple template for this our which can be used in front and admin:

<iframeid="gmap_canvas"src="{{element.link }}"scrolling="no"marginheight="0"marginwidth="0"width="600"height="500"frameborder="0"></iframe>

In some cases you will want to add UI elements to your content fixtures which are Rich Editor fields. If you need files in your UI elements, you can use a dedicated fixture. It is used as follows.

sylius_fixtures:suites:my_project:fixtures:my_files:name:monsieurbiz_rich_editor_fileoptions:files:                            -source_path:'src/Resources/fixtures/bar1.png'target_path:'image/foo/bar1.png'                            -source_path:'src/Resources/fixtures/file.pdf'target_path:'baz/file.pdf'

The example below will copy files topublic/media/image/foo/bar1.png andpublic/media/foo/file.pdf.

Now you can use files in your content fixtures:

description:|    [{        "code": "app.my_ui_element",        "data": {          "title": "My title",          "image": "/media/image/foo/bar1.png",          "file": "/media/baz/file.pdf"        }    }]

You can add a wireframe to your UiElement.It will be displayed in the admin form to help the user to understand what the UiElement is about.The file can be either:

• An SVG with a.twig extension. Example:button.svg.twig.
• A classic twig template. Examplebutton.html.twig.You can add the files in the folder :templates/MonsieurBizSyliusRichEditorPlugin/wireframe/*.{svg/html}.twigIn the YAML declaration of a UI Element, you can add the wireframe key with the name of the file without the extension.

monsieurbiz.title:alias:titletitle:'monsieurbiz_richeditor_plugin.ui_element.monsieurbiz.title.title'description:'monsieurbiz_richeditor_plugin.ui_element.monsieurbiz.title.description'icon:tabler:headingwireframe:titletags:[ default ]classes:form:MonsieurBiz\SyliusRichEditorPlugin\Form\Type\UiElement\TitleTypetemplates:admin_render:'@MonsieurBizSyliusRichEditorPlugin/admin/ui_element/title.html.twig'front_render:'@MonsieurBizSyliusRichEditorPlugin/shop/ui_element/title.html.twig'

TheWysiwygType form type is a custom form type provided by the MonsieurBiz Sylius Rich Editor plugin. It extends theSymfony'sTextareaType and provides a rich text editor interface in the admin form. It will work only in admin.

To use theWysiwygType in your form, you can add it to your form builder like this:

$builder->add('content', WysiwygType::class, ['required' =>false,'label' =>'app.form.content',]);

TheWysiwygType form type accepts several options:

• editor_type: The type of the editor. Default isSunEditor::TYPE. At this time, the only supported editor type isSunEditor::TYPE.
• editor_height: The height of the editor in pixels. Default is300.
• editor_locale: The locale of the editor. Default is the current admin locale or 'en' if it cannot be determined.
• editor_toolbar_type: The type of the toolbar. It can be one of the following:EditorInterface::TOOLBAR_TYPE_MINIMAL,EditorInterface::TOOLBAR_TYPE_BASIC,EditorInterface::TOOLBAR_TYPE_FULL,EditorInterface::TOOLBAR_TYPE_CUSTOM. Default isEditorInterface::TOOLBAR_TYPE_BASIC.
• editor_toolbar_buttons: An array of buttons to be displayed in the toolbar wheneditor_toolbar_type isEditorInterface::TOOLBAR_TYPE_CUSTOM. Default isnull.
• editor_custom_config: An array of custom configuration options for the editor. Default isnull.

Here is an example of how to use these options:

$builder->add('content', WysiwygType::class, ['required' =>false,'label' =>'app.form.content','editor_height' =>500,'editor_locale' =>'fr','editor_toolbar_type' => EditorInterface::TOOLBAR_TYPE_CUSTOM,'editor_toolbar_buttons' => [        ['undo','redo'],        ['bold','underline','italic','strike'],        ['fontColor','hiliteColor'],        ['removeFormat'],        ['link'],        ['showBlocks','codeView'],    ],'editor_custom_config' => ['option1' =>'value1','option2' =>'value2'],]);

In this example, we have set a custom editor type, increased the height of the editor, set the locale to French, chosena full toolbar, specified the buttons to be displayed in the toolbar, and provided some custom configuration options forthe editor.

You can open an issue or a Pull Request if you want! 😘
Thank you!