bayareawebpro/nova-field-ckeditor

This package is abandoned and no longer maintained. No replacement package was suggested.

A Laravel Nova field.

v1.1.3 2022-02-09 00:48 UTC

Requires

• php: ^7.4|^8.0
• intervention/image: ^2.5
• laravel/framework: ^8.0|^9.0
• spatie/laravel-image-optimizer: ^1.6

MIT

• nova
• laravel

README

EOL NOTICE: No further development is planned. This repository will be archived eventually, feel free to fork it and maintain your own version.

Laravel Nova - CkEditor v5 Field

Media, Links & Snippet Browsers (VueJS)

Includes custom written plugins for Media, Links & Snippet Modals. Publishable stubs for out-of-the-box usage. Implement rich content editing in minutes.

Fields Included:

• CkEditor Field
• FeaturedMedia Field
• MediaUpload Field

Packages Included:

• Spatie Image Optimizer
• Intervention Image

Installation

composer require bayareawebpro/nova-field-ckeditor
php artisan vendor:publish --tag=config

Install Optimizers

See: https://github.com/spatie/laravel-image-optimizer

Publish Stubs: Models, Resources, Migrations, Views

Review the included stubs to see the intended implementation.

https://github.com/bayareawebpro/nova-field-ckeditor/tree/master/stubs

php artisan vendor:publish --tag=nova-ckeditor-stubs

Editor Field Usage:

CkEditor::make('Content')
    ->rules('required')
    ->hideFromIndex()
    ->mediaBrowser()
    ->linkBrowser()
    ->height(60)
    ->stacked()
    ->snippets([
        ['name' =>'Cool Snippet1', 'html'=> view('snippets.1')->render()],
        ['name' =>'Cool Snippet2', 'html'=> view('snippets.2')->render()],
        ['name' =>'Cool Snippet3', 'html'=> view('snippets.3')->render()],
    ])
    ->toolbar([
        'heading',
        'horizontalLine',
        '|',
        'link',
        'linkBrowser',
        '|',
        'bold',
        'italic',
        'alignment',
        'subscript',
        'superscript',
        'underline',
        'strikethrough',
        '|',
        'blockQuote',
        'bulletedList',
        'numberedList',
        '|',
        'insertTable',
        'mediaEmbed',
        'mediaBrowser',
        'insertSnippet',
        '|',
        'undo',
        'redo'
    ]),

Note: Snippets will only render CkEditor Elements.
Standard HTML or Figures (table, image, video), see included views. https://ckeditor.com/docs

Recommended Package:

https://github.com/bayareawebpro/laravel-dom-pipeline

FeaturedMedia Field Usage:

FeaturedMedia::make('Image','media_id')
    ->rules('nullable')
    ->sizeOnDetail(800, 600)
    ->sizeOnForms(600, 400)
    ->sizeOnIndex(100,100)
    ->stacked(),

MediaUpload Field Usage:

Note this field is not updatable by default. Replacing media may result in broken images. Delete and re-upload is the intended methodology.

MediaUpload::make('File', $disk='media')
    ->rules('required','mimes:jpg,jpeg,png,gif', 'max:5000')
    ->help('5MB Max FileSize.')
    ->maxWidth(800),

Media Local Disk

'media' => [
    'driver' => 'local',
    'root' => storage_path('app/public/media'),
    'url' => env('APP_URL').'/storage/media',
    'visibility' => 'public',
],

Media Cloud Disk

'media' => [
    'driver' => 's3',
    'key' => env('SPACES_KEY'),
    'secret' => env('SPACES_SECRET'),
    'endpoint' => env('SPACES_ENDPOINT'),
    'region' => env('SPACES_REGION'),
    'bucket' => env('SPACES_BUCKET'),
    'root' => 'media',
    'url' => 'https://'.env('SPACES_BUCKET').'.'.env('SPACES_REGION').'.cdn.digitaloceanspaces.com/media',
    'options' => [ 'CacheControl' => 'max-age=31536000, public' ],
],

MediaStorage

Override the MediaStorage Service by binding your own extended version.

use Illuminate\Http\Request;
use BayAreaWebPro\NovaFieldCkEditor\MediaStorage;
class MyMediaStorage extends MediaStorage
{
    public function __invoke(Request $request)
    {
        // TODO: Change the default implementation.
    }
}
$this->app->bind('ckeditor-media-storage', MyMediaStorage::class);