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

Add ability to render preview browsers (introduced in BCD 4.0.0) #3997

Merged
merged 3 commits into from
Aug 19, 2021
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
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,7 @@ $bc-partial-support-cross: rgba(144, 99, 18, 0.2);
.bc-supports-unknown {
background-color: $mdn-neutral100;
}

.bc-supports-preview {
background-color: $mdn-blue100;
}
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,11 @@ export function BrowserName({ id }: { id: bcd.BrowserNames }) {
}
return <>{browserInfo[id].name}</>;
}

export function BrowserPreviewName({ id }: { id: bcd.BrowserNames }) {
const browserInfo = useContext(BrowserInfoContext);
if (!browserInfo) {
throw new Error("Missing browser info");
}
return <>{browserInfo[id].preview_name}</>;
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import React, { useContext } from "react";
import type bcd from "@mdn/browser-compat-data/types";
import { BrowserInfoContext, BrowserName } from "./browser-info";
import {
BrowserInfoContext,
BrowserName,
BrowserPreviewName,
} from "./browser-info";
import { asList, getFirst, isTruthy } from "./utils";

// Yari builder will attach extra keys from the compat data
Expand Down Expand Up @@ -39,6 +43,8 @@ function getSupportClassName(
let className;
if (version_added === null) {
className = "unknown";
} else if (version_added === "preview") {
className = "preview";
} else if (version_added) {
className = "yes";
if (version_removed || (flags && flags.length)) {
Expand Down Expand Up @@ -93,7 +99,10 @@ function StatusIcons({ status }: { status: bcd.StatusBlock }) {
);
}

function labelFromString(version: string | boolean | null | undefined) {
function labelFromString(
version: string | boolean | null | undefined,
browser: bcd.BrowserNames
) {
if (typeof version !== "string") {
return <>{"?"}</>;
}
Expand All @@ -102,19 +111,31 @@ function labelFromString(version: string | boolean | null | undefined) {
if (version.startsWith("≤")) {
return <>{version.slice(1)}</>;
}
if (version === "preview") {
return <BrowserPreviewName id={browser} />;
}
return <>{version}</>;
}

const CellText = React.memo(
({ support }: { support: bcd.SupportStatement | undefined }) => {
({
support,
browser,
}: {
support: bcd.SupportStatement | undefined;
browser: bcd.BrowserNames;
}) => {
const currentSupport = getFirst(support);

const added = currentSupport && currentSupport.version_added;
const removed = currentSupport && currentSupport.version_removed;

let status:
| { isSupported: "unknown" }
| { isSupported: "no" | "yes" | "partial"; label?: React.ReactNode };
| {
isSupported: "no" | "yes" | "partial" | "preview";
label?: React.ReactNode;
};

switch (added) {
case null:
Expand All @@ -126,8 +147,11 @@ const CellText = React.memo(
case false:
status = { isSupported: "no" };
break;
case "preview":
status = { isSupported: "preview" };
break;
default:
status = { isSupported: "yes", label: labelFromString(added) };
status = { isSupported: "yes", label: labelFromString(added, browser) };
break;
}

Expand All @@ -136,15 +160,18 @@ const CellText = React.memo(
isSupported: "no",
label: (
<>
{labelFromString(added)}&#8202;&ndash;&#8202;
{labelFromString(removed)}
{labelFromString(added, browser)}&#8202;&ndash;&#8202;
{labelFromString(removed, browser)}
</>
),
};
} else if (currentSupport && currentSupport.partial_implementation) {
status = {
isSupported: "partial",
label: typeof added === "string" ? labelFromString(added) : "Partial",
label:
typeof added === "string"
? labelFromString(added, browser)
: "Partial",
};
}

Expand All @@ -166,6 +193,11 @@ const CellText = React.memo(
label = status.label || "No";
break;

case "preview":
title = "Preview browser support";
label = <BrowserPreviewName id={browser} />;
break;

case "unknown":
title = "Compatibility unknown; please update this.";
label = "?";
Expand Down Expand Up @@ -274,7 +306,12 @@ function getNotes(
item.version_removed
? {
iconName: "footnote",
label: `Removed in version ${item.version_removed} and later`,
label: (
<>
Removed in {labelFromString(item.version_removed, browser)}{" "}
and later
</>
),
}
: null,
item.partial_implementation
Expand Down Expand Up @@ -306,11 +343,17 @@ function getNotes(
(note) => ({ iconName: "footnote", label: note })
)
: null,
item.version_added === "preview"
? {
iconName: "footnote",
label: "Preview browser support",
}
: null,
// If we encounter nothing else than the required `version_added` and
// `release_date` properties, assume full support
Object.keys(item).filter(
(x) => !["version_added", "release_date"].includes(x)
).length === 0
).length === 0 && item.version_added !== "preview"
? {
iconName: "footnote",
label: "Full support",
Expand All @@ -330,7 +373,7 @@ function getNotes(
item
)} bc-supports`}
>
<CellText support={item} />
<CellText support={item} browser={browser} />
<CellIcons support={item} />
</dt>
{supportNotes.map(({ iconName, label }, i) => {
Expand Down Expand Up @@ -401,7 +444,7 @@ function CompatCell({
<span className="bc-browser-name">
<BrowserName id={browser} />
</span>
<CellText {...{ support }} />
<CellText {...{ support }} browser={browser} />
<CellIcons support={support} />
{hasNotes && (
<button
Expand Down