@kookaat/strapi-plugin-tinymce

1.1.2 • Public • Published

Strapi plugin TinyMCE

Replaces the default Strapi WYSIWYG editor with a customized build of TinyMCE editor.

Differences with the original version

The main difference in this forked repository is that, it only works with the self-host mode. The cloud-host mode has been completely disabled.

To set the source of the hosted script, you need to set tinymceScriptSrc value in config/plugins.js of your strapi project like below:

module.exports = () => ({
    tinymce: {
        enabled: true,
        config: {
            editor: {
                tinymceScriptSrc: "/path/to/tinymce.min.js",
            },
        },
    },
});

👋 Intro

✨ Key features

  • Anchor: Add an anchor/bookmark button to the toolbar that inserts an anchor at the editor’s cursor insertion point.
  • Autolink: Create hyperlinks automatically when a user inputs a valid and complete URL.
  • Autoresize: Resize the editor automatically to the content inside it, and prevent the editor from expanding infinitely.
  • Code: Add a toolbar button that allows a user to edit the HTML code hidden by the WYSIWYG view.
  • Code sample: Insert and embed syntax color highlighted code snippets into the editable area.

And much more ! List of all features.

🔧 Installation

Inside your Strapi app, add the package:

With npm:

npm install @kookaat/strapi-plugin-tinymce

With yarn:

yarn add @kookaat/strapi-plugin-tinymce

In config/plugins.js file add:

tinymce:{
    enabled:true
}
;

If you do not yet have this file, then create and add:

module.exports = () => ({
    tinymce: {
        enabled: true
    };
})

You will also have to update strapi::security middleware in your middlewares.js file in config folder. If you didn't update this file yet, then replace "strapi::security" with following code (object)

//middlewares.js

{
    name: "strapi::security",
        config
:
    {
        contentSecurityPolicy: {
            useDefaults: true,
                directives
        :
            {
                "script-src"
            :
                ["'self'", "*.tinymce.com", "*.tiny.cloud", "https:"],
                    "connect-src"
            :
                ["'self'", "*.tinymce.com", "*.tiny.cloud", "blob:", "*.strapi.io"],
                    "img-src"
            :
                [
                    "'self'",
                    "*.tinymce.com",
                    "*.tiny.cloud",
                    "data:",
                    "blob:",
                    "dl.airtable.com",
                    "strapi.io",
                    "s3.amazonaws.com",
                    "cdn.jsdelivr.net",
                ],
                    "style-src"
            :
                [
                    "'self'",
                    "'unsafe-inline'",
                    "*.tinymce.com",
                    "*.tiny.cloud",
                ],
                    "font-src"
            :
                ["'self'", "*.tinymce.com", "*.tiny.cloud"],
            }
        ,
            upgradeInsecureRequests: null,
        }
    ,
    }
,
}
,

Then run build:

npm run build

or

yarn build

After starting your project please add API key for your TinyMCE editor in admin panel in settings/tinymce/configuration

If TinyMCE editor doesn't appear in your richtext field, please check your console for any hints, you might have incorrectly set your middlewares.

⚙️ Configuration

TinyMCE outputFormat should be defined in config.editor, and init object should be defined in config.editor.editorConfig field in plugins.js file.

⚠️ plugins.js not plugin.js ⚠️

plugins.js file should be placed in config folder.

Learn more about configuration from official documentation.

Default configuration:

// plugins.js
module.exports = ({env}) => ({
    tinymce: {
        enabled: true,
        config: {
            editor: {
                outputFormat: "html",
                editorConfig: {
                    language: "sk",
                    height: 500,
                    menubar: false,
                    extended_valid_elements: "span, img, small",
                    forced_root_block: "",
                    convert_urls: false,
                    entity_encoding: "raw",
                    plugins:
                        "advlist autolink lists link image charmap preview anchor \
                        searchreplace visualblocks code fullscreen table emoticons nonbreaking \
                        insertdatetime media table code help wordcount",
                    toolbar:
                        "undo redo | styles | bold italic forecolor backcolor | \
                        alignleft aligncenter alignright alignjustify | \
                        media table emoticons visualblocks code|\
                        nonbreaking bullist numlist outdent indent | removeformat | help",
                    style_formats: [
                        {
                            title: "Headings",
                            items: [
                                {title: "h1", block: "h1"},
                                {title: "h2", block: "h2"},
                                {title: "h3", block: "h3"},
                                {title: "h4", block: "h4"},
                                {title: "h5", block: "h5"},
                                {title: "h6", block: "h6"},
                            ],
                        },

                        {
                            title: "Text",
                            items: [
                                {title: "Paragraph", block: "p"},
                                {
                                    title: "Paragraph with small letters",
                                    block: "small",
                                },
                            ],
                        },
                    ],
                },
            },
        },
    },
});

⚠️ Requirements

Strapi v4.x.x+

Node 14 - 20

Tested on v4.3.4

Package Sidebar

Install

npm i @kookaat/strapi-plugin-tinymce

Weekly Downloads

2

Version

1.1.2

License

MIT

Unpacked Size

33.2 kB

Total Files

40

Last publish

Collaborators

  • mhzendehpey