• Reading time ~ 1 min
  • 24.08.2022

Rich Text Laravel integrates the Trix Editor with Laravel and is inspired by the Action Text gem from Rails.

This package provides everything necessary to store, create, and update rich text in associated models using the Trix editor:

  • Database schema design to make it easy to associate rich text with models
  • Handle image attachments and uploads
  • Support for Trix content attachments
  • Retrieve content objects, such as attachments, links, etc.
  • Plain text rendering

This package is flexible in that you can use it the recommended way or a more lightweight cast that lets you store rich text on any model:

  1. Use the provided package database structure where all rich content is stored outside the model with associated rich content.
  2. Use the package's AsRichTextContent trait to cast a rich content field on any model

Here's an example using #1 above, which is a Post model that has two rich text fields:

use Tonysm\RichTextLaravel\Models\Traits\HasRichText;
 
class Post extends Model
{
    use HasRichText;
 
    protected $guarded = [];
 
    protected $richTextFields = [
        'body',
        'notes',
    ];
}

This package also makes it easy to get and set fields on the related model, by forwarding calls on to the relationship from the Post model in the readme example:

$post = Post::create(['body' => $body, 'notes' => $notes]);

The package also takes care of querying the rich text data:

// Loads all rich text fields (1 query for each field, since each, has its relationship)
Post::withRichText()->get();
 
// Loads only a specific field:
Post::withRichText('body')->get();
 
// Loads some specific fields (but not all):
Post::withRichText(['body', 'notes'])->get();

The package's readme has plenty of examples and instructions on how to get started. You can learn more about this package, get full installation instructions, and view the source code on GitHub.

Comments

No comments yet
Yurij Finiv

Yurij Finiv

Full stack

ABOUT

Professional Fullstack Developer with extensive experience in website and desktop application development. Proficient in a wide range of tools and technologies, including Bootstrap, Tailwind, HTML5, CSS3, PUG, JavaScript, Alpine.js, jQuery, PHP, MODX, and Node.js. Skilled in website development using Symfony, MODX, and Laravel. Experience: Contributed to the development and translation of MODX3 i...

About author CrazyBoy49z
WORK EXPERIENCE
Contact
Ukraine, Lutsk
+380979856297