bolt/redactor

📝 Bolt Extension to add the Redactor FieldType

Maintainers

Details

github.com/bolt/redactor

Source

Issues

Installs: 52 379

Dependents: 1

Suggesters: 0

Security: 0

Stars: 7

Watchers: 9

Forks: 8

Open Issues: 4

Language:JavaScript

Type:bolt-extension

2.1.2 2022-11-28 12:18 UTC

README

This extension provides a "Redactor" field type, which is a sophisticated, lightweight and elegant WYSIWYG editor component for Bolt. The editor itself is developed by Imperavi, and is licensed for usage in Bolt.

This extension allows you to add fields of type: redactor in your ContentTypes, as defined in contenttypes.yaml, like any other Field type.

Installation

Note: Installation is not required if you've installed the default Bolt project. In that case it's already present. If you've installed Bolt through different means, you'll need to run the command below:

composer require bolt/redactor

After installation, you can add it to any ContentType in your contenttypes.yaml, like any other field. For example:

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

The result will be like this:

You can configure the editor in config/extensions/bolt-redactor.yaml. This configuration affects all the instances of the Redactor field that you've configured in your ContentTypes. The default configuration looks like this:

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

plugins:
  ~

Configuring the buttons

Bolt's version of Redactor ships with all the official plugins and options. you can add or remove buttons by configuring them in the buttons: and plugins: parameters. Check the official Redactor documentation for all available buttons. Note that some buttons might require you to enable the corresponding plugin as well. See here for a list of the available plugins.

Settings

Where applicable, you can add extra settings under the default: key in the bolt-redactor.yaml configuration. See the documentation for available settings.

Note that this documentation uses Javascript, whilst Bolt's configuration uses Yaml. For example, the documentation for 'Paste' has this example:

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

In bolt-redactor.yaml you can add this as:

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

Adding custom plugins

If you've written your own plugin for Redactor according to the documentation for Creating Plugins, you can add it to the editor in Bolt, by placing it in /public/assets/redactor/plugins. Then, add it to the bolt-redactor.yaml configuration:

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

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

The part below is only for developing the extension. Not required for general usage of the extension in your Bolt Project

Running PHPStan and Easy Codings Standard

First, make sure dependencies are installed:

COMPOSER_MEMORY_LIMIT=-1 composer update

And then run ECS:

vendor/bin/ecs check src --fix