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.

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

Make sidebar collapsible on clicking label not just arrows #10854

Open
7 tasks done
aaryanporwal opened this issue Jan 21, 2025 · 2 comments
Open
7 tasks done

Make sidebar collapsible on clicking label not just arrows #10854

aaryanporwal opened this issue Jan 21, 2025 · 2 comments
Labels
bug An error in the Docusaurus core causing instability or issues with its execution

Comments

@aaryanporwal
Copy link

aaryanporwal commented Jan 21, 2025

Have you read the Contributing Guidelines on issues?

Prerequisites

  • I'm using the latest version of Docusaurus.
  • I have tried the npm run clear or yarn clear command.
  • I have tried rm -rf node_modules yarn.lock package-lock.json and re-installing packages.
  • I have tried creating a repro with https://new.docusaurus.io.
  • I have read the console error message carefully (if applicable).

Description

In the sidebar, is there any way to make the accordions collapsible on clicking label? It's possible to expand the accordion on first click, but on clicking an expanded accordion should collapse it. Currently, the user has to click on the accordion arrow to collapse it.

In the following video, I've attached the docusaurus docs page where the bug can be seen. I'm not sure if this is an intended thing, but seems odd UX-wise.

Screen.Recording.2025-01-21.at.2.22.15.PM.mov

Reproducible demo

No response

Steps to reproduce

1.	Open the Docusaurus docs page in a browser.
2.	Navigate to the sidebar containing accordions.
3.	Click on the label of an accordion to expand it.
4.	Click on the same accordion label again to attempt to collapse it.

Expected behavior

Clicking on an expanded accordion’s label should collapse it, providing a toggle behavior directly through the label.

Actual behavior

Clicking on the label of an expanded accordion does not collapse it. The user must click on the accordion arrow to collapse it, which results in inconsistent user experience.

Your environment

Self-service

  • I'd be willing to fix this bug myself.
@aaryanporwal aaryanporwal added bug An error in the Docusaurus core causing instability or issues with its execution status: needs triage This issue has not been triaged by maintainers labels Jan 21, 2025
@slorber slorber removed the status: needs triage This issue has not been triaged by maintainers label Jan 22, 2025
@slorber
Copy link
Collaborator

slorber commented Jan 22, 2025

This is a design decision we made in the past, but I agree that it could be convenient to collapse on label click, and many other docs frameworks have implemented it that way.

If the community thinks it's a better default behavior, I'm happy to revisit our past design decision.

Please vote here with 👍 or 👎

@MaxLenormand
Copy link

I understand this might be a design on which different people have different opinions. Would it be possible to make this a toggle / option?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug An error in the Docusaurus core causing instability or issues with its execution
Projects
None yet
Development

No branches or pull requests

3 participants