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

feat: add theme toggle button to error overlay #5884

Merged
merged 8 commits into from
Jan 18, 2023
Merged

feat: add theme toggle button to error overlay #5884

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
3ac4e70
feat: add theme toggle button for error overlay
MoustaphaDev Jan 17, 2023
e9f73a8
add changeset
MoustaphaDev Jan 17, 2023
d17ca3d
simplify toggling logic
MoustaphaDev Jan 18, 2023
34889f6
redesign toggle
MoustaphaDev Jan 17, 2023
635b08a
code figma design
MoustaphaDev Jan 18, 2023
45c4daf
style: remove code indent
MoustaphaDev Jan 18, 2023
b2967e7
add `aria-hidden` to svgs
MoustaphaDev Jan 18, 2023
dafd26e
apply Yan a11y suggestions
MoustaphaDev Jan 18, 2023
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
63 changes: 60 additions & 3 deletions packages/astro/src/core/errors/overlay.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,12 @@ const style = /* css */ `
rgba(255, 255, 255, 0.96449) 78.38%,
rgba(255, 255, 255, 0.991353) 84.11%,
#ffffff 89.84%
);
);

/* Theme toggle */
--theme-toggle-color: #6B7280;
--theme-toggle-background-hover-and-focus: var(--box-background);


/* Syntax Highlighting */
--shiki-color-text: #000000;
Expand All @@ -74,8 +79,7 @@ const style = /* css */ `
--shiki-token-link: #ee0000;
}

@media (prefers-color-scheme: dark) {
:host {
:host(.astro-dark) {
--background: #090b11;
--error-text: #f49090;
--error-text-hover: #ffaaaa;
Expand Down Expand Up @@ -110,6 +114,9 @@ const style = /* css */ `
#090b11 89.84%
);

/* Theme toggle */
--theme-toggle-color: #9CA3AF;

/* Syntax Highlighting */
--shiki-color-text: #ffffff;
--shiki-token-constant: #90f4e3;
Expand All @@ -122,8 +129,29 @@ const style = /* css */ `
--shiki-token-punctuation: #ffffff;
--shiki-token-link: #ee0000;
}

MoustaphaDev marked this conversation as resolved.
Show resolved Hide resolved
#theme-toggle{
display: inline-flex;
padding: 0.625rem;
color: var(--theme-toggle-color);
background-color: var(--theme-toggle-background);
font-size: 0.875rem;
line-height: 1.25rem;
align-items: center;
border-radius: 0.5rem;
border: none;
}

MoustaphaDev marked this conversation as resolved.
Show resolved Hide resolved
#theme-toggle:focus{
box-shadow: 0 0 0 4px var(--theme-toggle-background-hover-and-focus);
outline: 0;
}

#theme-toggle:hover{
background-color: var(--theme-toggle-background-hover-and-focus);
}


#backdrop {
font-family: var(--font-monospace);
position: fixed;
Expand Down Expand Up @@ -172,6 +200,7 @@ const style = /* css */ `
#header-left {
min-height: 63px;
display: flex;
align-items: flex-start;
flex-direction: column;
justify-content: end;
}
Expand Down Expand Up @@ -392,6 +421,13 @@ ${style.trim()}
<div id="layout">
<header id="header">
<section id="header-left">
<button type="button" aria-label="labelToggle between Dark and Light mode" id="theme-toggle">
<svg xmlns="http://www.w3.org/2000/svg" width="44" height="44" viewBox="0 0 24 24" stroke-width="1.5" stroke="#2c3e50" fill="none" stroke-linecap="round" stroke-linejoin="round">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<circle cx="12" cy="12" r="4" />
<path d="M3 12h1m8 -9v1m8 8h1m-9 8v1m-6.4 -15.4l.7 .7m12.1 -.7l-.7 .7m0 11.4l.7 .7m-12.1 -.7l-.7 .7" />
</svg>
</button>
<h2 id="name"></h2>
<h1 id="title">An error occurred.</h1>
</section>
Expand Down Expand Up @@ -445,6 +481,27 @@ class ErrorOverlay extends HTMLElement {
this.root = this.attachShadow({ mode: 'open' });
this.root.innerHTML = overlayTemplate;

// theme toggle logic
const themeToggleButton = this.root.querySelector<HTMLButtonElement>('#theme-toggle');
if (
localStorage.astroErrorOverlayTheme === 'dark' ||
Copy link
Member Author

@MoustaphaDev MoustaphaDev Jan 17, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Not sure if it would've been an issue, but I made the name of the key this lengthy so that it'd be unlikely to coincide with a key already in local storage that the developer had set in their main site.

(!('astroErrorOverlayTheme' in localStorage) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
this?.classList.add('astro-dark');
} else {
this?.classList.remove('astro-dark');
}
themeToggleButton?.addEventListener('click', () => {
if (localStorage.astroErrorOverlayTheme === 'dark') {
this?.classList.remove('astro-dark');
localStorage.astroErrorOverlayTheme = 'light';
} else {
this?.classList.add('astro-dark');
localStorage.astroErrorOverlayTheme = 'dark';
}
MoustaphaDev marked this conversation as resolved.
Show resolved Hide resolved
});

this.text('#name', err.name);
this.text('#title', err.title);
this.text('#message-content', err.message, true);
Expand Down