Skip to content

feat(theme-common): Get desktopThresholdWidth from docusaurus config #9261

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

Closed
jgarrow wants to merge 6 commits into from
Closed

feat(theme-common): Get desktopThresholdWidth from docusaurus config #9261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
9f90240
feat(theme-common): Get desktopThresholdWidth from docusaurus config,…
jgarrow Aug 25, 2023
c629834
Update example to dogfood custom desktopThresholdWidth
jgarrow Aug 25, 2023
d3feed9
Revert "Update example to dogfood custom desktopThresholdWidth"
jgarrow Aug 25, 2023
7bb3c9c
dogfooding: Add custom desktop breakpoint to theme config
jgarrow Aug 25, 2023
6535c04
Handle falsey value
jgarrow Aug 25, 2023
480684c
Update ThemeConfig type
jgarrow Aug 25, 2023
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
14 changes: 8 additions & 6 deletions packages/docusaurus-theme-common/src/hooks/useWindowSize.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import {useEffect, useState} from 'react';

import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';

const windowSizes = {
desktop: 'desktop',
Expand All @@ -17,13 +18,12 @@ const windowSizes = {

type WindowSize = keyof typeof windowSizes;

const DesktopThresholdWidth = 996;

function getWindowSize() {
function getWindowSize(desktopThresholdWidth = 996): WindowSize {
if (!ExecutionEnvironment.canUseDOM) {
return windowSizes.ssr;
}
return window.innerWidth > DesktopThresholdWidth

return window.innerWidth > desktopThresholdWidth
? windowSizes.desktop
: windowSizes.mobile;
}
Expand All @@ -44,16 +44,18 @@ const DevSimulateSSR = process.env.NODE_ENV === 'development' && true;
* catch potential layout shifts, similar to strict mode calling effects twice.
*/
export function useWindowSize(): WindowSize {
const {siteConfig} = useDocusaurusContext();
const desktopThresholdWidth = siteConfig?.themeConfig?.breakpoints?.desktop ?? 996;
const [windowSize, setWindowSize] = useState<WindowSize>(() => {
if (DevSimulateSSR) {
return 'ssr';
}
return getWindowSize();
return getWindowSize(desktopThresholdWidth);
});

useEffect(() => {
function updateWindowSize() {
setWindowSize(getWindowSize());
setWindowSize(getWindowSize(desktopThresholdWidth));
}

const timeout = DevSimulateSSR
Expand Down
4 changes: 4 additions & 0 deletions packages/docusaurus-types/src/config.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ export type ReportingSeverity = 'ignore' | 'log' | 'warn' | 'throw';

export type ThemeConfig = {
[key: string]: unknown;
breakpoints?: {
desktop?: number;
[key: string]: unknown;
}
};

export type MarkdownPreprocessor = (args: {
Expand Down
8 changes: 8 additions & 0 deletions website/_dogfooding/dogfooding.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@
* LICENSE file in the root directory of this source tree.
*/

/** @type {import('@docusaurus/types').ThemeConfig} */
const dogFoodingThemeConfig = {
breakpoints: {
desktop: 744,
}
}
exports.dogFoodingThemeConfig = dogFoodingThemeConfig;

/** @type {import('@docusaurus/types').PluginConfig[]} */
const dogfoodingThemeInstances = [
/** @type {import('@docusaurus/types').PluginModule} */
Expand Down
2 changes: 2 additions & 0 deletions website/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ const versions = require('./versions.json');
const VersionsArchived = require('./versionsArchived.json');
const {
dogfoodingPluginInstances,
dogFoodingThemeConfig,
dogfoodingThemeInstances,
dogfoodingRedirects,
} = require('./_dogfooding/dogfooding.config');
Expand Down Expand Up @@ -450,6 +451,7 @@ module.exports = async function createConfigAsync() {
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
...dogFoodingThemeConfig,
liveCodeBlock: {
playgroundPosition: 'bottom',
},
Expand Down