Rich content faker

RichContentFaker builds rich editor content a block at a time, then renders it as HTML, JSON or plain text. It is intended for seeders, factories and tests, where you want content that exercises the editor's node types rather than a wall of lorem ipsum.

use Awcodes\RicherEditor\Support\RichContentFaker;

$content = RichContentFaker::make()
    ->heading(level: 2)
    ->paragraphs(count: 2, links: true)
    ->list(count: 3, ordered: false)
    ->blockquote()
    ->asHtml();

Calls append in order, so the sequence you chain is the order the content comes out in. Finish with exactly one of asHtml(), asJson() or asText().

Blocks

Marks within paragraphs

paragraphs() takes a flag per mark, all defaulting to false, so you can generate text that exercises a particular one:

use Awcodes\RicherEditor\Support\RichContentFaker;

RichContentFaker::make()
    ->paragraphs(
        count: 1,
        links: true,
        code: true,
        bold: true,
        italic: true,
        underline: true,
        strike: true,
        subscript: true,
        superscript: true,
        highlight: true,
        lead: false,
        small: false,
        mergeTags: ['first_name', 'last_name'],
    )
    ->asHtml();

mergeTags sprinkles merge tags from the names you pass. lead and small apply those styles to the generated paragraphs.

Custom blocks

Generate a custom block by id, with whatever config that block expects:

use Awcodes\RicherEditor\Support\RichContentFaker;

RichContentFaker::make()
    ->customBlock(
        id: 'batman',
        config: [
            'name' => 'Batman',
            'color' => 'black',
            'side' => 'hero',
        ],
    )
    ->asHtml();

Output

asHtml() returns an HTML string, asJson() returns the content as an array of Tiptap nodes, and asText() returns plain text.

To render through a renderer you have configured yourself — with custom blocks registered, for instance — pass it to renderUsing() before calling asHtml().