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

[4.1.2]「HTMLの要素や属性を正しい役割で使用する」のタイトル・内容の見直し #417

Merged
merged 11 commits into from
Oct 12, 2023

Conversation

tokimari
Copy link
Contributor

@tokimari tokimari commented Oct 6, 2023

概要

fix: #263
ちょっとガイドライン内容が大きく変わるので、途中経過を見てもらいたくDraftでPR作成します:pray: Draft外しました:pray:

相談したいところ

プレビューを見ながらご確認ください:eyes:

  • タイトルがよりエンジニア向けになりましたが、そもそも4.1.2はエンジニア向けの項目で良いかなと思っていて、齟齬がない方を優先しました・・:pray:とはいえ初見殺しは避けたいので、率直な感想もいただけると・・:bow:
  • 原文では「名前(name)」とあるところを「Accessible Name」としていること
  • spindle-uiにあるやつが例としてもデモページを貼れるので都合が良いかなと思うんですが、少々マニアックなコンポーネントなのが気になり・・Tabとかのが良さそうでしょうか(spindle-uiにはないからサンプル実装しないとですが)
  • 実装例何が良さそうでしょうか 🤔 SegmentedControlで良い??
    • SegmentedControlで行くなら、role="radiogrouo", role="radio", aria-checked などが付与されていなくて支援技術にとって機能が伝わらないケースを書くのがよいでしょうか??
    • 現時点ではSegmentedControlの具体例を掲載して公開し、後ほど追加Componentの実装例を追加する

レビューで確認して欲しいところ

  • WCAG2.1のUnderstandingを参照しながら、修正したガイドラインの内容に間違い・語弊がないかを確認
  • こういう点も書いた方がいいのでは?とか
  • Understandingの達成方法を確認しながら、テスト・チェック方法の妥当性

関連リンク

確認項目

Pull Requestを出す前に確認しましょう。

  • コミットは適切にまとめられているか
  • Pull Requestの概要を適切に書いたか
  • レビュワーの指定をしているか
  • textlintを実行しエラーが出ていないか
  • Accessibility

その他

@reg-suit
Copy link

reg-suit bot commented Oct 6, 2023

reg-suit detected visual differences.

Check this report, and review them.

🔴🔴

🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵🔵

What do the circles mean? The number of circles represent the number of changed images.
🔴 : Changed items, ⚪ : New items, ⚫ : Deleted items, and 🔵 Passed items

How can I change the check status? If reviewers approve this PR, the reg context status will be green automatically.

@github-actions
Copy link

github-actions bot commented Oct 6, 2023

Visit the preview URL for this PR (updated for commit 5a86773):

https://ameba-a11y-guidelines--pr417-fix-4-1-2-9sy4dwcp.web.app

