Skip to content

Fix ReDoc preview being unreadable in dark themes #375

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

Open
tillig wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix ReDoc preview being unreadable in dark themes #375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 18 additions & 4 deletions src/preview.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ async function showPreview(

function buildWebviewPanel(
context: vscode.ExtensionContext,
name: string,
name: PreviewType,
title: string,
): Promise<vscode.WebviewPanel> {
const panel = vscode.window.createWebviewPanel(
Expand Down Expand Up @@ -198,15 +198,20 @@ function buildWebviewPanel(
),
);

panel.webview.html = getWebviewContent(panel.webview, index, style);
panel.webview.html = getWebviewContent(panel.webview, name, index, style);
});
}

// Directive connect-src must be set to allow XHR
function getWebviewContent(webview: vscode.Webview, index: vscode.Uri, style: vscode.Uri) {
function getWebviewContent(
webview: vscode.Webview,
name: PreviewType,
index: vscode.Uri,
style: vscode.Uri,
) {
const themeKind: ChangeThemeMessage["payload"]["kind"] =
kinds[vscode.window.activeColorTheme.kind];
const htmlClasses = themeKind === "dark" || themeKind === "highContrast" ? "dark-mode" : "";
const htmlClasses = shouldUseDarkMode(name, themeKind) ? "dark-mode" : "";

return `<!DOCTYPE html>
<html lang="en" class="${htmlClasses}">
Expand All @@ -230,3 +235,12 @@ function getWebviewContent(webview: vscode.Webview, index: vscode.Uri, style: vs
</body>
</html>`;
}

// Only SwaggerUI has dark mode styles; ReDoc keeps its light theme colors whatever the editor
// theme is, so a dark background leaves its text unreadable.
export function shouldUseDarkMode(
name: PreviewType,
themeKind: ChangeThemeMessage["payload"]["kind"],
): boolean {
return name === "swaggerui" && (themeKind === "dark" || themeKind === "highContrast");
}
16 changes: 16 additions & 0 deletions src/test/suite/preview.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import assert from "assert";
import { shouldUseDarkMode } from "../../preview";

suite("Preview", () => {
test("Method shouldUseDarkMode", () => {
assert.strictEqual(shouldUseDarkMode("swaggerui", "light"), false);
assert.strictEqual(shouldUseDarkMode("swaggerui", "dark"), true);
assert.strictEqual(shouldUseDarkMode("swaggerui", "highContrast"), true);
assert.strictEqual(shouldUseDarkMode("swaggerui", "highContrastLight"), false);

assert.strictEqual(shouldUseDarkMode("redoc", "light"), false);
assert.strictEqual(shouldUseDarkMode("redoc", "dark"), false);
assert.strictEqual(shouldUseDarkMode("redoc", "highContrast"), false);
assert.strictEqual(shouldUseDarkMode("redoc", "highContrastLight"), false);
});
});