New Config Action for adding new components to config entities using layout builder from recipes.
You can use it like this:
config:
actions:
dashboard.dashboard.welcome:
addComponentToLayout:
section: 0
position: 4
component:
region:
layout_twocol_section: 'second'
default_region: content
configuration:
id: dashboard_text_block
label: 'My new dashboard with weight from a plugin'
label_display: 'visible'
provider: 'dashboard'
context_mapping: { }
text:
value: '<p>My new dashboard with weight from plugin</p>'
format: 'basic_html'
The name of the action is addComponentToLayout, and its arguments are:
- section: The delta of the section where our new component is going to be added
- position: The position at which should be added. Don't confuse this with weight, which will be automatically calculated.
- component: An array containing the component definition.
Inside of component, we can define a region that maps the potential layout with the region inside the layout to use. You can also use default_region in case the layout id doesn't match any of the above mapped layout regions.
It will have a configuration key, with whatever schema your plugin will expect. At least an id with the plugin_id will be expected.
This action can be used against any config entity using layout builder. E.g. an entity view display from core, or a dashboard from the contrib module dashboard, as in the example.