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

Table of contents should scroll with content #9904

Open
2 of 7 tasks
Sainan opened this issue Mar 1, 2024 · 7 comments
Open
2 of 7 tasks

Table of contents should scroll with content #9904

Sainan opened this issue Mar 1, 2024 · 7 comments
Labels
difficulty: advanced Issues that are complex, e.g. large scoping for long-term maintainability. domain: theme Related to the default theme components feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.

Comments

@Sainan
Copy link
Contributor

Sainan commented Mar 1, 2024

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

When there's a big page with tons of sections, the "table of contents" sidebar does not really keep up with the user.

For example, here I have scrolled into the table.reverse section, but in the TOC sidebar, it is hardly visible:

image

If I were to scroll further, the active section would be completely past the viewport on the sidebar.

Reproducible demo

https://pluto-lang.org/docs/Runtime%20Environment/Global%20Reference

Steps to reproduce

Big page.

Expected behavior

The TOC sidebar scrolls with me.

Actual behavior

It does not.

Your environment

Self-service

  • I'd be willing to fix this bug myself.
@Sainan Sainan 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 Mar 1, 2024
@ShubhamPatilsd
Copy link

our students from https://labs.codeday.org will be taking a shot at this issue in the coming week :) (they'll be making their first contributions to break into the world of open source)

@Josh-Cena
Copy link
Collaborator

Please see #6058 and #6587. It is not an easy feature to implement and none of the maintainers are interested in taking over the work of a novice when we ourselves have no good solutions.

@ShubhamPatilsd
Copy link

oh my apologies, thanks for the heads up, do you know any issues on this repo that would be better suited for novices?

@Josh-Cena
Copy link
Collaborator

It would vary a lot by what your "novices" are equipped with and what they are enthusiastic to learn about. Most of the tech and coding style would be new to them. Pick any issue that doesn't seem to involve a lot of internal details and see if they understand what should be changed.

@Josh-Cena Josh-Cena changed the title Table of contents sidebar does not scroll with view Table of contents should scroll with content Mar 3, 2024
@Josh-Cena Josh-Cena added difficulty: advanced Issues that are complex, e.g. large scoping for long-term maintainability. domain: theme Related to the default theme components feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. and removed status: needs triage This issue has not been triaged by maintainers bug An error in the Docusaurus core causing instability or issues with its execution labels Mar 3, 2024
@ShubhamPatilsd
Copy link

I think #9781 would work better, leaving a comment there

@Sainan
Copy link
Contributor Author

Sainan commented Mar 3, 2024

I'm a bit confused, shouldn't this "feature" already be implemented given that #6317 was merged? Is this not a regression?

@OzakIOne
Copy link
Contributor

OzakIOne commented Mar 4, 2024

I'm a bit confused, shouldn't this "feature" already be implemented given that #6317 was merged? Is this not a regression?

It seems there was an issue with the PR that implemented this feature so the change were reverted until the bug is fixed

#6317 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: advanced Issues that are complex, e.g. large scoping for long-term maintainability. domain: theme Related to the default theme components feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.
Projects
None yet
Development

No branches or pull requests

5 participants
@OzakIOne @ShubhamPatilsd @Josh-Cena @Sainan and others