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(color-modes): Default useColorModeMediaQuery to true #1373

Merged
merged 3 commits into from
Dec 21, 2020
Merged

feat(color-modes): Default useColorModeMediaQuery to true #1373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82cecae
feat(color-modes): Default useColorModeMediaQuery to true
lachlanjc Dec 16, 2020
50f5a58
chore(changelog): Update changelog
lachlanjc Dec 16, 2020
9bf05e4
Merge branch 'develop' into default-color-scheme-true
lachlanjc Dec 16, 2020
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## v0.6.0 UNRELEASED

- **BREAKING**: Default `useColorModeMediaQuery` to `true`. Issue #624, PR #1373
- Extract objects with nested variant props. Issue #1357
- Add ability for MDX styling, and fix mdx table align styles. Issue #654
- Remove recursive default values from CSS custom properties. PR #1327
Expand Down
6 changes: 3 additions & 3 deletions packages/color-modes/src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ const useColorModeState = (theme: Theme = {}) => {
React.useEffect(() => {
const stored = theme.useLocalStorage !== false && storage.get()
document.body.classList.remove('theme-ui-' + stored)
if (!stored && theme.useColorSchemeMediaQuery) {
if (!stored && theme.useColorSchemeMediaQuery !== false) {
const query = getMediaQuery()
setMode(query)
return
Expand Down Expand Up @@ -119,10 +119,10 @@ const applyColorMode = (theme: Theme, mode: string): Theme => {
})
}

const BodyStyles = ({ theme }: { theme: Theme}) =>
const BodyStyles = ({ theme }: { theme: Theme }) =>
jsx(Global, {
styles: () => {
return createColorStyles(theme);
return createColorStyles(theme)
},
})

Expand Down
11 changes: 6 additions & 5 deletions packages/docs/src/pages/color-modes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,7 @@ npm i gatsby-plugin-theme-ui

This plugin will look for a `src/gatsby-plugin-theme-ui/index.js` file to import and pass to the ThemeProvider.

```js
// gatsby-config.js
```js filename=gatsby-config.js
module.exports = {
plugins: ['gatsby-plugin-theme-ui'],
}
Expand Down Expand Up @@ -120,16 +119,18 @@ This will cause the colors to flash on initial page load.
}
```

### Initialize mode with `prefers-color-scheme` media query
### Responding to the `prefers-color-scheme` media query

To initialize a color mode based on the `prefers-color-scheme` media query, add the `useColorSchemeMediaQuery` flag to your theme.
The `useColorSchemeMediaQuery` configuration option on the theme
initializes a color mode based on the `prefers-color-scheme` media query.
This will set the initial color mode to `dark` when `@media (prefers-color-scheme: dark)` matches,
or `light` when `@media (prefers-color-scheme: light)` matches.
If you do not have a color mode named `dark` or `light`, this will have no effect.
This is enabled by default.

```js
{
useColorSchemeMediaQuery: true,
useColorSchemeMediaQuery: false,
colors: {
text: '#000',
background: '#fff',
Expand Down