Templates support for CKEditor 5

[eilskn]

How to add custom Templates to CKEditor 5 like in CKEditor 4?

CKEDITOR.editorConfig = function( config ) {
    config.templates_files = ['/js/ckeditor/templates/default.js'];
    config.templates = 'default';
    config.allowedContent = true;
    config.templates_replaceContent = true;
};

[Mgsy]

CKEditor 5 doesn't support templates as CKEditor 4, so there is no possibility to define them.

I'm re-opening this issue as a feature request for the templates support. Feel free to add a comment about it and describe your use case or thoughts on how it should be implemented.

[wwalc]

I remember that someone asked about such a feature via support channel at least once too.

[dkrahn]

What I am seeking is a page template where there are editable areas. Some users will be able to edit the whole template and some will only be able to fill out the editable areas.

[jhhdk]

Was about to post duplicate, posting here instead:
I am wondering whether it is possible given the existing api's to create a plugin that would enforce a mandatory document structure? I am not thinking word like forms per say, more like a word template where the stuff inherited from the template would not be editable(/deletable).

<root>
  <h1 locked='true'>1. Abstract<h1>
  <p>Lorem...</p>
</root>

[tbredin]

Use case example: my team is looking at building a document editor that allows users to set up reusable page layouts, including a header and footer (see: #1759 ) per-page (seems related to this). In our case, these are printable a4 documents, eg a legal document

[celsowm]

I was looking for something similar, I found the one used by this company, I hope one day ckeditor has something like or better: https://ej2.syncfusion.com/demos/#/material/document-editor/headers-and-footers.html

[IshaVohra]

PLSS

[ghost]

Was about to post duplicate, posting here instead:

I am wondering whether it is possible given the existing api's to create a plugin that would enforce a mandatory document structure? I am not thinking word like forms per say, more like a word template where the stuff inherited from the template would not be editable(/deletable).

<root>

  <h1 locked='true'>1. Abstract<h1>

  <p>Lorem...</p>

</root>

Did you manage to find something that functions like this?

[BloodBaz]

I am wondering whether it is possible given the existing api's to create a plugin that would enforce a mandatory document structure?

This is a separate feature to the one described in this thread. This thread is specifically about having a list of prepared content templates which can be selected to replace the current content (or insert as a snippet into an existing document content). It was a feature of older CKEditors but has not been implemented in v5.

Making parts of a content "readonly" / "locked" would be a separate feature.

[skerbis]

Yes. That would be cool. Predefined Text or Content, but not to replace the content, better to insert at cursor position.

[eugene-f-ysbm]

Yes. That would be cool. Predefined Text or Content, but not to replace the content, better to insert at cursor position.

public addTemplate(value: string | SafeHtml): void {
const viewFragment = this.ckEditor.data.processor.toView(value);
const modelFragment = this.ckEditor.data.toModel(viewFragment);
this.ckEditor.model.insertContent(modelFragment);
this.ckEditor.editing.view.scrollToTheSelection();
}

[MrStooby]

Hi,
I haven't found a plugin allowing to add predefined code in CkEditor and it doesn't seem to exist at the time of writing.
For the plugins, I imagine a function that calls a json or equivent file containing the predefined code with the possibility to add a title, a description, even a picture and keywords (to facilitate the search for templates).
The code would be integrated at the cursor location.

[kmonty]

Noting this is a pretty popular feature in the Drupal ecosystem. More than 12,000 Drupal 8 / 9 / 10 sites use this feature in CKEditor 4. As Drupal 10 (to be released this summer) moves to CKEditor 5, I am worried about what the fallout of this feature being removed will look like for site editors.

I have one project that relies on it myself.

[mlewand]

The feature has been shipped in version 37.1.0 and is available as a part of productivity pack feature set 🎉

You can give it a try in our content templates feature guide.