Rename component source plugin configuration keys for clarity

Created on 18 December 2024, about 18 hours ago

Overview

Block components use the key "settings" to mean "data needed to initialise the default block plugin". Further, this is stored inside another "settings" key in the component entity itself.

SDC components use the key "props" to mean "field configuration for each prop".

Both these are too simplistic and have caused confusion,

Proposed resolution

For block components rename "settings" to "default_settings", this is the configuration required to render the default version of a block component. In the future it might be necessary to allow site owners to configure the default version of the block component so the preview renders in a sensible way.

For SDCs, rename "props" to "prop_field_definitions" - while the keys are props, they are not props themselves; the values are the configuration required to build field instances that can be used to configure the props.

User interface changes

None

📌 Task
Status

Active

Version

0.0

Component

Config management

Created by

🇬🇧United Kingdom longwave UK

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @longwave
  • 🇬🇧United Kingdom longwave UK

    Naming things is hard when you have multiple layers of indirection and similar things that are related to each other, as per both this issue itself *and* the title.

  • 🇧🇪Belgium wim leers Ghent 🇧🇪🇪🇺

    #2++, tried to clarify slightly :D

    Bumping priority because this will continue to cause confusion otherwise.

    @longwave, any chance you could get an initial MR up in the next few days, so that we can eliminate any further wasted minutes/hours on this confusion? 😇🙏

Production build 0.71.5 2024