Macro Parameter Editors
A guide to creating macro property editors in Umbraco
The samples in this article has not been verified against the latest version of Umbraco.
Every macro can contain parameters. Options for the Editor to set when they insert the Macro to customise the output. There are some useful default types. For example:
True/False
TextBox
TextArea
Numeric
Single/Multiple Media Picker
Single/Multiple Content Picker
... and some 'others'
Consult the Backoffice documentation for general information on Macros.
It is possible to create custom macro parameter types.
Creating a custom Macro Parameter Type
isParameterEditor
To create a custom Macro Parameter Type, first create a custom 'Property Editor' (or copy one from the core). See Property Editors documentation and in the corresponding Package Manifest file for the editor, set the isParameterEditor
property to be true.
PreValues/Configuration/DefaultValues
'Parameter Editors', unlike 'Property Editors', cannot contain 'prevalues'. This is because there is no UI to present configuration options in the Macro Parameter tab when a particular type is chosen. However using the defaultConfig
option enables the passing of 'one off' default set of configuration for the parameter editor to use:
This is only a problem if you have a macro parameter type that needs to be used on lots of different macros. Each instance may require slightly different configurations.
Example
We'll create an 'Image Position' Macro Parameter type, providing a Radio Button list of options for positioning an image. This image is inserted via an 'Insert Image' Macro into a Rich Text Editor.
Package Manifest
View
Controller
Display
The final custom parameter should look like this:
Using defaultConfig
In this example, moving the radio button options into configuration doesn't really add anything. However, to illustrate the concept of providing defaultConfig, let's do that:
The package manifest becomes:
In the ImagePosition.controller.js
we can now read the 'options' values from the defaultConfig
in the package.manifest configuration:
Reading the parameter value in the Macro Partial View
Runtime minification cache busting in Production
If your custom property editor doesn't load when your project is deployed, you may need to modify your Runtime Minification Settings. The minified bundle cache may need to be "busted" to get your new code to load. For example, to bust the cache whenever the app is restarted, you can use this configuration:
Last updated