Skip to content

Docs: Fix table of contents scroll behavior#23986

Merged
ndelangen merged 4 commits into
storybookjs:nextfrom
almoghaimo:fix/toc-is-not-scrollable
Sep 1, 2023
Merged

Docs: Fix table of contents scroll behavior#23986
ndelangen merged 4 commits into
storybookjs:nextfrom
almoghaimo:fix/toc-is-not-scrollable

Conversation

@almoghaimo
Copy link
Copy Markdown
Contributor

Closes #23542

What I did

The table of contents did not scroll when it exceeded its container.
I added CSS properties to stretch the fixed element vertically across the viewport and allow it to become scrollable when content overflows.

Solution result:

259775796-edbbb99f-369a-48aa-891d-a5f6445f1458.mov

Checklist for Contributors

Testing

  1. Enable TOC
  2. Open component docs (ideally with many stories)
  3. Make the viewport smaller so that TOC overflows

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@almoghaimo
Copy link
Copy Markdown
Contributor Author

almoghaimo commented Aug 29, 2023

Hey @ndelangen,

Just giving you a heads-up about this PR as we talked about

@almoghaimo almoghaimo changed the title CSS changes is fixing the toc is not scrollable with large content Fix: The table of contents did not scroll when it exceeded its container. #23542 Aug 29, 2023
@almoghaimo almoghaimo changed the title Fix: The table of contents did not scroll when it exceeded its container. #23542 Fix: The table of contents did not scroll when it exceeded its container. Aug 29, 2023
@ndelangen ndelangen changed the title Fix: The table of contents did not scroll when it exceeded its container. Docs: Fix table of contents scroll behavior Aug 29, 2023
@ndelangen ndelangen self-assigned this Aug 29, 2023
@ndelangen ndelangen added bug ci:normal Run our default set of CI jobs (choose this for most PRs). ci:docs Run the CI jobs for documentation checks only. addon: docs and removed ci:docs Run the CI jobs for documentation checks only. labels Aug 29, 2023
@ndelangen ndelangen merged commit f28edfd into storybookjs:next Sep 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

addon: docs bug ci:normal Run our default set of CI jobs (choose this for most PRs).

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: 7.1 Table of contents is not scrollable

2 participants