Rich Text for Laravel

Packages

September 16th, 2021

rich-text-laravel-featured.png

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:

1use Tonysm\RichTextLaravel\Models\Traits\HasRichText;
2 
3class Post extends Model
4{
5 use HasRichText;
6 
7 protected $guarded = [];
8 
9 protected $richTextFields = [
10 'body',
11 'notes',
12 ];
13}

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:

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

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

1// Loads all rich text fields (1 query for each field, since each, has its relationship)
2Post::withRichText()->get();
3 
4// Loads only a specific field:
5Post::withRichText('body')->get();
6 
7// Loads some specific fields (but not all):
8Post::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.

Filed in:

Paul Redmond

Full stack web developer. Author of Lumen Programming Guide and Docker for PHP Developers.