README

Laravel Nova TinyMCE editor

This Nova package allows you to use the TinyMCE editor for text areas. You can fully customize the editor options, define reusable styling, add custom buttons and variables, and optionally upload images straight into the editor.

Requirements

• PHP ^8.0
• Laravel Nova ^4.0 or ^5.0

Installation

Install the package via Composer:

composer require marshmallow/nova-tinymce

Publish the TinyMCE JavaScript, CSS, and skin assets to your public directory:

php artisan vendor:publish --provider="Marshmallow\Nova\TinyMCE\FieldServiceProvider" --tag="resources"

This publishes the assets to public/vendor/tinymce. Republish them after every package update so the editor assets stay in sync.

Publish the config file (optional)

Publish the config to override any of the default TinyMCE settings:

php artisan vendor:publish --provider="Marshmallow\Nova\TinyMCE\FieldServiceProvider" --tag="config"

Usage

Add the TinyMCE field to the fields array of your Nova resource. The field is hidden on the index view by default.

use Marshmallow\Nova\TinyMCE\TinyMCE;

public function fields(Request $request)
{
    return [
        ID::make()->sortable(),
        TinyMCE::make(__('Content'), 'content'),
    ];
}

Set the height

The default height is defined in the nova-tinymce.php config file. Override it per field with the height() method:

TinyMCE::make('body')->height(300),

Add custom HTML (buttons)

Insert buttons or custom HTML with a single click using the buttons() method. The array key is the button label, the value is the HTML that gets inserted:

TinyMCE::make('body')->buttons([
    'Name button' => 'value of HTML',
    'Name button2' => '<p>More HTML</p>',
]),

Add variables

Insert variables with a single click using the variables() method:

TinyMCE::make('body')->variables([
    'name_var' => 'value_var',
]),

Set the toolbar

Override the toolbar string for a single field with the toolbar() method:

TinyMCE::make('body')->toolbar('undo redo | bold italic | link'),

Set the plugins

Override the active TinyMCE plugins for a single field with the plugins() method:

TinyMCE::make('body')->plugins(['lists', 'link', 'image', 'table']),

Pass any TinyMCE option

Pass any option supported by the TinyMCE JavaScript SDK through the options() method. The given options are merged on top of the defaults:

TinyMCE::make('body')->options([
    'height' => '980',
]),

See the full list of options in the TinyMCE configuration docs.

Add styling options per field

Add one or more entries to the field's style format ("Content type") selector at runtime with addStyle() and addStyles():

TinyMCE::make('body')->addStyle([
    'title' => 'Lead Paragraph',
    'block' => 'p',
    'classes' => 'lead',
]),

TinyMCE::make('body')->addStyles([
    ['title' => 'Lead Paragraph', 'block' => 'p', 'classes' => 'lead'],
    ['title' => 'Muted', 'inline' => 'span', 'classes' => 'text-muted'],
]),

Add custom styling for all fields

To add styling options available on every TinyMCE field, publish the config and add entries to the custom_items array. These appear in the editor's "Content type" selector:

'custom_items' => [
    // This adds a .lead class on the paragraph tag.
    [
        'title' => 'Lead Paragraph',
        'block' => 'p',
        'classes' => 'lead',
    ],
],

File manager support

The package ships a use_lfm config option to integrate with a Laravel file manager (set use_lfm to true and configure lfm_url). After installing your file manager, run the bundled command to drop in the package's file manager view override:

php artisan nova-tinymce:support-lfm

Configuration

The published config/nova-tinymce.php file exposes the defaults that are applied to every field. The most common keys:

See config/nova-tinymce.php for the complete list of available keys.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Security

If you discover any security related issues, please email stef@marshmallow.dev instead of using the issue tracker.

Credits

• All Contributors

License

The MIT License (MIT). Please see the License File for more information.