bolt/红actor

📝 Bolt 扩展,用于添加 Redactor 字段类型

维护者

详细信息

github.com/bolt/redactor

源代码

问题

安装量: 108,750

依赖项: 1

建议者: 0

安全性: 0

星标: 11

关注者: 10

分支: 11

开放问题: 3

语言:JavaScript

类型:bolt-extension

2.1.5 2023-03-09 13:29 UTC

README

此扩展提供了一种“红actor”字段类型,这是一个复杂、轻量级且优雅的 WYSIWYG 编辑器组件,适用于 Bolt。编辑器本身由 Imperavi 开发,并授权在 Bolt 中使用。

此扩展允许您在 contenttypes.yaml 中添加 type: redactor 字段,就像添加其他字段类型一样。

安装

注意:如果您已安装默认的 Bolt 项目,则无需安装。在这种情况下,它已经存在。如果您通过其他方式安装了 Bolt,则需要运行以下命令

composer require bolt/redactor

安装后,您可以在 contenttypes.yaml 中的任何内容类型中添加它,就像添加任何其他字段一样。例如

blogposts:
    name: Blogposts
    singular_name: Blogpost
    fields:
        title:
            type: text
        slug:
            type: slug
            uses: title
        content:
            type: redactor

结果将如下所示

您可以在 config/extensions/bolt-redactor.yaml 中配置编辑器。此配置会影响您在内容类型中配置的所有 Redactor 字段的实例。默认配置如下所示

default:
  buttons: [ bold, italic, format, lists, link, html, image ]
  plugins: [ fullscreen, table, inlinestyle, video, widget ]
  source: true

plugins:
  ~

配置按钮

Bolt 版本的 Redactor 随带所有官方插件和选项。您可以通过在 buttons:plugins: 参数中配置它们来添加或删除按钮。请参阅官方 Redactor 文档中的 所有可用按钮。请注意,某些按钮可能需要您启用相应的插件。请在此处查看 可用的插件 列表。

设置

在适用的情况下,您可以在 bolt-redactor.yaml 配置中的 default: 键下添加额外的设置。请参阅文档了解可用设置。

请注意,此文档使用 JavaScript,而 Bolt 的配置使用 YAML。例如,有关 '粘贴' 的文档中有此示例

$R('#content', {
        pastePlainText: true
});

bolt-redactor.yaml 中,您可以添加如下内容

default:
  buttons: [ …]
  plugins: [ … ]
  pastePlainText: true

添加自定义插件

如果您根据 创建插件的文档 为 Redactor 编写了自己的插件,您可以通过将其放置在 /public/assets/redactor/plugins 中将其添加到 Bolt 的编辑器中。然后,将其添加到 bolt-redactor.yaml 配置中

default:
  buttons: [ … ]
  plugins: [ … ]

plugins:
  myplugin: [ 'myplugin/myplugin.js', 'myplugin/myplugin.css' ]

下面的部分仅适用于 开发 扩展。对于在 Bolt 项目中一般使用扩展,无需此部分

运行 PHPStan 和 Easy Codings Standard

首先,确保已安装依赖项

COMPOSER_MEMORY_LIMIT=-1 composer update

然后运行 ECS

vendor/bin/ecs check src --fix