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

Addon-docs: Fix docs-content overflow with TOC #27167

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

njsokol
Copy link

@njsokol njsokol commented May 16, 2024

What I did

The PR resolves CSS issue when the docs-content (a flex item) contains children which are larger than the container and overspill into the available width, specifically when using the "Table of Contents" component.

image

This change sets the min-width: 0 for this flex item which handles the use case properly.

image

This came about because I'm working on a project which was using a code block describing a long configuration string including a url which caused the page to show this overflow issue.

Checklist for Contributors

Testing

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

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

Manual testing

To illustrate, view any docs page in a browser viewport which is below or at the 1000px width limit and where a <pre> tag is a child of the sb-content and has a larger width (horizontal scroll)

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>

@njsokol njsokol changed the title fix: content with overflow prevented proper reflow inside flex item fix: docs-content with overflow prevented proper reflow inside flex item May 16, 2024
@shilman shilman changed the title fix: docs-content with overflow prevented proper reflow inside flex item Addon-docs: Fix docs-content overflow with TOC May 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants