Installation instructions: How do I install a Theme or Theme Component?
What this does?
This component allows automatic switching to a dark theme when the browser is set to dark mode.
At the time of writing this only works in Safari on macOS (Firefox is also expected to support this soon). This works on logged-in users only on all browsers that support the prefers-color-scheme media query.
By default, this component is enabled and individual users can turn it off in their Preferences > Interface screen. As of January 2020, admins can also set the component to be default off, in which case users will see a button to enable automatic switching in their interface preferences
How it works?
If the browser is in dark mode, this component will reload Discourse with the dark theme enabled. If the browser returns to light mode, this component will reload with the default enabled theme.
It will also reload if dark mode is toggled while user is on the site (as shown in video above).
(If you have more than two themes enabled, and the user has selected a theme other than default or dark, this component will do nothing, i.e. it will respect the user’s choice.)
- Make sure you have a dark theme installed, and that it is selectable by users
- Add this component to both the default theme and the dark theme (very important, if you don’t add it to both themes, users won’t be able to switch back to the default theme)
- In the component settings, enter the id of your dark theme in
dark theme id