Skip to content

fix: Prevent Block Grid area previews rendering before layoutAreas are available #295

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
rickbutterfield merged 2 commits into from
Jun 17, 2026
Merged

fix: Prevent Block Grid area previews rendering before layoutAreas are available #295

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4055dca
fix: Prevent Block Grid area previews rendering before layoutAreas ar…
Jun 17, 2026
78979ae
fix: Address PR review feedback on layoutAreas re-render and null safety
Jun 17, 2026
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
22 changes: 20 additions & 2 deletions ...braco.Community.BlockPreview.UI/src/blockEditor/block-grid-preview.custom-view.element.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ export class BlockGridPreviewCustomView extends BlockPreviewBaseElement<BlockGri
]) => {
const prevColumnSpan = this._blockContext.layout?.columnSpan;
const prevRowSpan = this._blockContext.layout?.rowSpan;
const prevLayoutAreas = this._blockContext.layoutAreas;

this._blockContext.contentUdi = contentUdi ?? '';
this._blockContext.settingsUdi = settingsUdi ?? '';
Expand All @@ -113,11 +114,23 @@ export class BlockGridPreviewCustomView extends BlockPreviewBaseElement<BlockGri
this._blockContext.layout = layout!;
this._blockContext.layoutAreas = layoutAreas;

if (!this.#managerObserved) {
if (!this.#managerObserved && this._blockContext.contentUdi) {
this.#managerObserved = true;
await this.#observeBlockPropertyValue();
}

// Re-render when layoutAreas first arrive for a block with areas.
// Covers both the deferred case (_htmlMarkup empty) and the early-render
// case (_htmlMarkup set from an incomplete render). blockGridValue.layout
// must be rebuilt here so callPreviewApi() sends the updated area data.
if (!prevLayoutAreas && layoutAreas && (areas?.length ?? 0) > 0 && this.#managerObserved && !this._isLoading) {
this.blockGridValue = {
...this._blockGridValue,
layout: { ['Umbraco.BlockGrid']: this.#filterLayouts() }
};
this.renderBlockPreview();
}

// Re-render when layout dimensions change (resize)
if (this._htmlMarkup && layout && (
layout.columnSpan !== prevColumnSpan ||
Expand Down Expand Up @@ -159,8 +172,13 @@ export class BlockGridPreviewCustomView extends BlockPreviewBaseElement<BlockGri
expose: exposes ?? [],
layout: { ['Umbraco.BlockGrid']: this.#filterLayouts() }
};
this._blockContext.blockIndex = contents.findIndex(x => x.key === this._blockContext.contentUdi);
this._blockContext.blockIndex = (contents ?? []).findIndex(x => x.key === this._blockContext.contentUdi);
if (!this._htmlMarkup && !this._isLoading) {
// Defer render if areas are expected but layoutAreas haven't arrived yet;
// observeBlockValue will trigger the render once layoutAreas are available.
if ((this._blockContext.areas?.length ?? 0) > 0 && !this._blockContext.layoutAreas) {
return;
}
this.renderBlockPreview();
}
}
Expand Down
Loading