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

Compensate Operation content in lower resolution sizes #8940

Open
char0n opened this issue Jun 19, 2023 · 9 comments · Fixed by #9325 · May be fixed by #9963, #9982 or #9992
Open

Compensate Operation content in lower resolution sizes #8940

char0n opened this issue Jun 19, 2023 · 9 comments · Fixed by #9325 · May be fixed by #9963, #9982 or #9992

Comments

@char0n
Copy link
Member

char0n commented Jun 19, 2023

This can be reproduced both in SwaggerEditor (v4) and Swagger Editor (v5). The preview that is located in the right-hand side (where SwaggerUI displays) is fully collapsible without any limits. The components tries to compensate, but after some threshold they will stop making visual sense.

This is not really specific to SwaggerUI. If we take for example React Material Design components, these reference components will too collapse until they stop making sense.

What we can do is to use Material Design Specification and say that our minimal supported break-point is 360dp/px. We will make CSS changes and make sure that Operations and other visual components renders properly on that break-point. Second remediation can be setting the minimum width of the preview pane in the editors (but not sure this is warranted).

Under threshold of 360dp/px what is displayed is no longer guaranteed.

Work on this can be done progressively, layering changes on top of previous changes:

  • Amend CSS of expand level 0
  • Amend CSS of expand level 1
    ….. repeat to level n ….

Currently SwaggerUI has some notion of minimal supported break-point and some components tries to compensate.

image

@shoaib-31
Copy link

@char0n Hi, please assign this issue to me, I am able to fix this. I am attaching a screenshot of it.
Screenshot from 2023-10-01 04-12-46

@shoaib-31
Copy link

@char0n Please review this PR.

@pedoch
Copy link
Contributor

pedoch commented Oct 20, 2023

@char0n I raised a PR that addresses this issue (#9325). Please take a look whenever you can.

@char0n char0n self-assigned this Nov 10, 2023
char0n pushed a commit that referenced this issue Nov 10, 2023
Along with the operations, Topbar and Authorization button
has been made more responsive as well.

Refs #8940
@char0n char0n reopened this Nov 10, 2023
@char0n
Copy link
Member Author

char0n commented Nov 10, 2023

I'm keeping this issue open as we've basically addressed Amend CSS of expand level 0 - what I mean by this is that collapsed operation has been addressed. Next task is Amend CSS of expand level 1 - address content of expanded Operation.

@char0n
Copy link
Member Author

char0n commented Dec 13, 2023

@pedoch we have another regressions reported:

image
image

I'll try to address this during tomorrow, any help is appreciated.

NOTE: CSS breaks only with combination of latest SwaggEditor: https://github.com/swagger-api/swagger-editor/releases/tag/v5.0.0-alpha.84. Alone it works just fine.


Update (14.12.2023): I've issued #9425.

@pedoch
Copy link
Contributor

pedoch commented Dec 14, 2023

@char0n I see you've pushed a fix for it. Thank you! I tried recreating the bug but I couldn't.

@cxx5208
Copy link

cxx5208 commented Feb 15, 2024

Hey Can you assign this to me? I will try to fix the issue
Thank you

@char0n
Copy link
Member Author

char0n commented Feb 15, 2024

Hi @cxx5208,

No need to assign explicitly. If you with to work on this, just create PRs that reference this issue. Ideally very small PRs, where each PR addresses just one small aspect.

@klm-turing
Copy link

Hi @char0n I got 3 PR for this issue. Let me know if you need anything else. Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment