EasyAdmin Text Editor Field

Edit this page

This field creates a JavaScript-based WYSIWYG editor based on the Trix editor to manage long texts.

In form pages (edit and new) it looks like this:

Default style of EasyAdmin text editor field

Tip

EasyAdmin provides other fields for long text contents: TextAreaField is ideal for long contents that don't need any formatting; CodeEditorField is ideal to edit and store any kind of source code.

Basic Information

  • PHP Class: EasyCorp\Bundle\EasyAdminBundle\Field\TextEditorField
  • Doctrine DBAL Type used to store this value: text
  • Symfony Form Type used to render the field: TextEditorType, which is based on Symfony's TextareaType

  • Rendered as:

    1
2
    <!-- when loading the page this is transformed into a WYSIWYG editor via JavaScript -->
<textarea> ... </textarea>

Options

setNumOfRows

The height of the editor used in form pages (new and edit) is as large as needed to display its contents. This height also grows dynamically (via JavaScript) to always match the number of rows of its contents.

This option sets the number of rows displayed when the field contents are empty. By default, the initial height is small, so it's a good idea to increase this value when the expected content is much longer (e.g. a blog post):

1
yield TextEditorField::new('...')->setNumOfRows(30);

setTrixEditorConfig

This option allows you to pass a PHP array of the configuration options to set or update in the JavaScript Trix editor used by this field:

1
2
3
4
5
6
7
8
9
yield TextEditorField::new('...')->setTrixEditorConfig([
    'blockAttributes' => [
        'default' => ['tagName' => 'p'],
        'heading1' => ['tagName' => 'h2'],
    ],
    'css' => [
        'attachment' => 'admin_file_field_attachment',
    ],
]);

Check out the src/trix/config/ folder at Trix editor repository to learn about all the available configuration options.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.
TOC
    Version