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(v2): dark mode toggle customization #3127

Merged
merged 19 commits into from
Jul 31, 2020
Merged

feat(v2): dark mode toggle customization #3127

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
a1dab35
Add dark/light style fields to config
Drewbi Jul 27, 2020
c3d4008
Update yarn.lock
Drewbi Jul 27, 2020
241d71b
Remove css content
Drewbi Jul 27, 2020
470c490
Add documentation
Drewbi Jul 27, 2020
ac125e7
Add icon fields to toggle component
Drewbi Jul 27, 2020
a150f01
Add config validation fields
Drewbi Jul 27, 2020
c753320
Remove changes from docusaurus.config
Drewbi Jul 27, 2020
4846ae1
Add unicode documentation example
Drewbi Jul 27, 2020
fb9150c
Fix default values
Drewbi Jul 28, 2020
4de718d
Merge branch 'master' of github.com:facebook/docusaurus into drewbi/d…
Drewbi Jul 28, 2020
94a91c3
Add color mode config default
Drewbi Jul 29, 2020
a453753
Add lodash to theme-classic
Drewbi Jul 30, 2020
44c4d67
Change themeConfigSchema name to match other packages
Drewbi Jul 30, 2020
d876a85
Add themeConfig color-mode tests
Drewbi Jul 30, 2020
95214df
Add default config merge function
Drewbi Jul 30, 2020
d7c8a84
Merge branch 'master' of github.com:facebook/docusaurus into drewbi/d…
Drewbi Jul 30, 2020
51a129e
Remove unneeded object merging
Drewbi Jul 30, 2020
d804f8a
Add more documentation
Drewbi Jul 30, 2020
503c613
Merge branch 'master' of github.com:facebook/docusaurus into drewbi/d…
Drewbi Jul 30, 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
26 changes: 21 additions & 5 deletions packages/docusaurus-theme-classic/src/theme/Toggle/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,33 @@ import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import clsx from 'clsx';
import styles from './styles.module.css';

const Moon = () => <span className={clsx(styles.toggle, styles.moon)} />;
const Sun = () => <span className={clsx(styles.toggle, styles.sun)} />;
const Dark = ({icon, style}) => (
<span className={clsx(styles.toggle, styles.dark)} style={style}>
{icon}
</span>
);
const Light = ({icon, style}) => (
<span className={clsx(styles.toggle, styles.light)} style={style}>
{icon}
</span>
);

export default function (props: ComponentProps<typeof Toggle>): JSX.Element {
const {isClient} = useDocusaurusContext();
const {isClient, siteConfig = {}} = useDocusaurusContext();

const {
themeConfig: {
colorMode: {
switchConfig: {darkIcon, darkIconStyle, lightIcon, lightIconStyle},
},
},
} = siteConfig;
return (
<Toggle
disabled={!isClient}
icons={{
checked: <Moon />,
unchecked: <Sun />,
checked: <Dark icon={darkIcon} style={darkIconStyle} />,
unchecked: <Light icon={lightIcon} style={lightIconStyle} />,
}}
{...props}
/>
Expand Down
6 changes: 0 additions & 6 deletions packages/docusaurus-theme-classic/src/theme/Toggle/styles.module.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,6 @@
.toggle::before {
position: absolute;
}
.moon::before {
content: '\1F31C';
}
.sun::before {
content: '\1F31E';
}

/**
* styles for React Toggle
Expand Down
9 changes: 9 additions & 0 deletions packages/docusaurus-theme-classic/src/themeConfigSchema.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,15 @@ const ColorModeSchema = Joi.object({
defaultMode: Joi.string().equal('dark', 'light').default('light'),
disableSwitch: Joi.bool().default(false),
respectPrefersColorScheme: Joi.bool().default(false),
switchConfig: Joi.object({
darkIcon: Joi.string().default('🌜'),
darkIconStyle: Joi.object(),
lightIcon: Joi.string().default('🌞'),
lightIconStyle: Joi.object(),
}).default({
darkIcon: '🌜',
lightIcon: '🌞',
}),
}).default({
defaultMode: 'light',
disableSwitch: false,
Drewbi marked this conversation as resolved.
Show resolved Hide resolved
Expand Down
15 changes: 15 additions & 0 deletions website/docs/docusaurus.config.js.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,21 @@ Example:
```js title="docusaurus.config.js"
module.exports = {
themeConfig: {
colorMode: {
defaultMode: 'light',
disableSwitch: false,
respectPrefersColorScheme: true,
switchConfig: {
darkIcon: '🌙',
darkIconStyle: {
marginLeft: '2px',
},
lightIcon: '\u2600',
lightIconStyle: {
marginLeft: '1px',
},
},
},
navbar: {
title: 'Site Title',
logo: {
Expand Down
4 changes: 2 additions & 2 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17578,7 +17578,7 @@ react-dev-utils@^9.1.0:
strip-ansi "5.2.0"
text-table "0.2.0"

react-dom@^16.10.2, react-dom@^16.8.4:
react-dom@^16.8.4:
version "16.13.1"
resolved "https://registry.yarnpkg.com/react-dom/-/react-dom-16.13.1.tgz#c1bd37331a0486c078ee54c4740720993b2e0e7f"
integrity sha512-81PIMmVLnCNLO/fFOQxdQkvEq/+Hfpv24XNJfpyZhTRfO0QcmQIF/PgCa1zCOj2w1hrn12MFLyaJ/G0+Mxtfag==
Expand Down Expand Up @@ -17739,7 +17739,7 @@ react-waypoint@^9.0.2:
prop-types "^15.0.0"
react-is "^16.6.3"

react@^16.10.2, react@^16.8.4:
react@^16.8.4:
version "16.13.1"
resolved "https://registry.yarnpkg.com/react/-/react-16.13.1.tgz#2e818822f1a9743122c063d6410d85c1e3afe48e"
integrity sha512-YMZQQq32xHLX0bz5Mnibv1/LHb3Sqzngu7xstSM+vrkE5Kzr9xE0yMByK5kMoTK30YVJE61WfbxIFFvfeDKT1w==
Expand Down