Skip to content

A basic FilamentPHP v3 CKEditor 5 field configured to use non-premium features

License

Notifications You must be signed in to change notification settings

Kahu-Software-LLC/filament-ckeditor-field

Repository files navigation

A basic CKEditor 5 form field configured with non-premium features.

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

This repository enables FilamentPHP forms to use CKEditor 5 and its many free features without much configuration.

Installation

You can install the package via composer:

composer require kahusoftware/filament-ckeditor-field

You can publish the config file with:

php artisan vendor:publish --tag="filament-ckeditor-field-config"

This is the contents of the published config file:

return [
    /**
     * Image upload enabled
     * 
     * WARNING: Setting this to false will use CKEditor's default Base64 upload method which is HIGHLY INEFFICIENT.
     * https://ckeditor.com/docs/ckeditor5/latest/features/images/image-upload/image-upload.html#base64-adapter
     */
    'upload_enabled' => true,

    /**
     * Image URL to upload to if one is not specified on the form field's ->uploadUrl() method
     */
    'upload_url' => null,
];

Usage

use Kahusoftware\FilamentCkeditorField\CKEditor;

CKEditor::make('content')
    ->uploadUrl(null)

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

About

A basic FilamentPHP v3 CKEditor 5 field configured to use non-premium features

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published