(expires Wed, 18 Oct 2023 07:13:37 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: b5ed0ee52825c395d695adc443890c0775e604f1

Base automatically changed from fix/lint-staged to master October 6, 2023 01:33
src/4/1/2.md Outdated

Accessible Nameとは、ユーザーインターフェイスの名前である。機械的に識別可能な名前であり、表示されるラベルテキストと一致することが多いが、代替テキストのように支援技術向けにのみ実装されていることもある。WCAGではnameと記載されているが、HTMLのname属性とは関係がなく、誤解を生みやすいため、[Accessible Name and Description Computation 1.1](https://www.w3.org/TR/accname-1.1/)で定義されている用語の名称で表記している。

参考:
Copy link
Contributor Author

@tokimari tokimari Oct 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lintで「warning  文末が"。"で終わっていません。  @openameba/ameba/ja-no-mixed-period」というwarningが出ている様子

31:3 warning 文末が"。"で終わっていません。 @openameba/ameba/ja-no-mixed-period
40:3 warning 文末が"。"で終わっていません。 @openameba/ameba/ja-no-mixed-period

textlintのtextlint-rule-ja-no-mixed-periodルールでwarningでちゃう・・
設定ファイル.textlintrcを以下のように編集することで、「参考:」で始まる行を許容できるっぽいんですが、ウーン・・

{
  "rules": {
    "ja-no-mixed-period": {
      "periodMark": "",
      "exceptions": ["参考:"]
    }
  }
}

表記を変えれば良いけどいい案がパッと浮かばないなう

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

例えばですけど。

参考:

「詳細は以下の参考資料で確認できる。」みたいな文章的な言い回しにするか、
「### 参考資料」みたいな感じで見出しにしちゃうとかだとどうですかね?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

h3見出しにしました:pray:
実装後のプレビューのスクリーンショット。「参考資料」が見出しのように表示されている

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

スクリーンショット 2023-10-10 17 34 09

そういえばですが英字?だと左側の文字かけてそうな気がw

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

あーそれ気になってたんですよねw
summary要素に適用されたスタイルのスクリーンショット。`text-indent: -1em;`が付与されている

summary要素にtext-indentプロパティが設定されてて、これかなーと思うので別で修正しますね:pray:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#420 にて:pray:

@tokimari
Copy link
Contributor Author

tokimari commented Oct 6, 2023

@openameba/spindle-working-group 途中ですが相談したいところのあたりご意見もらいたく〜〜:pray:

@yasuda-shin
Copy link
Contributor

yasuda-shin commented Oct 10, 2023

実装例何が良さそうでしょうかSegmentedControlで良い

現状、該当するコンポーネントはSegmentedControlな気がしつつ直近でコンポーネントの開発が進むという噂もあります。

src/4/1/2.md Outdated Show resolved Hide resolved
src/4/1/2.md Outdated
{% label "good" %}
見出しタグを正しく使用している場合。支援技術で、見出しを一覧化して表示する機能を使っても、全ての見出しを表示できるため、必要な情報を選んで読みやすい。
{% endlabel %}
SegmentedControlコンポーネントのボタンの一つにキーボードでフォーカスしている様子。3つあるボタンの内、選択されていのは中央で、フォーカスが当たっているのは一番左のボタンである。SegmentedControlでは、フォーカスが当たっているが選択されていない(Activeではない)状態がある。
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
SegmentedControlコンポーネントのボタンの一つにキーボードでフォーカスしている様子。3つあるボタンの内、選択されていのは中央で、フォーカスが当たっているのは一番左のボタンである。SegmentedControlでは、フォーカスが当たっているが選択されていない(Activeではない)状態がある。
SegmentedControlコンポーネントのボタンの一つにキーボードでフォーカスしている様子。3つあるボタンの内、選択されているのは中央で、フォーカスが当たっているのは一番左のボタンである。SegmentedControlでは、フォーカスが当たっているが選択されていない(Activeではない)状態がある。

細かいところで🙏

Copy link
Contributor Author

@tokimari tokimari Oct 11, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:sugutypo:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

863594f にて 😄

@tokimari tokimari marked this pull request as ready for review October 11, 2023 05:58
Copy link
Contributor

@itsminadesu itsminadesu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

私からは良さそうに思いました 🙌🏻

@yasuda-shin
Copy link
Contributor

概ね良さそうだなーと思いつつこのPull requestマージしたらissue closeすると思うのですが。
コンポーネントの実装例は別でタスク化?issue化とかしておきます??

Copy link
Contributor

@tatz012 tatz012 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

自分からもよさそうです🙆‍♀️ (タスク化はたしかに)

@tokimari
Copy link
Contributor Author

#417 (comment)

そうですね!issueを作成&のちさんアサインしておきましたw
#421

@tokimari tokimari merged commit b4e1afb into master Oct 12, 2023
5 checks passed
@tokimari tokimari deleted the fix/4.1.2 branch October 12, 2023 01:27
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.

[4.1.2]「HTMLの要素や属性を正しい役割で使用する」のタイトル・内容の再考
4 participants