Accessibility: docs code examples/link styling is very confusing and has insufficient contrast
還沒有人認領這個 Issue。
- 主要語言
- JavaScript
- 星號
- 11.8k
- 分支
- 7.9k
- 平均合併
- 1 天 11 小時
- 30 天內合併 PR
- 11
描述
In the documentation, the styling is really confusing.
Here's an example, taken from the docs for createContext in dark mode, although the issue is present in light mode as well:
Here you can see:
- a text link ("pass information deep down") which is blue and not underlined and has no background color
- variables in source code, which are a similar shade of blue on a darker blue background, with a bottom box border, and aren't clickable
- string values in source code, same as above but purple on purple
- a concept in text ("context object"), variable width text, same colorations as source variables, not clickable
- another concept ("default values") same as above but purple
- a text link which is a function name (
useContext()), blue monospaced text on a gray background
This assortment of similar-but-different color combinations is making it hard for me to read. Everything with a box bottom border looks like a link and I keep trying to click them out of habit that they're a crossreference. The use of blue and purple for "context object" and "default values" also add to the problem because they look like unvisited/visited links. At the very least, could you please consider changing either your source code highlights or your link color to be something drastically other than blue?
Running an accessibility checker on the pages also shows that many of the styles fail WCAG accessibility standards for text contrast.
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
先在淺色和深色模式下檢視 createContext 文件頁面,然後針對回報的樣式執行無障礙檢查器。當連結、程式碼值和概念在視覺上可區分,且回報的文字對比度問題符合 WCAG 要求時,即表示完成。
由索引模型根據 Issue 內容生成。
評估
- 領域
- accessibility, design, documentation
- Issue 類型
- 缺陷
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100