swagger-api / swagger-api/swagger-ui

Ensures the contrast between foreground and background colors meets WCAG 2 AA minimum contrast ratio thresholds (.btn-primary)

Open
#9,984 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Q&A (please complete the following information)
  • OS: Windows 11 Enterprise - 23H2
  • Browser: Chrome, Edge
  • Version: Chrome- Version 124.0.6367.93 (Official Build) (64-bit)
    Edge - Version 124.0.2478.80 (Official build) (64-bit)
  • Method of installation: npm
  • Swagger-UI version: 4.6.1
  • Swagger/OpenAPI version: [e.g. Swagger 2.0, OpenAPI 3.0]
Content & configuration

Example Swagger/OpenAPI definition:

# your YAML here

Swagger-UI configuration options:

SwaggerUI({
  // your config options here
})
?yourQueryStringConfig
Describe the bug you're encountering
To reproduce...

Steps to reproduce the behavior:

  1. Launch the URL : https://codesandbox.io/p/sandbox/nervous-fog-d87m3w?file=%2fpackage.json
  2. Observe that Ensures the contrast between foreground and background colors meets WCAG 2 AA minimum contrast ratio thresholds (.btn-primary) or not.
Expected behavior

Ensures the contrast between foreground and background colors meets WCAG 2 AA minimum contrast ratio thresholds (color-contrast)

Screenshots
Color Contrast AI- Swagger
Additional context or thoughts

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 with the linked CodeSandbox reproduction and inspect the styles for the .btn-primary selector, comparing its foreground and background colors against WCAG 2 AA contrast requirements. Done means the control meets the stated minimum contrast ratio in the reproduced Swagger UI behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, javascript
Domain
accessibility, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.