swagger-api / swagger-api/swagger-ui

Swagger UI renders larger as needed for desktop usage -- Compact mode possible?

Open
#4,458 7 comments 13 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

cat: user experience needs: UX/design input type: enhancement
Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

The swagger UI version 3 is rendered larger than swagger UI 2. Means there are lot of spaces and the boxes are larger as needed for desktop usage.
It is may optimized for large fingers or touch pad usage. But as result a user in PC - mouse scenarios has to scroll a lot to get an overview of the APIs.

Is it possible to provide a compact mode or layout per browser type or a out of the box compacted layout & css or to document instructions how to get a more compacted version (may in a style of version 2)?

Q A
Bug or feature request? feature
Which Swagger/OpenAPI version? 2.0
Which Swagger-UI version? 3.13.4
How did you install Swagger-UI? swagger-ui dist
Which browser & version? chrome
Which operating system? Windows

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Swagger UI 3.13.4 distributed assets and comparing their layout and CSS with Swagger UI 2. Determine whether the requested compact presentation should be a browser/layout option or documented customization, then define done as a usable compact desktop layout with clear instructions or validated controls.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.