Skip to content

Update the dynamic root custom query step example #6977

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 3 commits into from
Mar 28, 2025
Merged

Update the dynamic root custom query step example #6977

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f3ddedb
Update the dynamic root custom query step example
AndyButland Mar 26, 2025
f4d088d
Update 15/umbraco-cms/fundamentals/backoffice/property-editors/built-…
AndyButland Mar 27, 2025
32db39b
Updated code sample
AndyButland Mar 27, 2025
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
32 changes: 30 additions & 2 deletions ...backoffice/property-editors/built-in-umbraco-property-editors/content-picker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,12 @@ public class MyCustomDynamicRootQueryStep : IDynamicRootQueryStep
_myCustomRepository = myCustomRepository;
}

// The string below is what you specify in the UI to execute this custom query step.
public virtual string SupportedDirectionAlias { get; set; } = "MyCustomStep";

public async Task<Attempt<ICollection<Guid>>> ExecuteAsync(ICollection<Guid> origins, DynamicRootQueryStep filter)
{
// The string below is what you specify in the UI to execute this custom query step.
if (filter.Alias != "MyCustom")
if (filter.Alias != SupportedDirectionAlias)
{
return Attempt<ICollection<Guid>>.Fail();
}
Expand Down Expand Up @@ -133,6 +135,32 @@ public class CustomQueryStepComposer : IComposer
}
```

Finally, you need to register the custom query step client side, and provide some further description.

This can be done in an `umbraco-package.json` file like the following:

```json
{
"$schema": "../../umbraco-package-schema.json",
"name": "My.Test.Extension",
"version": "0.1.0",
"extensions": [
{
"type": "dynamicRootQueryStep",
"alias": "Umb.DynamicRootQueryStep.MyCustomStep",
"name": "Dynamic Root Query Step: My Custom Step",
"meta": {
"queryStepAlias": "MyCustomStep",
"label": "My Custom Step",
"description": "My custom step description.",
"icon": "icon-coffee"
},
"weight": 60
}
]
}
```

### Allow items of type

Choose which types of content should be available to pick using the Content Picker.
Expand Down