包简介

README 文档

README

This package simply converts the JSON output from the Tiptap editor to HTML. It differs from other packages by allowing you to easily customise and extend the HTML output.

Installation

composer require freshleafmedia/tiptap-parser

Basic Usage

use FreshleafMedia\TiptapParser\TiptapContent;

$tiptapArray = [
    'type' => 'paragraph',
    'content' => [
        [
            'type' => 'text',
            'text' => 'Hello world',
        ],
    ],
];

TiptapContent::make($tiptapArray)->toHtml(); // <p>Hello world</p>

Customising A Node

use FreshleafMedia\TiptapParser\Nodes\Paragraph;

readonly class CustomParagraph extends Paragraph
{
    public function render(): string
    {
        return <<<HTML
            <p class="paragraph">
                {$this->renderInnerHtml()}
            </p>
            HTML;
    }
}

$html = Parser::fromArray($tiptapArray)
    ->registerNode('paragraph', CustomParagraph::class)
    ->toHtml(); // <p class="paragraph">Hello world</p>

Accessing Custom Attributes

Nodes are instantiated via the fromArray method, the method is passed all the data from the original array.

For example given this array:

[
    'type' => 'paragraph',
    'attrs' => [
        'lang' => 'en',
    ]
]

We can easily add the lang attribute to the p element like this:

use FreshleafMedia\TiptapParser\Nodes\Paragraph;

readonly class LocalisedParagraph extends Paragraph
{
    public function __construct(
        public string $language,
        public array $children = [],
    )
    {
    }

    public function render(): string
    {
        return <<<HTML
            <p lang="{$this->language}">
                {$this->renderInnerHtml()}
            </p>
            HTML;
    }

    public static function fromArray(array $array): self
    {
        return new self(
            $array['attrs']['lang'] ?? 'en',
            $array['children'] ?? [],
        );
    }
}

Plain Text

Plain text can be extracted available via the toText method. This is useful for things like populating a search index.

use FreshleafMedia\TiptapParser\TiptapContent;

$tiptapArray = [
    'type' => 'paragraph',
    'content' => [
        [
            'type' => 'text',
            'text' => 'Hello world',
            'marks' => [
                ['type' => 'bold'],
            ],
        ],
    ],
];

TiptapContent::make($tiptapArray)->toHtml(); // <p><strong>Hello world</strong></p>
TiptapContent::make($tiptapArray)->toText(); // Hello world

freshleafmedia/tiptap-parser 适用场景与选型建议

freshleafmedia/tiptap-parser 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 677 次下载、GitHub Stars 达 2，最近一次更新时间为 2024 年 04 月 30 日，在 PHP 生态内属于活跃度较高的组件。

我们在过去多个企业项目中使用过 freshleafmedia/tiptap-parser 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 freshleafmedia/tiptap-parser 我们能提供哪些服务？

定制开发 / 二次开发

基于 freshleafmedia/tiptap-parser 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

freshleafmedia/tiptap-parser

包简介