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

fix(style): do not shrink operationId if there is sufficient space #10259

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

Conversation

n0spaces
Copy link

Description

One-line change. Update the style of opblock-summary-path-description-wrapper, replacing width: 100% with flex-grow: 1.

Motivation and Context

When the operationId is visible (displayOperationId is set to true), it wraps to a second line even if there is extra space available. This is because opblock-summary-path-description-wrapper has its width set to 100%, which means it tries to take up the entire flex container, causing itself and opblock-summary-operation-id to shrink. Using flex-grow: 1 will allow the path/description wrapper to take up the remaining space without shrinking anything.

Fixes #9577

How Has This Been Tested?

Tested by resizing the viewport to small sizes.

Screenshots (if appropriate):

Before (width: 100%):

image

After (flex-grow: 1):

image

If the description wraps, the operationId will also wrap, even though there appears to be enough space. This is still an improvement over the prior behavior of always wrapping.

image

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

Note on the last checkbox: The test should display link to external docs without description from features/external-docs.cy.js is failing for me, but that was failing before this change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Operation ids in swagger-ui dashboard are wrapping even if sufficient space is available.
1 participant