Property Editors and Client Validation

[warrenbuckley]

What type of issue is it? (Choose one - delete the others)

Missing documentation

What article/section is this about?

https://docs.umbraco.com/umbraco-cms/tutorials/creating-a-property-editor

https://docs.umbraco.com/umbraco-cms/customizing/property-editors/integrate-validation

Describe the issue

I think it would be good to expand the property editor tutorial to show how to use the validation system for the custom property editor.

For example it would be good to show how to set a custom validation message if someone was to write the words Sitecore or Wordpress into the suggestion box.

The general documentation for the client validation is quite complex and the examples on the page leave out a lot of context to understand what to do in my opinion.

[eshanrnh]

Thanks @warrenbuckley for the feedback — much appreciated 💪

You raise a good point. We'll keep this suggestion in mind as we review how the tutorial and documentation can be made more approachable.

[warrenbuckley]

Good to hear @eshanrnh 😄

I think it would be good to talk about the different approaches to validation and show the use cases of when you would use one approach over another.

As from what I can see/understand there are several ways to do validation:

• addFormControlElement
• umbBindToValidation(this) with a Lit Directive
• addValidator
• Complex validation with JSON Data Paths

[umbracocommunity]

This issue has been mentioned on Umbraco community forum. There might be relevant details there:

https://forum.umbraco.com/t/property-editor-how-do-i-use-valdiation/4391/8

[eshanrnh]

Thanks again for the input — points noted😊

I'll take this to the team and see what they say. It does make sense to highlight the different validation approaches and when to use each. Appreciate you sharing your thoughts 🙌