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.

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

feat(placement): hp takeover #9022

Merged
merged 3 commits into from
Jun 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 8 additions & 1 deletion client/src/homepage/index.scss
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,17 @@
align-items: center;
display: flex;
flex-direction: column;
gap: 2rem;
overflow-x: clip;
overflow-y: visible;
position: relative;

width: 100%;

> * {
margin-top: 2rem;
}

> *:first-child {
margin-top: 0;
}
}
3 changes: 3 additions & 0 deletions client/src/homepage/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,19 @@ import FeaturedArticles from "./featured-articles";
import { LatestNews } from "./latest-news";
import RecentContributions from "./recent-contributions";
import { ContributorSpotlight } from "./contributor-spotlight";
import { HpFooterPlacement, HpMainPlacement } from "../ui/organisms/placement";

export function Homepage(props) {
return (
<main id="content" role="main">
<div className="homepage mdn-ui-body-m">
<HomepageHero />
<HpMainPlacement />
<FeaturedArticles {...props} />
<LatestNews {...props} />
<RecentContributions {...props} />
<ContributorSpotlight {...props} />
<HpFooterPlacement />
</div>
</main>
);
Expand Down
8 changes: 5 additions & 3 deletions client/src/placement-context.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,17 @@ export interface PlacementData {
};
}

type PlacementType = "side" | "top";
type PlacementType = "side" | "top" | "hpMain" | "hpFooter";
export interface PlacementContextData
extends Partial<Record<PlacementType, PlacementData>> {
status: Status;
}

const PLACEMENT_MAP: Record<PlacementType, RegExp> = {
side: /\/[^/]+\/(docs\/|blog\/|search$|_homepage)/i,
top: /.*/i,
side: /\/[^/]+\/(docs\/|blog\/|search$)/i,
top: /\/[^/]+\/(?!$|_homepage$).*/i,
hpMain: /\/[^/]+\/($|_homepage$)/i,
hpFooter: /\/[^/]+\/($|_homepage$)/i,
};

function placementTypes(pathname: string): string[] {
Expand Down
16 changes: 16 additions & 0 deletions client/src/ui/organisms/placement/index.scss
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,22 @@ section.place {
}
}

section.place.hp-main {
background-color: var(--place-hp-main-background);
margin: 0;
width: 100%;

a {
display: flex;
justify-content: center;
width: 100%;

img {
height: auto;
}
}
}

.top-banner {
--place-top-background-light: var(--background-secondary);
--place-top-color-light: var(--text-primary);
Expand Down
254 changes: 187 additions & 67 deletions client/src/ui/organisms/placement/index.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { useCallback, useEffect, useRef } from "react";
import { useIsServer, usePageVisibility } from "../../../hooks";
import { useUserData } from "../../../user-context";
import { User, useUserData } from "../../../user-context";

import "./index.scss";
import { useGleanClick } from "../../../telemetry/glean-context";
Expand All @@ -17,6 +17,19 @@ interface Timer {
notVisible?: boolean;
}

interface PlacementRenderArgs {
place: any;
extraClassNames?: string[];
click: string;
image: string;
imageWidth: number;
imageHeight: number;
copy?: string;
cta?: string;
user: User;
style: object;
}

function viewed(
pong: PlacementData,
observer: IntersectionObserver | null = null
Expand All @@ -42,6 +55,7 @@ export function SidePlacement() {
extraClassNames={["side"]}
imageWidth={130}
imageHeight={100}
renderer={RenderSideOrTopBanner}
></PlacementInner>
);
}
Expand Down Expand Up @@ -114,24 +128,76 @@ export function TopPlacement() {
extraClassNames={["top", "container"]}
cta={placementData.top?.cta}
imageHeight={50}
renderer={RenderSideOrTopBanner}
></PlacementInner>
)}
</div>
);
}

export function HpMainPlacement() {
const placementData = usePlacement();
return HpPlacement({
placementData: placementData?.hpMain,
imageWidth: 970,
imageHeight: 250,
});
}

export function HpFooterPlacement() {
const placementData = usePlacement();
return HpPlacement({
placementData: placementData?.hpFooter,
imageWidth: 728,
imageHeight: 90,
});
}

function HpPlacement({
placementData,
imageWidth,
imageHeight,
}: {
placementData?: PlacementData;
imageWidth: number;
imageHeight: number;
}) {
const { backgroundColor } = placementData?.colors || {};
const css = Object.fromEntries(
[["--place-hp-main-background", backgroundColor]].filter(([_, v]) =>
Copy link
Member

Choose a reason for hiding this comment

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

nit: similarly, could this be more generic and be something like --place-hp-banner-background

Boolean(v)
)
);
return !placementData ? (
<section className="place hp-main"></section>
) : (
<PlacementInner
pong={placementData}
extraClassNames={["hp-main"]}
Copy link
Member

Choose a reason for hiding this comment

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

nit: could this be more generic and be hp-takover-banner or something?

imageWidth={imageWidth}
imageHeight={imageHeight}
style={css}
renderer={RenderHpPlacement}
></PlacementInner>
);
}

