Added features that allow consumers to customise View Location and runtime stylesheet loading #116
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
|
Hey @BenWhite27! I haven't forgotten about this, hoping to get on to it very soon. In the meantime, please can you pull in the latest changes from |
|
Hey @rickbutterfield, No worries, been tied up lately as well. I probably should have created a branch, still very new to contributing... especially in library code. I'll do a rebase locally in the next few days and update the fork asap. |
Updated nullability for the method and all references.
…tunities for 3rd party customisation. Set those methods as protected virtual to allow customisation.
Updated BlockPreviewApiController to include a new IBlockPreviewRequestEnricher field and modified the constructor to initialize it. Introduced IBlockPreviewRequestEnricher interface and a NoopBlockPreviewRequestEnricher.
…15+ compatible implementation instead.
…ws to render the correct themed partial view.
|
Afternoon @rickbutterfield, hope you're well. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds features that allow consumers to customise View Location and runtime stylesheet loading for block previews. The implementation introduces a new service interface IBlockPreviewRequestEnricher that enables enrichment of the HTTP context during block preview rendering, and modifies the BlockPreviewService to allow extensibility around view resolution and stylesheet path retrieval. The changes enable theme-specific views and stylesheets to be displayed in the back office based on content properties.
- Added
IBlockPreviewRequestEnricherservice to allow HTTP context enrichment during block preview - Modified
BlockPreviewServiceto support customizable view location and stylesheet paths through newBlockPreviewContext - Updated the Backoffice UI to obtain stylesheets via API calls instead of static configuration
Reviewed Changes
Copilot reviewed 45 out of 46 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| assets.js | Updated JavaScript bundle with new API endpoints for stylesheet retrieval |
| NoopBlockPreviewRequestEnricher.cs | Default no-op implementation of the request enricher interface |
| BlockPreviewService.cs | Enhanced service with extensibility points for view resolution and stylesheet paths |
| BlockPreviewContext.cs | New context class to pass block preview data between methods |
| IBlockPreviewService.cs | Updated interface with new stylesheet path method |
| IBlockPreviewRequestEnricher.cs | New interface for HTTP context enrichment |
| BlockPreviewApiController.cs | Added API endpoints for retrieving stylesheets and integrated request enrichment |
| BlockPreviewComposer.cs | Registered the default request enricher service |
| Various UI files | Updated to use API calls for stylesheet retrieval instead of settings |
| Example CMS files | Example implementation showing theme-based view resolution and styling |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| ViewDataDictionary viewData = CreateViewData(blockInstance, previewContext); | ||
| previewContext.ViewData = viewData; | ||
| return await GetMarkup(previewContext); |
There was a problem hiding this comment.
The error message "Insufficient data for block preview" doesn't provide enough context about which specific data is missing. Consider enhancing the error message to specify exactly what data is required.
Copilot uses AI. Check for mistakes.
| { | ||
| var viewData = new ViewDataDictionary(new EmptyModelMetadataProvider(), new ModelStateDictionary()) | ||
| { | ||
| Model = typedBlockInstance | ||
| }; | ||
|
|
||
| if (blockType == BlockType.BlockGrid && matchingBlockConfig != null && matchingBlockConfig.Areas.Any()) | ||
| if (context.BlockType == BlockType.BlockGrid && context.BlockGridBlockConfig != null && context.BlockGridBlockConfig.Areas.Length != 0) |
There was a problem hiding this comment.
[nitpick] Complex conditional statement with multiple null checks. Consider extracting this logic into a helper method like 'HasBlockGridAreas(context)' for better readability.
| if (context.BlockType == BlockType.BlockGrid && context.BlockGridBlockConfig != null && context.BlockGridBlockConfig.Areas.Length != 0) | |
| if (HasBlockGridAreas(context)) |
Copilot uses AI. Check for mistakes.
Added
IBlockPreviewRequestEnricherservice that allows enrichment of the http context for runtime view and stylesheet location.Modified
BlockPreviewServiceto allow extensibility aroundCreateViewDataandGetViewResult. Making use of a newBlockPreviewContextclass to pass around the data needed to make decisions in custom logic. Also addedBlockPreviewService.GetStylesheetPathto allow customisation of the stylesheet that is delivered at runtime.Updated the Backoffice UI code to obtain the stylesheet via API call.
Also added some example implementations to the CMS project.
This is all in relation to #115 with the goal of allowing a package consumer to display theme specific views in the back office. In theory the theme could be specified as a property in the content node hierarchy or based on the domain configured on the root content node.