UFM: Make Block Settings data available

[leekelleher]

Important

This pull request could be merged in before #19685, but to make testing simpler, (with UFM property-drilling), you can wait until it has been merged in.

Description

Resolves #17619.

Exposes a block's settings data to UFM values, accessible via a $settings property.

To note, once PR #19685 has been merged in, property-drilling can be used to access the appropriate values,
e.g. ${ $settings.propertyAlias }.

[Copilot]

Pull Request Overview

This PR exposes a block’s settings data to UFM values by merging it into the block’s content under a $settings property and updating all block-rendering components accordingly.

• Introduces a new settings property in multiple block components
• Merges content and settings into a single blockValue passed to <umb-ufm-render>
• Updates imports to leverage Lit’s when() helper for conditional rendering

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/packages/block/block-rte/components/ref-rte-block/ref-rte-block.element.ts	Adds settings property and merges it into blockValue for UFM rendering
src/packages/block/block-list/components/ref-list-block/ref-list-block.element.ts	Similar merge of settings into blockValue and replaces ternary with when()
src/packages/block/block-list/components/inline-list-block/inline-list-block.element.ts	Adds settings, updates UFM render, and switches to when()
src/packages/block/block-grid/components/block-grid-block/block-grid-block.element.ts	Adds settings merge and uses when()
src/packages/block/block-grid/components/block-grid-block-inline/block-grid-block-inline.element.ts	Updates imports and merges settings into UFM render

Comments suppressed due to low confidence (4)

src/Umbraco.Web.UI.Client/src/packages/block/block-rte/components/ref-rte-block/ref-rte-block.element.ts:25

• [nitpick] Add a JSDoc comment above the settings property to explain its purpose and how it’s merged into the UFM renderer’s $settings field.

	settings?: UmbBlockDataType;

src/Umbraco.Web.UI.Client/src/packages/block/block-rte/components/ref-rte-block/ref-rte-block.element.ts:45

• [nitpick] Add or update unit tests to verify that the combined blockValue (including $settings) is passed correctly to <umb-ufm-render>.

		const blockValue = { ...this.content, $settings: this.settings };

src/Umbraco.Web.UI.Client/src/packages/block/block-list/components/inline-list-block/inline-list-block.element.ts:3

• [nitpick] The nothing import is no longer used now that when() is handling the false branch implicitly. Consider removing nothing to clean up unused imports.

import { css, customElement, html, nothing, property, state, when } from '@umbraco-cms/backoffice/external/lit';

src/Umbraco.Web.UI.Client/src/packages/block/block-rte/components/ref-rte-block/ref-rte-block.element.ts:45

• [nitpick] This merge pattern ({ ...content, $settings }) is repeated across components—consider extracting it into a shared helper function to reduce duplication.

		const blockValue = { ...this.content, $settings: this.settings };

[umbracocommunity]

This pull request has been mentioned on Umbraco community forum. There might be relevant details there:

https://forum.umbraco.com/t/how-can-you-use-a-block-list-or-block-grid-settings-model-property-in-a-label-in-v16/5654/4

[umbracocommunity]

This pull request has been mentioned on Umbraco community forum. There might be relevant details there:

https://forum.umbraco.com/t/ufm-update-question/6306/2

[umbracocommunity]

This pull request has been mentioned on Umbraco community forum. There might be relevant details there:

https://forum.umbraco.com/t/how-do-i-get-the-value-of-published-property-from-video-settings-element-in-the-block-grid-blocks/6749/2