caiquebispo/quill-editor

A Quill Editor component for Laravel Livewire.

Maintainers

Details

github.com/caiquebispo/quill-editor

Source

Issues

Installs: 18

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 0

Open Issues: 0

Language:Blade

v1.1.2 2025-06-29 15:39 UTC

Requires

MIT 10144c251ade1bf574f82246f82be4559587b10e

  • Caique Bispo <caiquebispo0023.woop@gmail.com>

wysiwygeditorlaravelquillrich-text-editorlivewire

This package is auto-updated.

Last update: 2025-06-29 15:40:15 UTC

README

Livewire 3 component for rich text editing powered by Quill.js.
Supports editing with headings, bold, italic, lists, links, images, videos, alignment, colors, and more, fully integrated with Laravel and Livewire for seamless form and CMS workflows.

New Features:

  • ✅ Multiple instances support on the same page
  • ✅ Pre-loaded content from database for editing
  • ✅ Improved event handling for better reliability
  • ✅ Enhanced cleanup and memory management

Requirements

  • PHP >=8.2
  • Livewire >= 3

Installation

composer require caiquebispo/quill-editor

In your main layout file (for example, resources/views/layouts/app.blade.php), include:

<head>
    ...
    @stack('styles')
</head>
<body>
    ...
    @stack('scripts')
</body>

Publishing assets and configuration

For publishing the configuration and assets, run the following commands:

php artisan vendor:publish --provider="CaiqueBispo\QuillEditor\QuillEditorServiceProvider" --tag=config

php artisan vendor:publish --provider="CaiqueBispo\QuillEditor\QuillEditorServiceProvider" --tag=assets

This will create the config/quill.php file and copy the necessary assets to your public directory.

Usage

Basic Usage

Create a Livewire component to use the Quill editor:

php artisan make:livewire EditorComponent

📁 app/Livewire/EditorComponent.php

<?php

namespace App\Livewire;

use Livewire\Component;
use Illuminate\Contracts\View\View;
use Livewire\Attributes\On;

class EditorComponent extends Component
{
    public string $content = '';

    #[On('quillUpdated')]
    public function quillUpdated(string $content, string $editorId): void
    {
        $this->content = $content;
    }
    
    public function save(): void
    {
        // Save your content to database
        // Example: Post::create(['content' => $this->content]);
        
        session()->flash('message', 'Content saved successfully!');
    }

    public function render(): View
    {
        return view('livewire.editor-component');
    }
}

resources/views/livewire/editor-component.blade.php

<div>
    <livewire:quill-editor :content="$content" />
    
    <div class="mt-4">
        <button wire:click="save" class="btn btn-primary">
            Save Content
        </button>
    </div>
    
    @if (session()->has('message'))
        <div class="alert alert-success mt-2">
            {{ session('message') }}
        </div>
    @endif
</div>

Loading Existing Content

To load existing content from your database:

<?php

namespace App\Livewire;

use App\Models\Post;
use Livewire\Component;
use Livewire\Attributes\On;

class PostEditor extends Component
{
    public Post $post;
    public string $content = '';

    public function mount(Post $post): void
    {
        $this->post = $post;
        $this->content = $post->content ?? '';
    }

    #[On('quillUpdated')]
    public function quillUpdated(string $content, string $editorId): void
    {
        $this->content = $content;
    }

    public function save(): void
    {
        $this->post->update([
            'content' => $this->content
        ]);
        
        session()->flash('message', 'Post updated successfully!');
    }

    public function render()
    {
        return view('livewire.post-editor');
    }
}
<div>
    <h2>Editing: {{ $post->title }}</h2>
    
    <livewire:quill-editor 
        :content="$content" 
        :config="['height' => '400px']" />
    
    <button wire:click="save" class="btn btn-success mt-3">
        Update Post
    </button>
</div>

Multiple Instances

You can now use multiple Quill editors on the same page:

