Magnus Baneryd
May 22, 2018
  2263
(8 votes)

TinyMCE Configuration API news

We recently added some new exciting features to the TinyMCE configuration API based on feedback from the the forums.

Inherit settings from an ancestor

We heard that you would like to be able to configure settings on a base class and then override them further down in the hierarchy, so you do not have to duplicate the code for setting the setting on all leaf classes. E.g.

Before

abstract class ProductBase
{
    public virtual XHtml ProductDescription {get;set;}
}

class ProductPage : ProductBase
{
}

class ShoeProductPage : ProductPage
{
}

class ShirtProductPage : ProductPage
{
}

class BlueShirtProductPage : ShirtProductPage
{
}

class VerySpecialProductPage : ProductPage
{
}

class AndEvenMoreSpecialProductPage : VerySpecialProductPage
{
}


// Init
context.Services.Configure<TinyMceConfiguration>(config =>
{
    var baseSettings = config.Default().Clone();
    baseSettings
        .AddPlugin("product-selector")
        .AppendToolbar("product-selector");

    config.For<ProductPage>(t=>t.ProductDescription, baseSettings);
    config.For<ShoeProductPage>(t=>t.ProductDescription, baseSettings);
    config.For<ShirtProductPage>(t=>t.ProductDescription, baseSettings);
    config.For<BlueShirtProductPage>(t=>t.ProductDescription, baseSettings);
    config.For<VerySpecialProductPage>(t=>t.ProductDescription, baseSettings);
    config.For<AndEvenMoreSpecialProductPage>(t=>t.ProductDescription, baseSettings);
})

After

// Init
context.Services.Configure<TinyMceConfiguration>(config =>
{
     // Enable inheritance of settings
    config.InheritSettingsFromAncestor= true;

    var baseSettings = config.Default().Clone();
    baseSettings
        .AddPlugin("product-selector")
        .AppendToolbar("product-selector");

    config.For<ProductBase>(t=>t.ProductDescription, baseSettings);
})
This new behavior is something that you need to enable, by setting InheritSettingsFromAncestor to true. We could not change the new behavior without doing a breaking change, so we decided to hide it behind the InheritSettingsFromAncestor flag instead.
You can read more about the API in the SDK - (Inherit settings from ancestors)

Setting transformations

The setting transformation features makes it possible for you to add a callback method that will run when we load the settings for a specific content item. And it enables you do modify the setting object before we return it to the client.
 
context.Services.Configure<TinyMceConfiguration>(config =>
{
    ...
    
    // If you are writing a plugin we recommend you to add the transformation when you add the plugin.
    config.Default()
        .AddExternalPlugin("custom-plugin","/path/to/my/plugin.js", (settings, content, propertyName) => {
            settings["custom-plugin-setting"] = "plugin value";
        });
 
    config.Default()
        .AddSettingsTransform("custom-settings", (settings, content propertyName) => {
            settings["custom-plugin-setting"] = "I have modified the plugins settings value";
        });
 
    ...
}
You can read more about the API in the SDK - Settings transformations
 

We hope these changes makes it easier for you to configure TinyMCE, and if you have any more feedback on the API, please let us know.

May 22, 2018

Comments

Peter Emilsson
Peter Emilsson May 23, 2018 11:11 AM

Setting transformations look very useful!

How do I configure TinyMce for a property on a model/class in PropertyList?

Aria Zanganeh
Aria Zanganeh May 23, 2018 01:45 PM

this is really helpful :) as I'm pretty sure we will make many configs we will end up the big mess .. if there is any visualization tool that describes what config is used where would be great .. 

Please login to comment.
Latest blogs
Caching & Rendering of metadata from the DAM

For the EPiServer.Cms.WelcomeIntegration.UI 1.2.0 release, we have facilitated the ability to cache and render metadata from assets within the DAM....

Matthew Slim | Jun 2, 2023

Conversion Rate Optimization: Maximizing ROI through Data-Driven Decisions

In today's digital landscape, businesses are constantly looking for ways to improve their online presence and drive more conversions. One effective...

JessWade | Jun 1, 2023

Enhance Your Writing with Suggestions

Are you tired of staring at a blank screen, struggling to find the right words? The Epicweb.Optimizely.AIAssistant Addon is here to revolutionize...

Luc Gosso (MVP) | May 31, 2023 | Syndicated blog

Content Graph - Letting GraphQL do all the hard work for you

Background As we have seen before, setting up Content Graph on the CMS side is pretty easy. However, when it comes to the “head” part of the setup,...

Kunal Shetye | May 26, 2023 | Syndicated blog