大七/editorjs-bundle

Symfony 扩展,用于集成 Editor.js

安装: 7

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 0

分支: 11

类型:symfony-bundle

v0.1.6 2023-10-16 21:03 UTC

This package is auto-updated.

Last update: 2024-09-16 23:10:49 UTC


README

一个集成了 Editor.js 并主要与 Symfony 表单结合使用的 Symfony 扩展。

安装

Symfony

  1. 使用 composer 下载包:$ composer require tbmatuka/editorjs-bundle
  2. 如果未自动添加,请将扩展添加到 bundles.php 中:Tbmatuka\EditorjsBundle\TbmatukaEditorjsBundle::class => ['all' => true],
  3. 复制示例配置文件(examples/ediotrjs.yaml)或以此为例创建自己的配置。
  4. 将表单主题添加到你的 twig 配置中
twig:
  form_themes:
    - '@TbmatukaEditorjs/Form/editorjs_widget.html.twig'

JavaScript

examples/editorjs-init.js 中有 JS 实现的示例。

Encore/webpack

如果你使用 Encore,你需要安装 Editor.js 的 npm 包(@editorjs/editorjs)和任何你想要使用的插件。将示例复制到你的 assets 目录,将插件类添加到数组中,然后从你的主 JS 文件中导入文件。

内联

将需要为其他加载方法(如从 CDN 或在小部件内联中加载 JS)添加配置选项和示例,但现在还没有这些。

用法

Symfony 表单

你可以在你的表单中使用 EditorjsType 来在前端获取 Editor.js。数据(解码后的 json)以数组的形式返回。

Twig

你可以直接从 Twig 扩展获取 Editor.js 配置。查看 src/Resources/views/Form/editorjs_widget.html.twig 中的表单小部件,以了解如何使用它。`editorjs()` Twig 函数接受配置对象或你想要使用的配置名称。

贡献

欢迎各种帮助,特别是关于包含的 JS 在特定浏览器中不起作用的信