Skip to content

Latest commit

 

History

History
46 lines (22 loc) · 2.33 KB

editor-notes.md

File metadata and controls

46 lines (22 loc) · 2.33 KB

Contentment for Umbraco logo

Contentment for Umbraco

Editor Notes

Editor Notes is a property-editor that can be used to display rich-text instructional messages for content editors.

This property-editor has evolved from the Notes editor, which itself takes inspiration from community packages, such as uEditorNotes by Marc Goodson and uComponents Notes by Matt Brailsford.

How to configure the editor?

In your new Data Type, selected the "[Contentment] Editor Notes" option. You will see the following configuration fields.

Configuration Editor for Editor Notes

The initial field is to select an Alert type, the available options are: Form, Info, Success, Warning, Error and Well.

The next field is Icon, this will open Umbraco's icon picker overlay. Text filters and color selection can be used.

The next 2 fields are for Heading and Message, these are the main contents of the editor note.

Fun fact: The rich-text editor uses Umbraco's TinyMCE integration, meaning that you can link to Umbraco content and embed Umbraco media.

There are also options to hide the label on the property itself, and to hide the property group container. Selecting these option will enable the notes to be displayed in full width and outside of the content property panel.

How to use the editor?

Once you have added the configured Data Type on your Document Type, the notes will be displayed on the content page's property panel.

Editor Notes property-editor - displaying the read-only label

How to get the value?

This property-editor is read-only and does not store any value against the property.

Further reading

If you are interesting in making your Umbraco back-office super friendly. Here are some articles for further inspiration...