acquia/cohesion

Updating prod api version to 8.2.6 (#2589)

Update image tag to 8.2.5-kaas-1 (#2488)

Merge pull request #2352 from acquia/hotfix/fix-8-2-3-module-deployme…

Merge pull request #2307 from acquia/release-8.2.2

Release v8.2.1 to kaas prod (#2265)

Merge pull request #2250 from acquia/feature/ACO-3942

Merge pull request #2218 from acquia/8.2.0-release

Merge pull request #2211 from acquia/release-8.2.0

Unable to submit forms if layout canvas field present in the Gin theme

What is it?

Fixes a compatibility issue with the Gin admin theme where the form submit button was outside the form element.

What impact will there be?

You can now submit forms if a layout canvas field is present in the Gin theme without error.

What actions do I need to take?

Site Studio import.

Are there any risks I should be aware of?

None.

Required validation not working for image uploader field

What is it?

Fixes a bug where the required validation did not work as expected on the image uploader field.

What impact will there be?

The required validation on the image uploader field will now work as expected.

What actions do I need to take?

Site Studio import.

Are there any risks I should be aware of?

None.

Support for the Remote Stream Wrapper module

What is it?

Adds support for the Remote Stream Wrapper module, previously where an external image was used the image URL domain was removed and the image was not displaying.

What impact will there be?

An external image will now render as expected when the Remote Stream Wrapper module is enabled.

What actions do I need to take?

Drupal cache clear.

Are there any risks I should be aware of?

None.

Default package import no longer triggers on config sync

What is it?

Fixes a bug where default module package import process would trigger during config sync process, such as installing Drupal from configuration or importing configuration. This would result in unexpected exception being thrown and no default module packages being imported.

What impact will there be?

Updated default package management mechanism no longer will trigger during Drupal site install from configuration or during config import.

What actions do I need to take?

A Drupal cache clear.

Are there any risks I should be aware of?

None.

WYSIWYG field not loading in custom component form builder

What is it?

Fixes an issue where the WYSIWYG field was not loading correctly in the custom component form builder.

What impact will there be?

The WYSIWYG field will now load correctly in the custom component form builder.

What actions do I need to take?

Drupal cache clear.

Are there any risks I should be aware of?

None.

Custom selects with options containing empty values were behaving in an unexpected way

What is it?

Resolved a regression where select fields created on a component form would behave inconsistently if the select had an option with a blank value.

What impact will there be?

Selects should now behave as they did prior to version 7.0.0

What actions do I need to take?

None.

Acquia DAM thumbnail preview not displaying for all asset types

What is it?

Fixes a bug where selecting an Acquia DAM asset in the Entity browser that wasn't an image resulted in a broken thumbnail preview.

What impact will there be?

The thumbnail preview will now correctly be displayed for all asset types.

What actions do I need to take?

A Drupal cache clear.

Are there any risks I should be aware of?

None.

Multiple image uploader fields in a component selected image getting replaced

What is it?

Fixes a bug where a component configured to have multiple image uploader fields, and that was set to use the media library the first image selection was replaced by the next. This meant that all fields end up with the same image.

What impact will there be?

Each image selected will not be replaced, and each field will have the correct image selected by the user.

What actions do I need to take?

Site Studio import & Drupal cache clear.

Are there any risks I should be aware of?

None.

Warning error when Better Exposed Filters is not installed

What is it?

Fixes an "undefined array key" warning when better_exposed_filters is not installed.

What impact will there be?

The error will not be logged when better_exposed_filters is not installed.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Icon picker would not load in form preview and style guides

What is it?

Fixes a bug where the icon picker would get an error in the form preview or on style guides.

What impact will there be?

The icon picker will work in all areas of the application.

What actions do I need to take?

Run a Site Studio import and clear Drupal caches.

Are there any risks I should be aware of?

None.

Media library modal window displaying behind the sidebar browser in visual page builder

What is it?

Fixes a bug where the media library modal window was un-styled and displaying behind the side browser when using the visual page builder.

What impact will there be?

The media library modal window will now appear on top of the sidebar browser and styled as expected.

What actions do I need to take?

Run a Site Studio import and clear Drupal caches.

Are there any risks I should be aware of?

None.

hook_requirements blocking install

What is it?

7.1 introduced a hook_requirements implementation to verify CkEditor 5 was enabled, this was blocking fresh install processes as the requirement is called too early in the process.

What impact will there be?

The requirement is now checked at runtime only so the error will not block the install or update process.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Style builder color values disappearing when changing to another item in the style tree

What is it?

Fixes an issue where selecting a color value in the default style tree selector, and then navigate to the hover styles. The color value in the default style tree had been unset.

What impact will there be?

The color value in the style tree will retain its value.

What actions do I need to take?

Run a Site Studio import.

Are there any risks I should be aware of?

None.

Color picker in components now functions correctly when Hide Picker Tab is enabled

What is it?

Resolved an issue where the color picker field in component forms was not behaving correctly when the Hide Picker Tab options was enabled.

What impact will there be?

The Hide Picker Tab option now correctly hides the tab on color pickers.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Limit Stream Wrappers to Local

What is it?

A change in File Usage plugin that limits stream wrappers used by Site Studio to local stream wrappers only.

What impact will there be?

Prevents errors when used with remote stream wrapper module remote_stream_wrapper.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Templated Drupal multi fields not rendering

What is it?

When templating a Drupal multi field with Site Studio the values and HTML would not appear.

What impact will there be?

When templating a Drupal multi field with Site Studio the HTML and values will render as expected.

What actions do I need to take?

Site Studio rebuild or drush cohesion:rebuild

What impact will there be?

None.

Icon picker not displaying in form preview

What is it?

When creating or editing a component that utilises the icon picker the form preview was not displaying as expected.

What impact will there be?

Icon picker will display in form preview.

What actions do I need to take?

A Site Studio import or drush cohesion:import.

Are there any risks I should be aware of?

None.

Icon picker would not load in form preview and style guides

What is it?

Fixes a bug where the icon picker would get an error in the form preview or on style guides.

What impact will there be?

The icon picker will work in all areas of the application.

What actions do I need to take?

Run a Site Studio import and clear Drupal caches.

Are there any risks I should be aware of?

None.

Media library modal window displaying behind the sidebar browser in visual page builder

What is it?

Fixes a bug where the media library modal window was un-styled and displaying behind the sidebar browser when using the visual page builder.

What impact will there be?

The media library modal window will now appear on top of the sidebar browser and styled as expected.

What actions do I need to take?

Run a Site Studio import and clear Drupal caches.

Are there any risks I should be aware of?

None.

hook_requirements blocking install

What is it?

7.1 introduced a hook_requirements implementation to verify CkEditor 5 was enabled, this was blocking fresh install processes as the requirement is called too early in the process.

What impact will there be?

The requirement is now checked at runtime only so the error will not block the install or update process.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Style builder color values disappearing when changing to another item in the style tree

What is it?

Fixes an issue where selecting a color value in the default style tree selector, and then navigate to the hover styles. The color value in the default style tree had been unset.

What impact will there be?

The color value in the style tree will retain its value.

What actions do I need to take?

Run a Site Studio import.

Are there any risks I should be aware of?

None.

Color picker in components now functions correctly when Hide Picker Tab is enabled

What is it?

Resolved an issue where the color picker field in component forms was not behaving correctly when the Hide Picker Tab options was enabled.

What impact will there be?

The Hide Picker Tab option now correctly hides the tab on color pickers.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Limit Stream Wrappers to Local

What is it?

A change in File Usage plugin that limits stream wrappers used by Site Studio to local stream wrappers only.

What impact will there be?

Prevents errors when used with remote stream wrapper module remote_stream_wrapper.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Templated Drupal multi fields not rendering

What is it?

When templating a Drupal multi field with Site Studio the values and HTML would not appear.

What impact will there be?

When templating a Drupal multi field with Site Studio the HTML and values will render as expected.

What actions do I need to take?

Site Studio rebuild or drush cohesion:rebuild

What impact will there be?

None.

Icon picker not displaying in form preview

What is it?

When creating or editing a component that utilises the icon picker the form preview was not displaying as expected.

What impact will there be?

Icon picker will display in form preview.

What actions do I need to take?

A Site Studio import or drush cohesion:import.

Are there any risks I should be aware of?

None.

Adding CKEditor 4 support via additional "legacy" module

What is it?

Support for CKEditor 4 is now available via the Site Studio Legacy CkEditor module.

What impact will there be?

CKEditor 4 based text formats and plugins can be utilised in the latest version of Site Studio.

Note: The module has a dependency on the contrib version of CKEditor to ensure support for Drupal 10 is maintained.

What actions do I need to take?

When upgrading to Site Studio 7.1 the following module and it's dependencies should be included and enabled to support CKEditor 4.

• composer require acquia/sitestudio_legacy_ckeditor:^7.1
• drush en sitestudio_legacy_ckeditor -y

Note: As of version 7.0 Site Studio requires the CKEditor 5 Drupal core module to be enabled and at least 1 CKEditor 5 text format to be configured. This is to ensure compatability with Drupal 10+.

Are there any risks I should be aware of?

None.

Overflow issue when inserting an image into the WYSIWYG field

What is it?

Fixed an issue that could arise with certain form layouts when inserting high resolution images into CKEditor causing the form to stretch wider than the screen.

What impact will there be?

Image embeds via the wysiwyg interface will adjust to fit the viewport ensuring buttons are accessible.

What actions do I need to take?

A Site Studio import or drush cohesion:import

Are there any risks I should be aware of?

None.

Link to page entity type restriction not applying

What is it?

Fixes a bug where the "link to page" component field had been configured to be restricted to specific entity types, but was showing all entity type results regardless.

What impact will there be?

The "link to page" component field results will be restricted as configured.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Templated Drupal multi fields not rendering

What is it?

When templating a Drupal multi field with Site Studio the values and HTML would not appear.

What impact will there be?

When templating a Drupal multi field with Site Studio the HTML and values will render as expected.

What actions do I need to take?

Site Studio rebuild or drush cohesion:rebuild

What impact will there be?

None.

Visual page builder no height components flickering

What is it?

When using components with no height or with images that aren't defined, they cause a flickering when using visual page builder. This fix stops the flickering issue.

What impact will there be?

Visual page builder will not have any component flickering issues.

What actions do I need to take?

A Site Studio import or drush cohesion:import

Are there any risks I should be aware of?

None.

Cannot read properties of undefined (reading 'uuid') error on page builder

What is it?

Fixes an issue when a component displaying a Drupal view, which in turn rendered content and potentially the same content entity a user was viewing. When attempting to use the page builder in this scenario the error "Cannot read properties of undefined (reading 'uuid')" was displayed.

What impact will there be?

The page builder will now work as expected in this scenario as the page builder does not attempt to add markup to items in the Drupal view.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Color palette performance

What is it?

The color palette had performance issues when using a lot of different colors. Now there are no issues when using a large number of colors on the color palette page.

What impact will there be?

The performance on the website settings color palette will be improved.

What actions do I need to take?

A Site Studio import or drush cohesion:import

Are there any risks I should be aware of?

None.

Component dropzone content in component content

What is it?

There was an issue when saving a component as component content when it had a nested component in a component dropzone. When saving it didn’t include the component in the dropzone.

What impact will there be?

You will now be able to save component with nested components as component content.

What actions do I need to take?

A Site Studio import or drush cohesion:import

Are there any risks I should be aware of?

None.

Config entities no longer regenerate IDs

What is it?

When a config entity was saved via UI, Site Studio regenerated ID based on a hash of UUID. If entity was created via UI and UUID would match ID, this would not be noticeable. However, in the instances when entity ID or UUID was manually edited or the entity was not created via UI this would result in entity ID being changed on save.

What impact will there be?

Site Studio will only generate IDs for new entities or entities that don't have ID yet.

What actions do I need to take?

Entities re-saved via UI will retain their IDs, even if their ID is not based on UUID.

Are there any risks I should be aware of?

None.

Fixed logic on conditional form fields applying incorrectly in field repeater

What is it?

A regression in 7.0.x meant that component form fields inside field repeaters were no longer correctly showing/hiding based on other fields within the same repeated row.

What impact will there be?

Conditional display of fields will now behave as they did in versions prior to 7.0.x

What actions do I need to take?

A Site Studio import or drush cohesion:import

Are there any risks I should be aware of?

None.

Color palette performance

What is it?

The color palette had performance issues when using a lot of different colors. Now there are no issues when using a large number of colors on the color palette page.

What impact will there be?

The performance on the website settings color palette will be improved.

What actions do I need to take?

A Site Studio import or drush cohesion:import

Are there any risks I should be aware of?

None.

Component dropzone content in component content

What is it?

There was an issue when saving a component as component content when it had a nested component in a component dropzone. When saving it didn't include the component in the dropzone.

What impact will there be?

You will now be able to save component with nested components as component content.

What actions do I need to take?

A Site Studio import or drush cohesion:import

Are there any risks I should be aware of?

None.

Config entities no longer regenerate IDs

What is it?

When a config entity was saved via UI, Site Studio regenerated ID based on a hash of UUID. If entity was created via UI and UUID would match ID, this would not be noticeable. However, in the instances when entity ID or UUID was manually edited or the entity was not created via UI this would result in entity ID being changed on save.

What impact will there be?

Site Studio will only generate IDs for new entities or entities that don't have ID yet.

What actions do I need to take?

Entities re-saved via UI will retain their IDs, even if their ID is not based on UUID.

Are there any risks I should be aware of?

None.

Fixed logic on conditional form fields applying incorrectly in field repeater

What is it?

A regression in 7.0.x meant that component form fields inside field repeaters were no longer correctly showing/hiding based on other fields within the same repeated row.

What impact will there be?

Conditional display of fields will now behave as they did in versions prior to 7.0.x

What actions do I need to take?

A Site Studio import or drush cohesion:import

Are there any risks I should be aware of?

None.

Invalid CSS generated when Background images left unset

What is it?

When a background image was left unset on Style and a Gradient was added to the next Breakpoint, invalid CSS was generated.

What impact will there be?

When left unset the CSS background-image property will no longer be returned.

What actions do I need to take?

A Site Studio rebuild or drush cohesion:rebuild

Are there any risks I should be aware of?

None.

Menu tokens available in menu templates

What is it?

Menu tokens such as [menu:name] were not being replaced in Site Studio menu templates.

What impact will there be?

Menu tokens such as [menu:name] can now be used within Site Studio menu templates.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

URLs that are already encoded are being encoded again

What is it?

Fixes a bug where URLs that are encoded, are then encoded again.

What impact will there be?

If a URL is already encoded, it won't be encoded again.

What actions do I need to take?

A Site Studio rebuild.

Are there any risks I should be aware of?

None.

Sanitize links whilst supporting all possible link types

What is it?

Allow links to be sanitized whilst providing support for all possible link types that could be input.

What impact will there be?

Links are sanitized correctly and all link types should be accepted.

What actions do I need to take?

A Site Studio rebuild.

Are there any risks I should be aware of?

None.

Entity reference fields break on entity types with no bundles

What is it?

Fixes a bug where autocomplete endpoint would fail with exception on entity types with no bundles.

What impact will there be?

The endpoint will work as intended and entity reference form field autocomplete functionality will behave correctly.

What actions do I need to take?

A Drupal cache clear.

Are there any risks I should be aware of?

None.

The icon picker in Site Studio does not display any icons that are NOT the default Icomoon

What is it?

Fixes an issue where icons aren't loaded in the icon picker due to a hardcoded reference to Icomoon.

What impact will there be?

When using icon font that is not from Icomoon, you should now be able to see your icons.

What actions do I need to take?

A Site Studio import and rebuild.

Are there any risks I should be aware of?

None.

Hidden items on Visual Page Builder no longer have incorrect styling when made visible

What is it?

This fixes an issue that occurs when an item goes from being hidden to visible. It used to apply the visually hidden styling, now it removes this appropriately when the DOM updates.

What impact will there be?

Dynamically hidden and visible items on the Visual Page Builder will behave as expected.

What actions do I need to take?

A Site Studio import and rebuild.

Are there any risks I should be aware of?

None.

YouTube video embed element URLs generated not always valid

What is it?

Fixes an issue where the YouTube video embed element URL generated when using autoplay and loop options were enabled.

What impact will there be?

When using the YouTube video embed element, with the autoplay and loop options the URL will be correct.

If the autoplay option is enabled, the mute parameter is also applied, so that the video autoplays as expected. This is due to web browser restrictions.

What actions do I need to take?

A Site Studio import and rebuild.

Are there any risks I should be aware of?

None.

Error being thrown when a Color has not been set in Default font settings

What is it?

When saving the Default font settings or running a Site Studio rebuild the API would return an error if the Default font color was not defined.

What impact will there be?

Saving the Default font settings or running a Site Studio rebuild will now result in a successful save / rebuild even when the Default font color is not defined.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Using view variable element to display a views exposed form caused duplicate IDs

What is it?

Fixes a bug when using the view variable element to display a views exposed form caused duplicate IDs in the DOM. This was due to the Site Studio view template also rendering the exposed form.

The exposed form in the view template is now only inserted into the DOM, if a view variable element for "exposed" isn't used and the view has an exposed form.

What impact will there be?

If the view has an exposed form and the view variable element is used to render it the exposed form will only appear in the DOM once and no duplicate IDs will be present.

What actions do I need to take?

A Site Studio import and rebuild.

Are there any risks I should be aware of?

None.

Adding compatibility for better exposed filters combined option

What is it?

Provides compatibility for using the Better Exposed Filters "Combine sort order with sort by" for view filters.

What impact will there be?

When using the Better Exposed Filters "Combine sort order with sort by" option in a view, the Site Studio view filter element will render this as expected, combining sort order and sort by options.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Twig templates handling Drupal Fields fix

What is it?

Site Studio v7.0.0 introduced a bug when handling templates with Drupal multi-value fields. Templates would contain syntax errors and would cause PHP exceptions when rendered. This fix resolves this regression.

What impact will there be?

Site Studio templates utilising Drupal fields will no longer cause exceptions.

What actions do I need to take?

Run a full rebuild.

Are there any risks I should be aware of?

None.

Drupal 10 compatibility

What is it?

Site Studio v7.0 is compatible with Drupal 9.4, 9.5 and 10. A number of changes have been implemented due to Drupal 10 requirements:

• CKEditor 5 support added
• jQuery UI and Stable theme contrib dependencies added
• PHP 8.1 support added
• Drupal 8 support removed

What impact will there be?

Site Studio will no longer be installable on Drupal 8, however, it can now optionally be installed on Drupal 10 with support for PHP 8.1

What actions do I need to take?

Site Studio v7.0 supports CKEditor 5 only; you are required to manually migrate text formats from CKEditor 4 to CKEditor 5, this should be completed on Drupal 9.x before upgrading to 10.x

For details on migration steps visit.

Are there any risks I should be aware of?

Some CKEditor plugins do not currently have support for CKEditor 5.

For more details please refer to the following: https://www.drupal.org/docs/core-modules-and-themes/core-modules/CKEditor-5-module/upgrade-coordination-for-modules-providing-CKEditor-4-plugins

CKEditor 4 support removed

What is it?

Site Studio v7.0 only supports CKEditor 5, support for the now deprecated CKEditor 4 has been removed.

Note: A fresh install of Site Studio will provide a pre-configured CKEditor 5 text editor/format.

What impact will there be?

CKEditor 4 based text formats are not supported in Site Studio v7.0.

What actions do I need to take?

You are required to manually migrate text formats from CKEditor 4 to CKEditor 5, this should be completed on Drupal 9.x before upgrading to 10.x.

For details on migration steps visit.

Are there any risks I should be aware of?

Some CKEditor plugins do not currently have support for CKEditor 5.

For more details please refer to the following: https://www.drupal.org/docs/core-modules-and-themes/core-modules/CKEditor-5-module/upgrade-coordination-for-modules-providing-CKEditor-4-plugins

Page builder button not appearing in some admin themes

What is it?

Fixes a bug where the Visual page builder was not appearing in other admin themes such as Gin.

What impact will there be?

The Visual page builder button will now appear as expected when using the Gin theme & toolbar.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Legacy Site Studio Sync user interface now hidden by default

What is it?

The legacy Site Studio Sync user interface options are only shown if a site builder enables "Show legacy sync in UI" within the Site Studio system settings. Legacy drush command are not affected.

What impact will there be?

The legacy sync options for importing and exporting Site Studio config will only appear in the UI if the "Show legacy sync in UI" has been enabled within the Site Studio system settings.

What actions do I need to take?

Toggling on "Show legacy sync in UI" in the Site Studio system settings is required to show the legacy options in the UI. We recommend for users to use the updated sync system, and only toggle this option on if required.

To enable this by default add the following to your settings.php file:

$config['cohesion.settings']['sync_legacy_visibility'] = TRUE;

Are there any risks I should be aware of?

None.

Module API hooks namespace update

What is it?

Module API hooks previously had the namespace of dx8, this has been updated to sitestudio. Previous hooks have been marked as deprecated.

What impact will there be?

The deprecated hooks will continue to work for the time being until removed, it is recommended to update any API hooks that your websites uses to the new namespace sitestudio.

What actions do I need to take?

If a website is using one of the API hooks, the namespace should be updated from dx8 to sitestudio.

Are there any risks I should be aware of?

If the API hooks namespace is not updated, then they will not work in a future version of Site Studio where the previous namespaces are used.

Custom element form HTML class change

What is it?

The format of the HTML classes used to layout custom element forms has been updated. Previously 'col-xs-12' is now 'ssa-grid-col-xs-12'.

What impact will there be?

If a site uses custom elements, the elements form will need the htmlClass in the form element array updated.

What actions do I need to take?

Custom elements forms will need the htmlClass in the form element array updated to the new format, or the form will not be laid out as expected. See 'example_element' module for examples.

Are there any risks I should be aware of?

If no action is taken, then the custom elements form will not be laid out as expected.

stable contrib module added as a dependency of Site Studio

What is it?

To provide support for both Drupal 9 & 10 a dependency on the stable module has been introduced to Site Studio.

Site Studio uses on stable theme as base theme for cohesion_theme theme, however, the stable theme this has been removed in Drupal core 10.x see https://www.drupal.org/node/3309392 for details.

What impact will there be?

Site Studio frontend features will continue to function as expected.

What actions do I need to take?

Download and enable the stable module and install stable theme.

Are there any risks I should be aware of?

None.

jquery_ui contrib module added as a dependency of Site Studio

What is it?

To provide support for both Drupal 9 & 10 a dependency on the jquery_ui module has been introduced to Site Studio.

Site Studio relies on jQuery UI for a number of frontend features, however, the library definition for this has been removed in Drupal core 10.x see drupal.org/project/drupal/issues/3277744 for details.

What impact will there be?

Site Studio frontend features will continue to function as expected.

What actions do I need to take?

Download and enable the jquery_ui module.

Are there any risks I should be aware of?

None.

Custom components can be ordered by a defined weight

What is it?

Custom components can now have a weight defined within the yml file, which allows them to be ordered with other custom components in the same category.

What impact will there be?

Custom components can now be ordered by weight, but only with other custom components in the same category. They will not be ordered within all components in the same category.

What actions do I need to take?

When adding a weight to the yml file the Drupal cache should be cleared for the ordering to take effect.

Are there any risks I should be aware of?

None.

Form helpers can be used in the custom component builder

What is it?

When building a custom component using the custom component builder, developers can now use form helpers to help with the development of their custom component forms.

What impact will there be?

Form helpers are now available from the sidebar browser on the custom component builder page and can be used to help build a custom components form.

What actions do I need to take?

A Site Studio import & Drupal cache clear.

Are there any risks I should be aware of?

None.

Custom components in-use tracking

What is it?

Custom component's usage can now be tracked via the Site Studio in-use system. Within the components list builder page, next to a custom component it will now display either an "in-use" link, so users can see where a custom component has been used or be shown as "Not in use".

What impact will there be?

Users can see where custom components have been placed.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Removing the "clone" option from Site Studio list builders

What is it?

Removing the "clone" option that the Entity Clone module adds, from Site Studio configuration list builders as Site Studio provides its own "duplicate" functionality. The "clone" functionality did not work as expected for Site Studio configuration entities.

What impact will there be?

If the Entity clone module is installed, the "clone" option will not appear in the operation list on Site Studio list builders.

What actions do I need to take?

If users want to "clone" a Site Studio configuration entity, use the "duplicate" operation.

Are there any risks I should be aware of?

None.

Create a component content from a custom component via the UI

What is it?

The ability to create a component content from a custom component direct in the UI at Site Studio > Components > Component Content > Create Component Content rather than from the Layout Canvas.

What impact will there be?

Component contents can be created from a custom component directly in the UI as is possible with components and no longer has to be created from a Layout Canvas.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Menu template loses menu link context after rendering menu links

What is it?

Fixes a bug where menu templates with multiple levels were losing token context depending on where the elements were placed within the menu template.

What impact will there be?

The token context will not be lost and the token content will now render as expected within the menu.

What actions do I need to take?

A Site Studio import & rebuild.

Are there any risks I should be aware of?

We recommend visually testing menu layout of a rendered pages for sites that have multi-level menus and are using tokens to display content for specific links.

Custom menu link attributes were not being added to menu links as expected

What is it?

Fixes an issue were when using the menu link attributes module, and adding custom attributes they were not being rendered as expected.

What impact will there be?

Custom menu link attributes added to menu items will now be rendered on menu links.

What actions do I need to take?

Perform a Site Studio import & rebuild as per the upgrade steps.

Are there any risks I should be aware of?

If custom attributes were added to menu links in the past they will now render.

Limit allowed HTML tags filter is now enabled by default on Site Studio text format

What is it?

The Limit allowed HTML tags and correct faulty HTML filter is now enabled by default on the Site Studio text format.

What impact will there be?

New Site Studio module installations will have theLimit allowed HTML tags and correct faulty HTML filter enabled on the Site Studio text format.

What actions do I need to take?

Existing sites are not affected by this change, but it is recommended to enable the Limit allowed HTML tags and correct faulty HTML filter on the Site Studio text format.

Are there any risks I should be aware of?

New Site Studio module installs or reinstalls, the "Site Studio" text format will now limit the use of HTML tags within WYSIWYGs to the specific HTML tags configured in the text format.

On existing Site Studio installs no change will occur and user action is required to limit the allowed HTML tags in the text format by enabling the Limit allowed HTML tags and correct faulty HTML filter in the "Site Studio" text format.

The menu-link tokens not working in menu templates

What is it?

The menu-link tokens were not rendering any values within menu templates.

What impact will there be?

The menu-link tokens will now work as expected in menu templates.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

View filter labels

What is it?

The View filter element has a new toggle option, "Show filter label", which when set will render the filter or sort label set within the Drupal view. By default, this option is toggled off for backward compatibility.

What impact will there be?

View filters can have labels that have been set within the Drupal view.

What actions do I need to take?

If a view filter should display a label, the "Show filter label" option should be toggled on within the view filter element.

Are there any risks I should be aware of?

None.

Content template url is malformed when used in a multisite/subdir context

What is it?

Fixes a bug when adding a Drupal field to a content template under multisite in a subdirectory context.

What impact will there be?

The underlying API call is correctly formed and the field edit form loads as expected.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

PHP 8.1 Deprecation warning when an icon library contains a null value

What is it?

Fixes a PHP 8.1 deprecation warning when an icon library contains a null value.

What impact will there be?

Logs will be silent when an icon value is null in PHP 8.1.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Layout canvas changes are lost when server side validation and refresh takes place

What is it?

When using a required checkbox or radio button field in a content type, form validation will trigger a page refresh causing layout canvas changes to be lost if the required field is not populated.

What impact will there be?

Form validation will retain layout canvas changes regardless of page refresh.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Visual page builder initialized incorrectly

What is it?

Fixes a bug where the visual page builder would initialize when a Layout canvas field was used in a block. This would result in an error.

What impact will there be?

The visual page builder will only be initialized if the entity type has a layout canvas field. Nested entities that contain layout canvas fields will not enable the visual page builder.

What actions do I need to take?

Cache clear.

Are there any risks I should be aware of?

None.

PHP 8.1 support added

What is it?

Ensures php code meets php 8.1 standards and removes any errors or warnings from logs.

What impact will there be?

Site Studio 6.9.4 and above can be used without warnings or errors being logged.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Updating multiple twig functions to respect Drupal entity permissions

What is it?

Unpublished referenced entities sometimes would be still rendered for users without permissions to view such entities. This now has been resolved.

What impact will there be?

When rendering referenced entities Drupal permissions and entity status will be respected.

What actions do I need to take?

Cache clear.

Are there any risks I should be aware of?

If the website used this bug as a feature where unpublished entities were still displayed when used as referenced entities via Layout Canvas, this will need to be addressed.

Updating Image Browser Update manager to use ModuleHandlerInterface

What is it?

Updates the image browser update manager to use ModuleHandlerInterface rather than ModuleHandler. This caused some errors when contrib modules overwrote the default ModuleHandler.

What impact will there be?

If a site uses a module that overrides the default ModuleHandler, no errors relating to ModuleHandler should occur.

What actions do I need to take?

Cache clear.

Are there any risks I should be aware of?

None.

Page builder incorrectly displaying drop zones from components that contained a nested component with a drop zone

What is it?

Fixes a bug where drop zones were appearing on the page builder from nested components, causing JS errors such as "Cannot read properties of undefined ( reading 'parentUid')" when attempting to insert new components. Only drop zones from components on a node layout canvas should appear in the page builder.

What impact will there be?

Only drop zones from components on a node layout canvas will appear. Drop zones from a component in a component will not appear on the page builder, reflecting the node layout canvas.

Users should not experience JS errors when attempting to insert components onto the layout canvas in the page builder.

What actions do I need to take?

Cache clear and Site Studio rebuild.

Are there any risks I should be aware of?

None.

Nested accordion tabs components navigation links incorrect

What is it?

Fixes a bug where nested accordion tabs components navigation links were all the same. This meant users would not be able to navigate between the accordion items.

What impact will there be?

The navigation links will be correct and clicking on them will show the correct accordion item content.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Nested components in a pattern repeater resulted in same styling

What is it?

Fixes a bug where nested components in a pattern repeater resulted in the same styling when it should be different for each repeated item.

What impact will there be?

The styling will appear as expected and will be different for each repeated item if set in the component.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Error appeared on the page builder when editing a translated node that contained a component in a component

What is it?

Fixes a bug where the error "Cannot read properties of undefined (reading ' uuid')" appeared whilst editing a translated node that contained a component in a component on the layout canvas.

This error specifically appeared when editing using the Visual Page Builder.

What impact will there be?

The error "Cannot read properties of undefined (reading 'uuid')", will no longer appear when editing a translated node that contains a component in a component. Users will be able to edit the translated node as expected using the Visual Page Builder.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Any new component created by saving from the layout canvas cannot be used.

What is it?

Creating a component from within the layout canvas ellipsis menu results in a broken component that cannot be used.

What impact will there be?

Components can successfully be created from within the layout canvas ellipsis menu.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Resolves package export crashing when handling recursive config dependencies

What is it?

Fixes a bug where the package export process would crash if a recursive config dependency was encountered.

What impact will there be?

Recursive config dependencies will be handled without issues

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Adds support for relative paths to sitestudio:package:multi-import

What is it?

Fixes a bug where the sitestudio:package:multi-import would only work with absolute paths. After this change both absolute and relative paths are supported.

What impact will there be?

Relative paths will be allowed to be used both as argument to the sitestudio:package:multi-import command and as package definitions in multi-package manifest file.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Duplicate styles on same component

What is it?

Fixes a bug where the same styles or no styles were applied when the same type of component was placed on the page

What impact will there be?

All styles will now come through without any duplicate

What actions do I need to take?

drush cohesion:rebuild

Are there any risks I should be aware of?

None.

Exported packages files store metadata in individual files

What is it?

Packages exported in new format no longer store all of exported file entity metadata in a single sitestudio_package_files.json file. Instead each file entity metadata is exported as individual file prefixed with sitestudio_file_metadata and using .yml extension.

What impact will there be?

All new package exports will no longer contain sitestudio_package_files.json file. Individual metadata files using filename format of sitestudio_file_metadata.<uuid>.yml will be exported instead.

Any packages that already use sitestudio_package_files.json will continue to work as before. If such package is exported, metadata from sitestudio_package_files.json will be split into individual files after this update.

What actions do I need to take?

Export your packages via Drush or Drupal UI and make sure to commit all of the additionally created metadata files, if git is used.

Are there any risks I should be aware of?

None.

Creating a component content from a custom component on a layout canvas

What is it?

Fixes a bug when creating a component content from a custom component on a layout canvas the newly created component content would not appear in the sidebar browser.

What impact will there be?

Component contents can be created from a custom component on a layout canvas and they will appear in the sidebar browser as expected.

Any existing component contents created from a custom component via the layout canvas will now appear in the sidebar browser after running the database update.

What actions do I need to take?

Run Drupal update via drush or UI.

Are there any risks I should be aware of?

None.

Create a component content from a custom component via the UI

What is it?

The ability to create a component content from a custom component direct in the UI at Site Studio > Components > Component Content > Create Component Content rather than from the Layout Canvas.

What impact will there be?

Component contents can be created from a custom component directly in the UI as is possible with components and no longer has to be created from a Layout Canvas.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Deleting an item from a Pattern repeater that contains a Link field the last item is always deleted

What is it?

Fixes a bug when a Component has a Pattern repeater with a Link field inside the last item would always be deleted.

What impact will there be?

The correct item will now be deleted.

What actions do I need to take?

Run an API import drush cohesion:import when upgrading.

Are there any risks I should be aware of?

None.

Resolves fatal error when using Site Studio and the Component modules together

What is it?

Fixes the fatal error Fatal error: Cannot redeclare _component_build_library() when both Site Studio and the Component modules are installed together.

What impact will there be?

Both Site Studio and the Component modules can be installed together.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

A nested component with multiple instances, with inline styles always using the first components styles

What is it?

Fixes a bug where inline styles of a nested component with multiple instances of the same component were present. The styles are configurable in the component form, but would always use the first instances styles, rather than the styles set for that component instance.

What impact will there be?

If the component has a configurable form that applies inline styles, the correct styles will be applied for that component instance, rather than using the first instances styles.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Transitioning content between moderation states on the Visual page builder resulting in an error

What is it?

Fixes a bug when attempting to transition content between moderation states, on the Visual page builder, the user receives the error Invaild state transition from.. although the state transition should be valid. This appeared to only occur on content types configured to use revisions.

Transitioning between these states worked as expected on the backend edit page.

What impact will there be?

The error Invaild state transition from.. should only appear when attempting to transition to an invalid state.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Includes "indirect" dependencies when exporting new format packages

What is it?

Fixes a bug where only direct dependencies would only be included in package export.

What impact will there be?

Additional files will be present in new format package exports.

What actions do I need to take?

Run a sitestudio:package:export command or use UI to export new format package complete with previously missing dependencies.

Are there any risks I should be aware of?

None.

Machine names are displayed in categories list

What is it?

Adds a new column to the "Component categories" entity list named "Machine names (id)" that contains each category "machine name" (id) used by Drupal.

What impact will there be?

It is possible now to quickly find category machine name without having to edit it.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Site studio custom components

What is it?

Adds a new feature to Site studio where developers can create their own components by coding them with Javascript/HTML/CSS or Twig/Javascript/CSS. Refer to the user guide for more detailed documentation on how to create and use custom components.

Custom component examples can be found in a submodule (example_custom_component). This module is intended for demonstration purposes only and should not be enabled on production.

What impact will there be?

Developers will be able to extend Site studio capabilities by defining their own custom components. This will enable Site Studio to have functionality that previously could not be built with Site Studio elements.

Javascript developers with limited knowledge of Drupal will be able to add custom component to Site Studio without the need for a Drupal developer. A Drupal developer will only be required for creating a module and file structure. Refer to the user guide for more information.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Site Studio package multi-import command for Drush

What is it?

A new drush command that takes package list file as an argument and imports multiple packages at once with a combined rebuild process based on imported changes.

What impact will there be?

This will allow specifying multiple packages to be imported into a site in a specific order with a single optimised rebuild process. There is also a PackageImportHandler (cohesion_sync.package_import_handler) service available to access such functionality via PHP and Drupal services.

What actions do I need to take?

The new command is sitestudio:package:multi-import --path=<path/to/package_list.yml. Package list needs to follow specific format for the command to work, more information is available here.

Are there any risks I should be aware of?

Only new format packages (exports containing multiple yaml files, rather than single aggregated yaml file) are supported. Strict format of package list file needs to be followed. Import happens in the same order as listed in a package list. If multiple package import the same entity, only the last import will be taken into consideration. Reading documentation before attempting to use the new command is strongly recommended

Next generation images

What is it?

Adds the ability to use Next generation images such as .avif and .webp images when using the Picture Element (subject to Drupal supporting these image formats).

What impact will there be?

This will fix an issue where the fallback image was the first image added to a Picture Element. The last image added to the Picture Element will now be used as the fallback.

What actions do I need to take?

drush cohesion:rebuild

Are there any risks I should be aware of?

None.

Missing permission check for saving components/helpers from a layout canvas

What is it?

The "Save" option allowed a user to save the layout canvas (or an item on it) both as Helper and as Component even if the user did not have permission to do so.

What impact will there be?

Users will now need the 'administer helpers' and/or 'administer components' permissions to use the Save functionality on layout canvases.

What actions do I need to take?

You may need to update user permissions if you were relying on this functionality.

Are there any risks I should be aware of?

None.

Site Studio generated CSS will now be aggregated

What is it?

Any stylesheet generated by Site Studio will now be aggregated with the rest of the website styles

What impact will there be?

All styles will now be aggregated increasing frontend performance.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Component contents not rendering

What is it?

Fixes an issue where component contents were not rendering after reverting to a previous revision or publishing a draft.

What impact will there be?

Component contents will now render as expected.

What actions do I need to take?

Run a rebuild as part of upgrading to this version.

Are there any risks I should be aware of?

None.

Inline css media queries will not render if all component fields are empty

What is it?

In the event where one or multiple fields attached to a style on a specific media query are not populated when the component is used, the media query will not render at all.

What impact will there be?

This will fix an issue where empty media query css would render, having no effect on the page

What actions do I need to take?

drush cohesion:rebuild

Are there any risks I should be aware of?

None.

Improvements to the link auto complete endpoint

What is it?

Some improvements made to the link auto complete endpoint used in the link element, which should improvement performance and use less memory. When inserting an external link the endpoint won't continue to look for content.

What impact will there be?

The auto complete functionality used in the link element should use less memory. When using the entity type selection within the link element, it now correctly displays the supported types. These types include: nodes, views, taxonomy terms, users, media and files.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.

Uncaught ReferenceError: _ is not defined console error

What is it?

Fixes a bug when editing a component on a layout canvas, the sidebar editor would throw a console error. If aggregation was enabled the sidebar browser did not load as expected.

What impact will there be?

This error will no longer appear and the sidebar editor will load as expected if aggregation is enabled.

What actions do I need to take?

None.

Are there any risks I should be aware of?

None.