Skip to content

fix(theme): collapse doc sidebar category on label click if active #10886

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

Merged
slorber merged 3 commits into from
Feb 7, 2025
Merged

fix(theme): collapse doc sidebar category on label click if active #10886

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
00633c2
change doc sidebar category collapsible on label click behavior
slorber Jan 31, 2025
99bfb97
remove useless CollapsedStyles getSSRStyle thing
slorber Jan 31, 2025
975bb10
Update packages/docusaurus-theme-common/src/components/Collapsible/in…
slorber Feb 4, 2025
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
9 changes: 8 additions & 1 deletion packages/docusaurus-theme-classic/src/theme/DocSidebarItem/Category/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,14 @@ export default function DocSidebarItemCategory({
? (e) => {
onItemClick?.(item);
if (href) {
updateCollapsed(false);
if (isActive) {
e.preventDefault();
updateCollapsed();
} else {
// When navigating to a new category, we always expand
// see https://github.com/facebook/docusaurus/issues/10854#issuecomment-2609616182
updateCollapsed(false);
}
Comment on lines +191 to +198
Copy link

@aaryanporwal aaryanporwal Feb 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Thanks for the quick fix :)

} else {
e.preventDefault();
updateCollapsed();
Expand Down
31 changes: 1 addition & 30 deletions packages/docusaurus-theme-common/src/components/Collapsible/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ import React, {
type SetStateAction,
type ReactNode,
} from 'react';
import useIsBrowser from '@docusaurus/useIsBrowser';
import useIsomorphicLayoutEffect from '@docusaurus/useIsomorphicLayoutEffect';
import {prefersReducedMotion} from '../../utils/accessibilityUtils';

Expand Down Expand Up @@ -119,7 +118,7 @@ function useCollapseAnimation({

// On mount, we just apply styles, no animated transition
if (!mounted.current) {
applyCollapsedStyle(el, collapsed);
queueMicrotask(() => applyCollapsedStyle(el, collapsed));
mounted.current = true;
return undefined;
}
Expand Down Expand Up @@ -157,24 +156,6 @@ type CollapsibleElementType = React.ElementType<
Pick<React.HTMLAttributes<unknown>, 'className' | 'onTransitionEnd' | 'style'>
>;

/**
* Prevent hydration layout shift before animations are handled imperatively
* with JS
*/
function getSSRStyle({
collapsed,
isBrowser,
}: {
collapsed: boolean;
isBrowser: boolean;
}) {
// After hydration, styles are applied
if (isBrowser) {
return undefined;
}
return collapsed ? CollapsedStyles : ExpandedStyles;
}

type CollapsibleBaseProps = {
/** The actual DOM element to be used in the markup. */
as?: CollapsibleElementType;
Expand All @@ -192,12 +173,6 @@ type CollapsibleBaseProps = {
onCollapseTransitionEnd?: (collapsed: boolean) => void;
/** Class name for the underlying DOM element. */
className?: string;
/**
* This is mostly useful for details/summary component where ssrStyle is not
* needed (as details are hidden natively) and can mess up with the browser's
* native behavior when JS fails to load or is disabled
*/
disableSSRStyle?: boolean;
};

function CollapsibleBase({
Expand All @@ -207,9 +182,7 @@ function CollapsibleBase({
animation,
onCollapseTransitionEnd,
className,
disableSSRStyle,
}: CollapsibleBaseProps) {
const isBrowser = useIsBrowser();
const collapsibleRef = useRef<HTMLElement>(null);

useCollapseAnimation({collapsibleRef, collapsed, animation});
Expand All @@ -219,8 +192,6 @@ function CollapsibleBase({
// @ts-expect-error: the "too complicated type" is produced from
// "CollapsibleElementType" being a huge union
ref={collapsibleRef as RefObject<never>} // Refs are contravariant, which is not expressible in TS
// Not even sure we need this SSRStyle anymore, try to remove it?
style={disableSSRStyle ? undefined : getSSRStyle({collapsed, isBrowser})}
onTransitionEnd={(e: React.TransitionEvent) => {
if (e.propertyName !== 'height') {
return;
Expand Down
1 change: 0 additions & 1 deletion packages/docusaurus-theme-common/src/components/Details/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,6 @@ export function Details({
<Collapsible
lazy={false} // Content might matter for SEO in this case
collapsed={collapsed}
disableSSRStyle // Allows component to work fine even with JS disabled!
onCollapseTransitionEnd={(newCollapsed) => {
setCollapsed(newCollapsed);
setOpen(!newCollapsed);
Expand Down