<div class="grid grid-cols-2 gap-6">
    {{-- Main Content Editor --}}
    <div>
        <h3>Main Content</h3>
        <livewire:quill-editor 
            :content="$post->content" 
            :config="['height' => '300px', 'placeholder' => 'Write your main content...']" />
    </div>
    
    {{-- Excerpt Editor --}}
    <div>
        <h3>Excerpt</h3>
        <livewire:quill-editor 
            :content="$post->excerpt" 
            :config="['height' => '150px', 'placeholder' => 'Write a short excerpt...']" />
    </div>
</div>

Configuration

You can customize the editor by passing a configuration array to the component:

<livewire:quill-editor
    :content="$content"
    :config="[
        'theme' => 'bubble',
        'placeholder' => 'Digite seu texto...',
        'height' => '400px',
        'readOnly' => false,
        'modules' => [
            'toolbar' => [
                ['bold', 'italic', 'underline', 'strike'],
                ['blockquote', 'code-block'],
                [['header' => 1], ['header' => 2]],
                [['list' => 'ordered'], ['list' => 'bullet']],
                ['link', 'image', 'video'],
                ['clean']
            ]
        ],
        'formats' => [
            'bold', 'italic', 'underline', 'strike',
            'blockquote', 'code-block', 'header',
            'list', 'bullet', 'link', 'image', 'video'
        ]
    ]"
/>

Available Configuration Options

Option Type Default Description
theme string 'snow' Quill theme ('snow' or 'bubble')
placeholder string 'Digite aqui...' Placeholder text
height string '200px' Editor height
readOnly boolean false Read-only mode
modules array [] Quill modules configuration
formats array [] Allowed formats

Component Methods

The Quill Editor component provides several useful methods:

Programmatic Control

// In your Livewire component
public function clearEditor(): void
{
    $this->dispatch('clearEditor');
}

public function focusEditor(): void
{
    $this->dispatch('focusEditor');
}

public function toggleEditor(bool $disabled = true): void
{
    $this->dispatch('toggleEditor', disabled: $disabled);
}

public function selectAllEditor(): void
{
    $this->dispatch('selectAllEditor');
}

Content Methods

// Access the editor component directly
$editor = $this->getChild('quill-editor');

// Get plain text (without HTML tags)
$plainText = $editor->getPlainText();

// Get word count
$wordCount = $editor->getWordCount();

// Check if editor is empty
$isEmpty = $editor->isEmpty();

// Set content programmatically
$editor->setContent('<p>New content here</p>');

Events

The component dispatches the following events:

quillUpdated

Fired when the editor content changes:

#[On('quillUpdated')]
public function handleContentUpdate(string $content, string $editorId): void
{
    // Handle the updated content
    $this->content = $content;
}

Advanced Usage

Custom Toolbar Configuration

<livewire:quill-editor
    :content="$content"
    :config="[
        'modules' => [
            'toolbar' => [
                [['size' => ['small', false, 'large', 'huge']]],
                [['header' => [1, 2, 3, 4, 5, 6, false]]],
                ['bold', 'italic', 'underline', 'strike'],
                [['color' => []], ['background' => []]],
                [['script' => 'sub'], ['script' => 'super']],
                [['header' => 1], ['header' => 2], 'blockquote', 'code-block'],
                [['list' => 'ordered'], ['list' => 'bullet'], ['indent' => '-1'], ['indent' => '+1']],
                [['direction' => 'rtl'], ['align' => []]],
                ['link', 'image', 'video', 'formula'],
                ['clean']
            ]
        ]
    ]"
/>

Image Upload Integration

// In your Livewire component
public function uploadImage($image)
{
    $path = $image->store('images', 'public');
    $url = Storage::url($path);
    
    // Inject image into editor
    $this->dispatch('insertImage', url: $url);
}

Troubleshooting

Common Issues

  1. Multiple instances not working: Ensure each instance has a unique ID
  2. Content not loading: Check that the content is properly passed to the :content attribute
  3. Styles not loading: Make sure @stack('styles') is in your layout's <head>
  4. Scripts not working: Ensure @stack('scripts') is before the closing </body> tag

Debug Mode

Enable debug mode to see console logs:

<livewire:quill-editor 
    :content="$content" 
    :config="['debug' => true]" />

License

MIT © Caique Bispo