Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(sbb-message): support the use of figure as image #3294

Merged
merged 2 commits into from
Dec 12, 2024
Merged

fix(sbb-message): support the use of figure as image #3294

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5bf5d3f
fix(sbb-message): support the use of `figure` as image
TomMenga Dec 12, 2024
6838369
fix: pr feedback
TomMenga Dec 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/elements/core/styles/core.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,14 @@ sbb-lead-container {
}
}

// TODO: Move back to the sbb-message components when the global css refactoring happens
TomMenga marked this conversation as resolved.
Show resolved Hide resolved
sbb-message {
> [slot='image']:is(sbb-image, img),
> [slot='image'] :is(sbb-image, img) {
border-radius: var(--sbb-message-image-border-radius);
}
}

// Target the slotted `sbb-image` which are generally wrapped by a <figure> (therefore are not reachable with the :slotted)
// Apply the brightness effect on mouse hover
// TODO: Move back to the teaser components when the global css refactoring happens
Expand Down
4 changes: 3 additions & 1 deletion src/elements/message/message.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
:host {
--sbb-message-subtitle-color: var(--sbb-color-granite);
--sbb-message-image-margin-block: 0 var(--sbb-spacing-responsive-s);
--sbb-message-image-border-radius: var(--sbb-border-radius-4x);
--sbb-message-legend-margin-block: var(--sbb-spacing-responsive-xxxs) 0;
--sbb-message-action-margin-block: var(--sbb-spacing-responsive-xxxs) 0;

Expand All @@ -26,7 +27,8 @@
}

::slotted([slot='image']) {
margin-block: var(--sbb-message-image-margin-block);
display: block;
margin-block: var(--sbb-message-image-margin-block) !important; // overrides '.sbb-figure' margin
jeripeierSBB marked this conversation as resolved.
Show resolved Hide resolved
width: 100%;
}

Expand Down
70 changes: 52 additions & 18 deletions src/elements/message/message.visual.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,66 @@ import { describeViewports, visualDiffDefault } from '../core/testing/private.js
import { waitForImageReady } from '../core/testing.js';

import './message.js';
import '../chip-label.js';
import '../image.js';
import '../button/secondary-button.js';

const imageUrl = import.meta.resolve('../core/testing/assets/placeholder-image.png');

const imgTestCases = [
{
title: 'with sbb-image',
imgSelector: 'sbb-image',
imgTemplate: () => html`<sbb-image slot="image" image-src=${imageUrl}></sbb-image>`,
},
{
title: 'with img tag',
imgSelector: 'img',
imgTemplate: () => html`<img slot="image" src=${imageUrl} alt="" />`,
},
{
title: 'with figure_sbb-image',
imgSelector: 'sbb-image',
imgTemplate: () =>
html`<figure class="sbb-figure" slot="image">
<sbb-image image-src=${imageUrl}></sbb-image>
<sbb-chip-label class="sbb-figure-overlap-start-end">AI generated</sbb-chip-label>
</figure>`,
},
{
title: 'with figure_img',
imgSelector: 'img',
imgTemplate: () =>
html`<figure class="sbb-figure" slot="image">
<img slot="image" src=${imageUrl} alt="" />
<sbb-chip-label class="sbb-figure-overlap-start-end">AI generated</sbb-chip-label>
</figure>`,
},
];

describe(`sbb-message`, () => {
describeViewports({ viewports: ['zero', 'medium'] }, () => {
it(
'default',
visualDiffDefault.with(async (setup) => {
await setup.withFixture(html`
<sbb-message title-content="Unfortunately, an error has occurred.">
<sbb-image slot="image" image-src=${imageUrl}></sbb-image>
<p slot="subtitle">Please reload the page or try your search again later.</p>
<p slot="legend">Error code: 0001</p>
<sbb-secondary-button
slot="action"
icon-name="arrows-circle-small"
size="m"
></sbb-secondary-button>
</sbb-message>
`);
for (const testCase of imgTestCases) {
it(
`default ${testCase.title}`,
visualDiffDefault.with(async (setup) => {
await setup.withFixture(html`
<sbb-message title-content="Unfortunately, an error has occurred.">
${testCase.imgTemplate()}
<p slot="subtitle">Please reload the page or try your search again later.</p>
<p slot="legend">Error code: 0001</p>
<sbb-secondary-button
slot="action"
icon-name="arrows-circle-small"
size="m"
></sbb-secondary-button>
</sbb-message>
`);

await waitForImageReady(setup.snapshotElement.querySelector('sbb-image')!);
}),
);
await waitForImageReady(setup.snapshotElement.querySelector(testCase.imgSelector)!);
}),
);
}

it(
'no image',
Expand Down
Loading