SunEditor Field for Laravel Nova

This package provides a custom field for Laravel Nova that integrates the SunEditor, a lightweight and flexible WYSIWYG editor.

Features

• Rich text editing capabilities with SunEditor.
• Seamless integration with Laravel Nova.
• Easy configuration and customization.
• Emoji support within editor.

Installation

To install the custom field, follow these steps:

1. Install the package via Composer:

   composer require webard/nova-suneditor
   

2. Publish the assets:

   php artisan vendor:publish --provider="Webard\NovaSunEditor\FieldServiceProvider"
   

Usage

To use the SunEditor field in your Laravel Nova resource, follow these steps:

1. Import the field in your Nova resource file:

   use Webard\NovaSunEditor\SunEditor;
   

2. Add the field to the fields method of your Nova resource:

public function fields(Request $request)
{
    return [
        ID::make()->sortable(),

        SunEditor::make('Content', 'content')
            ->rules('required', 'string')
            ->hideFromIndex(),
    ];
}

File upload

SunEditor supports uploading by drag&drop or pasting image directly into editor field. To enable upload, provide withFiles() method, like in Trix field:

public function fields(Request $request)
{
    return [
        ID::make()->sortable(),

        SunEditor::make('Content', 'content')
            ->withFiles('disk','path/to/attachments')
    ];
}

Unfortunately, upload does not work out of the box with fields in Nova Actions (Trix has same problem). If you need to upload files in Action modal, provide path to upload in settings and handle upload by yourself:

public function fields(Request $request)
{
    return [
        ID::make()->sortable(),

        SunEditor::make('Content', 'content')
            ->withFiles('disk','path/to/attachments')
            ->settings([
                'imageUploadUrl' => '/your/path/to/handle/upload',
            ]),
    ];
}

Customization

The SunEditor field can be customized by some methods:

1. In nova-suneditor.php you can define more buttonLists and name them. Then, you can use buttonList using buttonListName method.

SunEditor::make('Content', 'content')
    ->buttonListName('my-buttons')

2. You can define buttonList directly in field definition:

SunEditor::make('Content', 'content')
    ->buttonList([
        [
            'undo',
            'redo',
            'bold'
        ]
    ]);

3. You can change settings directly in field definition:

SunEditor::make('Content', 'content')
    ->settings([
        'minHeight' => '500px'
    ]);

TODO

I'm are actively seeking contributions to enhance this package. Here are some features I would love to see implemented:

• [ ] multi-language
• [ ] image browser
• [ ] purging stale attachments like in Trix field

Contributing

We welcome contributions to improve this plugin! Please follow these steps to contribute:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive messages.
4. Push your changes to your forked repository.
5. Open a pull request to the main repository.

License

This project is licensed under the MIT License. See the LICENSE.md file for more details.

Acknowledgements

• SunEditor - Excellent WYSIWYG editor.
• Picmo - The emoji picker library used in this plugin.

Contact

For questions or support, please open an issue on GitHub.