feat: add Auto/Light/Dark theme support (fixes #1702) #2496
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
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
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
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,34 @@ | ||
| import React from 'react' | ||
| import { withTranslation } from 'react-i18next' | ||
| import { useTheme } from '../../contexts/theme-context.js' | ||
| import Title from '../../settings/Title.js' | ||
|
|
||
| const ThemeSelector = ({ t }) => { | ||
| const { theme, setTheme } = useTheme() | ||
|
|
||
| const onChange = (e) => { | ||
| setTheme(e.target.value) | ||
| } | ||
|
|
||
| return ( | ||
| <div className='joyride-settings-theme'> | ||
| <Title>{t('theme') || 'Theme'}</Title> | ||
|
Member
There was a problem hiding this comment. There is no |
||
| <div className='flex items-center'> | ||
| <select | ||
| className='w-100 mw4 pa2 ba b--black-20 br1 charcoal bg-white focus-outline focus-outline-blue' | ||
| value={theme} | ||
| onChange={onChange} | ||
| > | ||
| <option value='auto'>Auto</option> | ||
| <option value='light'>Light</option> | ||
| <option value='dark'>Dark</option> | ||
| </select> | ||
| <span className='ml3 f6 charcoal-muted'> | ||
| {t('themeDescription') || 'Choose a theme or sync with your system preference.'} | ||
| </span> | ||
| </div> | ||
| </div> | ||
| ) | ||
| } | ||
|
|
||
| export default withTranslation('settings')(ThemeSelector) | ||
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,25 @@ | ||
| // @ts-check | ||
| import ThemeSelector from './ThemeSelector.js' | ||
| import { ThemeProvider } from '../../contexts/theme-context.js' | ||
|
|
||
| /** | ||
| * @type {import('@storybook/react').Meta} | ||
| */ | ||
| export default { | ||
| title: 'Settings/Theme Selector', | ||
| component: ThemeSelector, | ||
| decorators: [ | ||
| (Story) => ( | ||
| <ThemeProvider> | ||
| <div className="pa4 bg-white" style={{ maxWidth: '400px' }}> | ||
| <Story /> | ||
| </div> | ||
| </ThemeProvider> | ||
| ) | ||
| ] | ||
| } | ||
|
|
||
| /** | ||
| * @type {import('@storybook/react').StoryObj} | ||
| */ | ||
| export const Default = {} |
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,24 @@ | ||
| import React from 'react' | ||
| import '@testing-library/jest-dom' | ||
| import { render, screen } from '@testing-library/react' | ||
| import ThemeSelector from './ThemeSelector.js' | ||
| import { ThemeProvider } from '../../contexts/theme-context.js' | ||
| import { I18nextProvider } from 'react-i18next' | ||
| import i18n from '../../i18n.js' | ||
|
|
||
| describe('ThemeSelector', () => { | ||
| it('renders correctly', () => { | ||
| render( | ||
| <I18nextProvider i18n={i18n}> | ||
| <ThemeProvider> | ||
| <ThemeSelector /> | ||
| </ThemeProvider> | ||
| </I18nextProvider> | ||
| ) | ||
|
|
||
| expect(screen.getByRole('combobox')).toBeInTheDocument() | ||
| expect(screen.getByText('Auto')).toBeInTheDocument() | ||
| expect(screen.getByText('Light')).toBeInTheDocument() | ||
| expect(screen.getByText('Dark')).toBeInTheDocument() | ||
| }) | ||
| }) |
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,52 @@ | ||
| import React from 'react' | ||
| import { useTranslation } from 'react-i18next' | ||
| import { useTheme } from '../../contexts/theme-context.js' | ||
| import StrokeMonitor from '../../icons/StrokeMonitor.js' | ||
|
|
||
| const SunIcon = ({ className, width, height }) => ( | ||
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" className={className} width={width} height={height}> | ||
| <circle cx="12" cy="12" r="5"></circle> | ||
| <line x1="12" y1="1" x2="12" y2="3"></line> | ||
| <line x1="12" y1="21" x2="12" y2="23"></line> | ||
| <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> | ||
| <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> | ||
| <line x1="1" y1="12" x2="3" y2="12"></line> | ||
| <line x1="21" y1="12" x2="23" y2="12"></line> | ||
| <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> | ||
| <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> | ||
| </svg> | ||
| ) | ||
|
|
||
| const MoonIcon = ({ className, width, height }) => ( | ||
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round" className={className} width={width} height={height}> | ||
| <path d="M21 12.79A9 9 0 1 1 11.21 3 7 7 0 0 0 21 12.79z"></path> | ||
| </svg> | ||
| ) | ||
|
|
||
| export const TopBarThemeToggle = () => { | ||
| const { theme, setTheme } = useTheme() | ||
| const { t } = useTranslation('settings') | ||
|
|
||
| const cycleTheme = () => { | ||
| if (theme === 'auto') setTheme('light') | ||
| else if (theme === 'light') setTheme('dark') | ||
| else setTheme('auto') | ||
| } | ||
|
|
||
| let Icon = StrokeMonitor | ||
| if (theme === 'light') Icon = SunIcon | ||
| if (theme === 'dark') Icon = MoonIcon | ||
|
|
||
| return ( | ||
| <button | ||
| className="button-reset bg-transparent bn p0 m0 mr3 flex items-center justify-center pointer charcoal-muted hover-navy transition-all glow" | ||
| onClick={cycleTheme} | ||
| title={t('themeDescription')} | ||
| style={{ width: 28, height: 28, outline: 'none' }} | ||
|
Member
There was a problem hiding this comment. ux nit: Please use the existing |
||
| > | ||
| <Icon width={24} height={24} className="fill-current-color" /> | ||
| </button> | ||
| ) | ||
| } | ||
|
|
||
| export default TopBarThemeToggle | ||
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,58 @@ | ||
| import React, { createContext, useContext, useEffect, useState } from 'react' | ||
|
|
||
| export const ThemeContext = createContext({ | ||
| theme: 'auto', | ||
| setTheme: (/** @type {string} */ _newTheme) => {} | ||
| }) | ||
|
|
||
| export const useTheme = () => useContext(ThemeContext) | ||
|
|
||
| // Default theme is auto | ||
| const DEFAULT_THEME = 'auto' | ||
|
|
||
| /** | ||
| * @param {Object} props | ||
| * @param {import('react').ReactNode} props.children | ||
| */ | ||
| export const ThemeProvider = ({ children }) => { | ||
| const [theme, setThemeState] = useState(() => { | ||
| return localStorage.getItem('ipfs-webui-theme') || DEFAULT_THEME | ||
|
Member
There was a problem hiding this comment. Any string in localStorage becomes Please validate against |
||
| }) | ||
|
|
||
| useEffect(() => { | ||
| const mediaQuery = window.matchMedia | ||
| ? window.matchMedia('(prefers-color-scheme: dark)') | ||
| : { matches: false, addEventListener: () => {}, removeEventListener: () => {} } | ||
|
|
||
| const applyTheme = () => { | ||
|
Member
There was a problem hiding this comment. nit: when the theme is Perhaps expose the resolved light/dark value through the ontext; that fixes both? |
||
| const isDark = theme === 'dark' || (theme === 'auto' && mediaQuery.matches) | ||
| document.documentElement.setAttribute('data-theme', isDark ? 'dark' : 'light') | ||
| } | ||
|
|
||
| applyTheme() | ||
|
Member
There was a problem hiding this comment. The theme is applied only after React mounts, so dark-mode users see a white flash on every load. One way to fix it is a tiny script in public/index.html, ahead of the bundle, can set |
||
|
|
||
| const handleChange = () => { | ||
| if (theme === 'auto') { | ||
| applyTheme() | ||
| } | ||
| } | ||
|
|
||
| mediaQuery.addEventListener('change', handleChange) | ||
| return () => { | ||
| mediaQuery.removeEventListener('change', handleChange) | ||
| } | ||
| }, [theme]) | ||
| /** | ||
| * @param {string} newTheme | ||
| */ | ||
| const setTheme = (newTheme) => { | ||
| localStorage.setItem('ipfs-webui-theme', newTheme) | ||
| setThemeState(newTheme) | ||
| } | ||
|
|
||
| return ( | ||
| <ThemeContext.Provider value={{ theme, setTheme }}> | ||
| {children} | ||
| </ThemeContext.Provider> | ||
| ) | ||
| } | ||
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
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.
iiuc this changes disabled buttons in light mode too, and
bg-black-10is close to invisible on a dark background. Consider keeping the old classes and adding a dark override for.bg-gray-mutedin index.css instead.