Skip to content

Update macro parameter editors #6036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 19, 2024
Merged

Update macro parameter editors #6036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c627cd9
Write shorter sentences
erikjanwestendorp Apr 19, 2024
b804219
Update v12 & v13
erikjanwestendorp Apr 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions 10/umbraco-cms/extending/macro-parameter-editors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ To create a custom Macro Parameter Type, first create a custom 'Property Editor'

### PreValues/Configuration/DefaultValues

However 'Parameter Editors' unlike 'Property Editors' cannot contain 'prevalues', since 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:
'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:

```json
{
Expand All @@ -64,11 +64,11 @@ However 'Parameter Editors' unlike 'Property Editors' cannot contain 'prevalues'
}
```

This is only a problem if you have a macro parameter type, that needs to be used on lots of different macros, but with slightly different configurations in each instance.
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 that has been inserted via an 'Insert Image' Macro into a Rich Text Editor.
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

Expand Down Expand Up @@ -138,7 +138,7 @@ The final custom parameter should look like this:

#### Using defaultConfig

In this example it doesn't really add anything to move the radio button options into configuration, however to illustrate the concept of providing defaultConfig, let's do that:
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:

Expand Down
8 changes: 4 additions & 4 deletions 12/umbraco-cms/extending/macro-parameter-editors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ To create a custom Macro Parameter Type, first create a custom 'Property Editor'

### PreValues/Configuration/DefaultValues

However 'Parameter Editors' unlike 'Property Editors' cannot contain 'prevalues', since 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:
'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:

```json
{
Expand All @@ -63,11 +63,11 @@ However 'Parameter Editors' unlike 'Property Editors' cannot contain 'prevalues'
}
```

This is only a problem if you have a macro parameter type, that needs to be used on lots of different macros, but with slightly different configurations in each instance.
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 that has been inserted via an 'Insert Image' Macro into a Rich Text Editor.
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

Expand Down Expand Up @@ -137,7 +137,7 @@ The final custom parameter should look like this:

#### Using defaultConfig

In this example it doesn't really add anything to move the radio button options into configuration, however to illustrate the concept of providing defaultConfig, let's do that:
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:

Expand Down
8 changes: 4 additions & 4 deletions 13/umbraco-cms/extending/macro-parameter-editors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ To create a custom Macro Parameter Type, first create a custom 'Property Editor'

### PreValues/Configuration/DefaultValues

However 'Parameter Editors' unlike 'Property Editors' cannot contain 'prevalues', since 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:
'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:

```json
{
Expand All @@ -63,11 +63,11 @@ However 'Parameter Editors' unlike 'Property Editors' cannot contain 'prevalues'
}
```

This is only a problem if you have a macro parameter type, that needs to be used on lots of different macros, but with slightly different configurations in each instance.
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 that has been inserted via an 'Insert Image' Macro into a Rich Text Editor.
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

Expand Down Expand Up @@ -137,7 +137,7 @@ The final custom parameter should look like this:

#### Using defaultConfig

In this example it doesn't really add anything to move the radio button options into configuration, however to illustrate the concept of providing defaultConfig, let's do that:
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:

Expand Down