export function PlacementInner({
pong,
extraClassNames = [],
cta,
imageWidth,
imageHeight,
style,
renderer,
}: {
pong: PlacementData;
extraClassNames?: string[];
cta?: string;
imageWidth?: number;
imageHeight?: number;
style?: object;
renderer: (PlacementRenderArgs) => JSX.Element;
}) {
const isServer = useIsServer();
const user = useUserData();
Expand Down Expand Up @@ -209,73 +275,127 @@ export function PlacementInner({

return (
<>
{!isServer && click && image && (
<>
<section
ref={place}
className={["place", ...extraClassNames].join(" ")}
{!isServer &&
click &&
image &&
renderer({
place,
extraClassNames,
click,
image,
imageWidth,
imageHeight,
copy,
cta,
user,
style,
})}
</>
);
}

function RenderSideOrTopBanner({
place,
extraClassNames = [],
click,
image,
imageWidth,
imageHeight,
copy,
cta,
user,
style,
}: PlacementRenderArgs) {
return (
<section
ref={place}
className={["place", ...extraClassNames].join(" ")}
style={style}
>
<p className="pong-box">
<a
className="pong"
data-pong="pong->click"
href={`/pong/click?code=${encodeURIComponent(click)}`}
target="_blank"
rel="noreferrer"
>
<img
src={`/pimg/${encodeURIComponent(image || "")}`}
aria-hidden="true"
alt=""
width={imageWidth}
height={imageHeight}
></img>
<span>{copy}</span>
</a>
{cta && (
<a
className="pong-cta"
data-pong="pong->click"
href={`/pong/click?code=${encodeURIComponent(click)}`}
target="_blank"
rel="noreferrer"
>
<p className="pong-box">
<a
className="pong"
data-pong="pong->click"
href={`/pong/click?code=${encodeURIComponent(click)}${
pong?.fallback
? `&fallback=${encodeURIComponent(pong?.fallback?.view)}`
: ""
}`}
target="_blank"
rel="noreferrer"
>
<img
src={`/pimg/${encodeURIComponent(image || "")}`}
aria-hidden="true"
alt=""
width={imageWidth}
height={imageHeight}
></img>
<span>{copy}</span>
</a>
{cta && (
<a
className="pong-cta"
data-pong="pong->click"
href={`/pong/click?code=${encodeURIComponent(click)}${
pong?.fallback
? `&fallback=${encodeURIComponent(pong?.fallback?.view)}`
: ""
}`}
target="_blank"
rel="noreferrer"
>
{cta}
</a>
)}
<a
href={pong?.fallback?.by || "/en-US/advertising"}
className="pong-note"
data-pong="pong->about"
target="_blank"
rel="noreferrer"
>
{pong?.fallback?.by ? "Ads by Carbon" : "Mozilla ads"}
</a>
</p>
{cta}
</a>
)}
<a
href="/en-US/advertising"
className="pong-note"
data-pong="pong->about"
target="_blank"
rel="noreferrer"
>
Mozilla ads
</a>
</p>

<a
className="no-pong"
data-pong={user?.isSubscriber ? "pong->settings" : "pong->plus"}
href={
user?.isSubscriber
? "/en-US/plus/settings?ref=nope"
: "/en-US/plus?ref=nope#subscribe"
}
>
Don't want to see ads?
</a>
</section>
</>
)}
</>
<a
className="no-pong"
data-pong={user?.isSubscriber ? "pong->settings" : "pong->plus"}
href={
user?.isSubscriber
? "/en-US/plus/settings?ref=nope"
: "/en-US/plus?ref=nope#subscribe"
}
>
Don't want to see ads?
</a>
</section>
);
}

function RenderHpPlacement({
place,
extraClassNames = [],
click,
image,
imageWidth,
imageHeight,
copy,
style,
}: PlacementRenderArgs) {
return (
<section
ref={place}
className={["place", ...extraClassNames].join(" ")}
style={style}
>
<a
className="pong"
data-pong="pong->click"
href={`/pong/click?code=${encodeURIComponent(click)}`}
target="_blank"
rel="noreferrer"
>
<img
src={`/pimg/${encodeURIComponent(image || "")}`}
alt={copy}
width={imageWidth}
height={imageHeight}
></img>
</a>
</section>
);
}
Loading