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

ntp: prevent gradients bleeding through #1382

Merged
merged 3 commits into from
Jan 9, 2025
Merged

ntp: prevent gradients bleeding through #1382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d421b78
ntp: prevent gradients bleeding through
shakyShane Jan 9, 2025
5281129
fixed tests
shakyShane Jan 9, 2025
75f1ac1
set explicit widths on icon+text to prevent overflows
shakyShane Jan 9, 2025
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
3 changes: 3 additions & 0 deletions special-pages/pages/new-tab/app/components/App.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ body {
body:has([data-reset-layout="true"]) .tube {
padding-top: 0;
}
body[data-animate-background="true"] {
transition: background-color .3s;
}

:global(.layout-centered) {
margin-inline: auto;
Expand Down
79 changes: 46 additions & 33 deletions special-pages/pages/new-tab/app/components/BackgroundProvider.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import { values } from '../customizer/values.js';
import { useContext, useState } from 'preact/hooks';
import { CustomizerContext } from '../customizer/CustomizerProvider.js';
import { detectThemeFromHex } from '../customizer/utils.js';
import { useSignalEffect } from '@preact/signals';

/**
* @import { BackgroundVariant, BrowserTheme } from "../../types/new-tab"
Expand Down Expand Up @@ -59,40 +60,56 @@ export function BackgroundConsumer({ browser }) {
const { data } = useContext(CustomizerContext);
const background = data.value.background;

switch (background.kind) {
case 'default': {
return <div className={styles.root} data-testid="BackgroundConsumer" data-background-kind="default" data-theme={browser} />;
useSignalEffect(() => {
const background = data.value.background;

// reflect some values onto the <body> tag
document.body.dataset.backgroundKind = background.kind;
let nextBodyBackground = '';

if (background.kind === 'gradient') {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just out of curiosity, was there a technical reason to not go with a switch or just personal preference?

const gradient = values.gradients[background.value];
nextBodyBackground = gradient.fallback;
}
if (background.kind === 'color') {
const color = values.colors[background.value];
nextBodyBackground = color.hex;
}
if (background.kind === 'hex') {
nextBodyBackground = background.value;
}
if (background.kind === 'userImage') {
const isDark = background.value.colorScheme === 'dark';
nextBodyBackground = isDark ? 'var(--default-dark-bg)' : 'var(--default-light-bg)';
}
if (background.kind === 'default') {
nextBodyBackground = browser.value === 'dark' ? 'var(--default-dark-bg)' : 'var(--default-light-bg)';
}

document.body.style.setProperty('background-color', nextBodyBackground);

// let animations occur, after properties above have been flushed to the DOM
if (!document.body.dataset.animateBackground) {
requestAnimationFrame(() => {
document.body.dataset.animateBackground = 'true';
});
}
});

switch (background.kind) {
case 'color':
case 'default':
case 'hex': {
return (
<div
class={styles.root}
data-animate="true"
data-testid="BackgroundConsumer"
style={{
backgroundColor: background.value,
}}
></div>
);
return null;
}
case 'color': {
const color = values.colors[background.value];
return (
<div
class={styles.root}
data-animate="true"
data-background-color={color.hex}
data-testid="BackgroundConsumer"
style={{
backgroundColor: color.hex,
}}
></div>
);
case 'userImage': {
const img = background.value;
return <ImageCrossFade src={img.src} />;
}
case 'gradient': {
const gradient = values.gradients[background.value];
return (
<Fragment key="gradient">
<Fragment>
<ImageCrossFade src={gradient.path}></ImageCrossFade>
<div
className={styles.root}
Expand All @@ -102,17 +119,13 @@ export function BackgroundConsumer({ browser }) {
opacity: 0.5,
mixBlendMode: 'soft-light',
}}
></div>
/>
</Fragment>
);
}
case 'userImage': {
const img = background.value;
return <ImageCrossFade src={img.src} />;
}
default: {
console.warn('Unreachable!');
return <div className={styles.root}></div>;
return null;
}
}
}
Expand Down
8 changes: 1 addition & 7 deletions special-pages/pages/new-tab/app/components/BackgroundReceiver.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,7 @@
pointer-events: none;

&[data-animate="true"] {
transition: background .25s ease-in-out;
}
&[data-background-kind="default"][data-theme=dark] {
background: var(--default-dark-bg);
}
&[data-background-kind="default"][data-theme=light] {
background: var(--default-light-bg);
transition: background .3s;
}
}

Expand Down
11 changes: 5 additions & 6 deletions special-pages/pages/new-tab/app/customizer/integration-tests/customizer.page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,21 +129,20 @@ export class CustomizerPage {

async hasDefaultBackground() {
const { page } = this.ntp;
await expect(page.getByTestId('BackgroundConsumer')).toHaveCSS('background-color', 'rgb(250, 250, 250)');
await expect(page.locator('body')).toHaveCSS('background-color', 'rgb(250, 250, 250)');
}

async hasDefaultDarkBackground() {
const { page } = this.ntp;
await expect(page.getByTestId('BackgroundConsumer')).toHaveCSS('background-color', 'rgb(51, 51, 51)');
await expect(page.locator('body')).toHaveCSS('background-color', 'rgb(51, 51, 51)');
}

/**
* @param {keyof typeof values.colors} color
* @param {string} expectedRGB
*/
async hasColorBackground(color) {
async hasColorBackground(expectedRGB) {
const { page } = this.ntp;
const value = values.colors[color];
await expect(page.getByTestId('BackgroundConsumer')).toHaveAttribute('data-background-color', value.hex);
await expect(page.locator('body')).toHaveCSS('background-color', expectedRGB);
}

async selectsColor() {
Expand Down
2 changes: 1 addition & 1 deletion special-pages/pages/new-tab/app/customizer/integration-tests/customizer.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ test.describe('newtab customizer', () => {
kind: 'color',
value: 'color01',
});
await cp.hasColorBackground('color01');
await cp.hasColorBackground('rgb(0, 0, 0)');
});
test('loads with the default background and accepts theme update', async ({ page }, workerInfo) => {
const ntp = NewtabPage.create(page, workerInfo);
Expand Down
7 changes: 5 additions & 2 deletions special-pages/pages/new-tab/app/favorites/components/Tile.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
.item {
--icon-width: 4rem;

display: block;
position: relative;
text-decoration: none;
Expand Down Expand Up @@ -29,8 +31,8 @@
display: grid;
align-content: center;
justify-items: center;
width: 4rem;
height: 4rem;
width: var(--icon-width);
height: var(--icon-width);
margin-bottom: 4px;
border-radius: var(--border-radius-lg);
}
Expand Down Expand Up @@ -89,6 +91,7 @@
}

.text {
width: var(--icon-width);
text-align: center;
font-size: calc(10 * var(--px-in-rem));
line-height: 1.1;
Expand Down
Loading