-
Notifications
You must be signed in to change notification settings - Fork 465
Add a theme toggle to the home page and follow the system theme by default #5800
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
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
a6189f4
Add the ability to switch between light/system/dark theme modes
canova e8c46eb
Add a mock for window.matchMedia
canova 90275cd
Add a UI for the theme toggle inside the home page
canova 0f8f485
Change the theme when the user color scheme preference changes
canova 5445a18
Update the toggleDarkMode function to cycle through 3 of them
canova File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| /* This Source Code Form is subject to the terms of the Mozilla Public | ||
| * License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ | ||
|
|
||
| .themeToggle { | ||
| display: inline-flex; | ||
| align-items: center; | ||
| padding: 2px; | ||
| border: 1px solid var(--grey-30); | ||
| border-radius: 6px; | ||
| margin: 0 0.5em; | ||
| background: var(--grey-10); | ||
| box-shadow: 0 1px 2px rgb(0 0 0 / 0.05); | ||
| } | ||
|
|
||
| .themeToggleButton { | ||
| position: relative; | ||
| display: flex; | ||
| width: 32px; | ||
| height: 28px; | ||
| align-items: center; | ||
| justify-content: center; | ||
| padding: 0; | ||
| border: none; | ||
| border-radius: 4px; | ||
| background: transparent; | ||
| color: var(--grey-50); | ||
| cursor: pointer; | ||
| font-size: 16px; | ||
| transition: all 150ms ease-in-out; | ||
| } | ||
|
|
||
| .themeToggleButton:hover:not(.themeToggleButton-active) { | ||
| background: var(--grey-20); | ||
| } | ||
|
|
||
| .themeToggleButton-active { | ||
| background: white; | ||
| box-shadow: | ||
| 0 1px 3px rgb(0 0 0 / 0.12), | ||
| 0 1px 2px rgb(0 0 0 / 0.08); | ||
| color: var(--grey-90); | ||
| } | ||
|
|
||
| .themeToggleButton-active:hover { | ||
| background: white; | ||
| } | ||
|
|
||
| /* Theme toggle icons using CSS mask */ | ||
|
|
||
| .themeToggleIcon { | ||
| display: block; | ||
| width: 16px; | ||
| height: 16px; | ||
| background-color: currentcolor; | ||
| mask-position: center; | ||
| mask-repeat: no-repeat; | ||
| mask-size: contain; | ||
| } | ||
|
|
||
| .themeToggleIcon--light { | ||
| mask-image: url('firefox-profiler-res/img/svg/theme-light.svg'); | ||
| } | ||
|
|
||
| .themeToggleIcon--system { | ||
| mask-image: url('firefox-profiler-res/img/svg/theme-system.svg'); | ||
| } | ||
|
|
||
| .themeToggleIcon--dark { | ||
| mask-image: url('firefox-profiler-res/img/svg/theme-dark.svg'); | ||
| } | ||
|
|
||
| /* Dark mode styles */ | ||
|
|
||
| :root.dark-mode { | ||
| .themeToggle { | ||
| border-color: var(--grey-60); | ||
| background: var(--grey-90); | ||
| box-shadow: 0 1px 2px rgb(0 0 0 / 0.3); | ||
| } | ||
|
|
||
| .themeToggleButton { | ||
| color: var(--grey-40); | ||
| } | ||
|
|
||
| .themeToggleButton:hover:not(.themeToggleButton-active) { | ||
| background: var(--grey-80); | ||
| } | ||
|
|
||
| .themeToggleButton-active { | ||
| background: var(--grey-70); | ||
| box-shadow: | ||
| 0 1px 3px rgb(0 0 0 / 0.4), | ||
| 0 1px 2px rgb(0 0 0 / 0.3); | ||
| color: white; | ||
| } | ||
|
|
||
| .themeToggleButton-active:hover { | ||
| background: var(--grey-70); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| /* This Source Code Form is subject to the terms of the Mozilla Public | ||
| * License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ | ||
|
|
||
| import * as React from 'react'; | ||
| import { PureComponent } from 'react'; | ||
| import { Localized } from '@fluent/react'; | ||
| import type { ThemePreference } from 'firefox-profiler/utils/dark-mode'; | ||
| import { | ||
| getThemePreference, | ||
| setThemePreference, | ||
| } from 'firefox-profiler/utils/dark-mode'; | ||
|
|
||
| import './ThemeToggle.css'; | ||
|
|
||
| type State = { | ||
| currentTheme: ThemePreference; | ||
| }; | ||
|
|
||
| class ThemeToggle extends PureComponent<{}, State> { | ||
| override state = { | ||
| currentTheme: getThemePreference(), | ||
| }; | ||
|
|
||
| override componentDidMount() { | ||
| // Listen for storage events (cross-tab sync) | ||
| window.addEventListener('storage', this._handleStorageChange); | ||
|
|
||
| // Listen for system preference changes | ||
| const mediaQuery = window.matchMedia('(prefers-color-scheme: dark)'); | ||
| mediaQuery.addEventListener('change', this._handleSystemPreferenceChange); | ||
| } | ||
|
|
||
| override componentWillUnmount() { | ||
| window.removeEventListener('storage', this._handleStorageChange); | ||
|
|
||
| const mediaQuery = window.matchMedia('(prefers-color-scheme: dark)'); | ||
| mediaQuery.removeEventListener( | ||
| 'change', | ||
| this._handleSystemPreferenceChange | ||
| ); | ||
| } | ||
|
|
||
| _handleStorageChange = (e: StorageEvent) => { | ||
| if (e.key === 'theme' || e.key === null) { | ||
| this.setState({ currentTheme: getThemePreference() }); | ||
| } | ||
| }; | ||
|
|
||
| _handleSystemPreferenceChange = () => { | ||
| // Update state if user is on system preference | ||
| if (this.state.currentTheme === 'system') { | ||
| this.setState({ currentTheme: getThemePreference() }); | ||
| } | ||
| }; | ||
|
|
||
| _handleLightClick = () => { | ||
| setThemePreference('light'); | ||
| this.setState({ currentTheme: 'light' }); | ||
| }; | ||
|
|
||
| _handleSystemClick = () => { | ||
| setThemePreference('system'); | ||
| this.setState({ currentTheme: 'system' }); | ||
| }; | ||
|
|
||
| _handleDarkClick = () => { | ||
| setThemePreference('dark'); | ||
| this.setState({ currentTheme: 'dark' }); | ||
| }; | ||
|
|
||
| _renderIconButton( | ||
| theme: ThemePreference, | ||
| labelL10nId: string, | ||
| icon: React.ReactNode, | ||
| onClick: () => void | ||
| ) { | ||
| const isActive = this.state.currentTheme === theme; | ||
| return ( | ||
| <Localized id={labelL10nId} attrs={{ title: true }}> | ||
| <button | ||
| type="button" | ||
| className={`themeToggleButton ${isActive ? 'themeToggleButton-active' : ''}`} | ||
| onClick={onClick} | ||
| aria-label={theme} | ||
| > | ||
| {icon} | ||
| </button> | ||
| </Localized> | ||
| ); | ||
| } | ||
|
|
||
| override render() { | ||
| return ( | ||
| <div className="themeToggle"> | ||
| {this._renderIconButton( | ||
| 'light', | ||
| 'ThemeToggle--light', | ||
| <span className="themeToggleIcon themeToggleIcon--light" />, | ||
| this._handleLightClick | ||
| )} | ||
| {this._renderIconButton( | ||
| 'system', | ||
| 'ThemeToggle--system', | ||
| <span className="themeToggleIcon themeToggleIcon--system" />, | ||
| this._handleSystemClick | ||
| )} | ||
| {this._renderIconButton( | ||
| 'dark', | ||
| 'ThemeToggle--dark', | ||
| <span className="themeToggleIcon themeToggleIcon--dark" />, | ||
| this._handleDarkClick | ||
| )} | ||
| </div> | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| export { ThemeToggle }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A new component but no hooks? I mean that's fine, I'm just surprised.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Heh yeah. well, I feel like it's better to continue using the existing patterns that we have, but we need to do the switch at some point. It could actually be nicer to handle the cleanup for these, but I'll defer that to a follow-up.