Add Formats to Umbraco Richtext Editor

January 8, 2015 by Chris Sherman

To add heading elements or custom styles to the Umbraco richtext editor, you’ll need to create custom formats. Creating a new format is not exactly intuitive, but if you follow these instructions it’s a breeze.

In Umbraco Back Office:

  1. Click the Settings menu item.
  2. Hover over Stylesheets.
  3. Click the ellipsis and select Create.
  4. Name your stylesheet.
  5. Click Create.

This stylesheet will serve as a container for the individual formats you will create. To create a format:

  1. Hover over the new stylesheet, click the ellipsis and select Create.
  2. Name your format descriptively, as this name will appear in the dropdown list in the editor.
  3. In the property menu that appears, rename the Alias property to the element or class name you want the format to insert into the editor. For example, if you want the format to transform the selection into an h1 element, you enter h1 in the Alias field. If you want to insert a span element with a class name, you enter .class-name.
  4. Enter the CSS you want applied to element or class in the Styles field.
  5. Click Save.
  6. View the Preview field to ensure your styles are correct

In the example below, I am entering styles for formatting source code. I use a pre element for this purpose. When I eventually go to the editor, Umbraco will wrap the text I highlight with the pre element and apply the CSS from the Styles field.

rtf-1

In the second example, I am applying styles to a class name. In the editor, Umbraco will insert a span element with the class name from the Alias field.

rtf-2

As an aside, you can also create custom formats without specifying anything in the Styles section to leverage existing classes in another stylesheet. The issue with this route is that you won’t have the ability to preview the styles within the editor as you type.

Next, we need to add the custom format collection to the richtext editor data type.

  1. On the main navigation menu, click the Developer menu item.
  2. Expand Data Types and select Richtext editor.
  3. Scroll to the Stylesheets property and select the stylesheet you created as your format container.
  4. Click Save.

You’re now ready to use your custom format!

Navigate to the Content section on the main menu and browse to a page with the richtext editor data type. Highlight the text you want to apply the format to and select the format from the Formats dropdown. Your format will appear instantly in the editor.

Umbraco