gusmanson/localtinymce

A simple, self-hosted TinyMCE with image uploads for Laravel Nova.

dev-master 2021-08-06 16:02 UTC

This package is auto-updated.

Last update: 2024-04-15 15:59:47 UTC


README

A simple, self-hosted TinyMCE with image uploads for Laravel Nova.

I needed a simple, zero-config WYSIWYG-field for Laravel Nova. Trix was too restrictive and other solutions were too messy. This is what I came up with. It's based on TinyMCE 5. This package supports image uploads (working out of the box, without dependencies or API-keys) and lets users edit HTML directly (so video embeds works fine). The toolbar can be configured.

Installation

composer require gusmanson/localtinymce

Publish the TinyMCE JS and CSS files.

artisan vendor:publish --tag=public --force

Usage

use Gusmanson\Localtinymce\Localtinymce;
public function fields(Request $request)
{
    return [
        ID::make('ID', 'id')->sortable(),
        Text::make('Name', 'name'),
        Localtinymce::make('Information', 'information')->withFiles('public')
    ];
}

Options

By default this uses a sensible toolbar and no file uploads. You can use withFiles() and withToolbar() to configure these options.

    public function withFiles($disk = null, $dir = null)
    {
      // The default storage disk is 'public', the default storage dir is 'uploads'.
    }

    public function withToolbar($toolbar)
    {
      // The default toolbar is: 'undo redo | formatselect | bold italic backcolor | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | removeformat | link image code'
      // 'image' will be removed if file upload isn't enabled
    }

Uploading

Uploading should just work out of the box! Enable it by using ->withFiles() on your field. Defaults expect you to have symlinked the public disk. The implementation is very basic. This is what happens in the upload controller:

$name = $request->file('attachment')->store($field->storageDir, $field->storageDisk);
$url = Storage::disk( $field->storageDisk )->url( $name );
return response()->json([
  'url' => $url
]);;

TinyMCE

Read about TinyMCE here.