jacobfitzp/nova-tinymce

A Laravel Nova field.

1.0.3 2024-06-08 18:58 UTC

Requires

• php: ^7.3|^8.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.58
• larastan/larastan: ^2.0
• laravel/nova: ^4.0
• orchestra/testbench: ^9.1

MIT

• nova
• laravel

README

Features

• 🔧 Fully configurable
• 🌄 Image uploads
• 🎨 Light and dark mode

Prerequisites

• Laravel >= 11
• PHP >= 8.0
• Laravel Nova >= 4
• TinyMCE API Key (get one here)

Installation

You can install the package via composer:

composer require jacobfitzp/nova-tinymce

Usage

Before you start using the TinyMCE field you need to set your API key, the easiest way to do this is by setting TINYMCE_API_KEY environment variable. Alternatively you can publish the configuration file and set it there.

Now you can simply use the Tinymce field in your Nova resource:

Tinymce::make('Content')
    ->fullWidth(),

Configuration

Publish the configuration file:

php artisan vendor:publish --tag=nova-tinymce

Plugins

By default, a set of the most commonly used free plugins are enabled, you can change this to suit your needs by configuring the plugins array.

More information here.

Toolbar

By default, the toolbar is generated by TinyMCE. But you can easily customize it with the toolbar config.

More information here.

Image uploads

Image uploads should work out of the box with Nova's default storage disk, while this is enough for most cases you can easily configure or even replace the server-side implementation.

storage_disk

The disk you want to use for image storage, if not provided then it falls back to Nova's default disk (nova.storage_disk).

storage_path

The path you want to store uploaded images in, by default its ./nova-tinymce.

storage_max

The maximum allowed filesize in kilobytes, defaults to 20,000 (20MB).

storage_endpoint

Relative path to the API endpoint responsible for handling image uploads, generally you shouldn't need to touch this as one is provided, but if you have very specific requirements you can override it with your own endpoint.

The endpoint needs to accept a POST request with a file (file), and respond a URL to the uploaded image in the following format:

{ "location": "https://example-cdn.com/nova-tintmce/my-image.jpg" }

Everything else

For most other things you can pass configuration options directly to the editor component via the init configuration property.

More information here.

License

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