SHS-5988: Fix empty heading on postcards without title #1699
Conversation
|
@ahughes3 Please take a look at this comment before approving the PR. The Chemistry site is not in Tugboat, but the existing links in the cards break after applying this fix. I think that the fix is still necessary, but descriptive titles should be added if they want to keep the links working. |
| if (!empty($variables['title'])) { | ||
| $title = is_array($variables['title']) ? $renderer->renderInIsolation($variables['title']) : $variables['title']; | ||
| $variables['title'] = ['#markup' => trim(strip_tags($title))]; | ||
| $variables['title'] = $title ?? ['#markup' => trim(strip_tags($title))]; |
There was a problem hiding this comment.
Why does this work? I'm not really understanding.
if $variables['title'] is a render array, we get the rendering, otherwise it's would be a string. But either way $title is not null/false, so it would always set the value to what is returned in line 187. The ?? .... doesn't really do anything at this point.
There was a problem hiding this comment.
The thing is that in line 187 $title returned an empty string. So in line 188, if we don't add the ?? it will set $variables['title'] like this:
$variables['title'] will return an array in these scenario, so in the template vertical-card.html.twig it will seem that there's something in title even though it's an array with an #markup that is empty. This will add the h2.
There was a problem hiding this comment.
I'm also trying to understand what's going on here. If $variables['title'] is equal to an empty string it shouldn't get past the empty() conditional on line 186. Unless the renderInIsolation() method is returning an empty string?
Additionally, on line 188 if $title is empty, what's the purpose of stripping tags and trimming an empty string?
…-5988--fix-empty-heading-on-postcards-without-title
|
@ahughes3 I noticed that this ticket was closed. While the reported issue was a content problem, there's still an issue in the platform that will output an empty link and heading in the cards if the URL is present and the title field is empty. This PR prevents the empty elements from being displayed, but there's still an usability issue, because the users can add an URL in the cards that just just won't work if the title is absent, which can be confusing. I'd recommend to create a follow up ticket for fixing that. As for this PR, we can merge it to have a partial fix and prevent more SiteImprove errors or close it and work in a more complete fix in the follow up ticket. What do you think? |
|
Holding off on review until @ahughes3 responds to @cienvaras |
|
@cienvaras Let's move forward with this fix and create the follow up if this PR get's us in a better place that we are today |
READY FOR REVIEW
Summary
Fix empty heading on postcards without title
Urgency
medium
Steps to Test
Vertical Postcards with Title, Image and Link in a CollectionandVertical Postcards with Title and Image in a Collection(first of the third row of cards)PR Checklist