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

docs(spindle-ui): 通知系コンポーネントの使い分けについて詳細追加 #926

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

tokimari
Copy link
Contributor

@tokimari tokimari commented Feb 9, 2024

2.2.1 コンテンツに制限時間を設けない の観点から、長い間アクセシビリティ上の懸念が払拭できなかったSnackBar, Toastについて、WAIから公式見解が示されたため、AmebaとしてもSnackBarとToastの 適切な 利用法について言及したいと思います。

詳細

主にモバイルアプリケーションで一般的になったSnackBarやToastコンポーネントは、制限時間が来ると自動で消えてしまうので、2.2.1の達成基準で問題になるのでは?と考えられていました。しかし、時間制限のない代替手段がある場合は、必ずしも時間調整できる必要はないとのことです。

Content that operates on a timer does not need to be time adjustable if there is an alternative that does not rely on a timer. For example, a web application such as an email client provides notification of new email arriving with a temporary message (such as a 'toast' message) in the lower right-hand side of the interface, and the message disappears after 5 seconds. Users are able to identify the arrival of email through other means, such as viewing the Inbox, so the disappearance of the message does not set a time limit on the their ability to determine if new mail has arrived. If the user has no other means of discovering the same information (or performing the same function), then each message would need to meet this Success Criterion in order to provide users with sufficient time to access the information.
https://www.w3.org/WAI/WCAG22/Understanding/timing-adjustable#intent

という段落が2024/6に追加されていました。
翻訳アプリで直訳:

タイマーで動作するコンテンツは、タイマーに依存しない代替手段があれば、時間調整可能である必要はありません。例えば、電子メールクライアントのようなウェブアプリケーションは、新しい電子メールの到着をインターフェイスの右下に一時的なメッセージ(「トースト」メッセージなど)で通知し、メッセージは5秒後に消えます。ユーザーは受信トレイを見るなど、他の手段でメールの到着を確認することができるので、メッセージが消えても、新しいメールが到着したかどうかを判断する能力に時間的な制限は設けられません。ユーザーが同じ情報を発見する(または同じ機能を実行する)他の手段がない場合、ユーザーが情報にアクセスするのに十分な時間を提供するために、各メッセージはこの成功基準を満たす必要があります。

無条件でokというわけではなく、条件付きなことに注意が必要なため、Spindle UIとしても用途について言及する必要があります。
ユーザーがToastを見逃しても支障がなく(=代替手段があり)、見逃さなかった人にとっては使い勝手が向上するもの、です。

一方で、画面拡大時など、画面外に表示されてしまうことで通知を見逃してしまうというアクセシビリティの懸念はあるため、SnackBarとToastを使う際には下記2つの基準をクリアすることを明記します。

上記を踏まえて、Toast, SnackBar, InlineNotification, Dialogの使い分けを明確にするためにコンポーネントの説明部分と使い分けについて記載しました。

気になりポイント

  • 長くなりすぎ
  • セクション名
  • 表記内容の確認 @MasatoHonda とSlackで進める

スケジュール

急ぎではないです 🙏

Copy link

reg-suit bot commented Feb 9, 2024

reg-suit detected visual differences.

Check this report, and review them.

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

Copy link
Contributor

github-actions bot commented Feb 9, 2024

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

https://ameba-spindle--pr926-feature-update-notif-o20dkq8j.web.app

(expires Sat, 26 Oct 2024 06:58:49 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: e7521619a2dd5c653490c8246e81ec2a5c8f1435

@tokimari tokimari requested review from a team, herablog, itsminadesu and yasuda-shin and removed request for a team February 9, 2024 05:35
@tokimari tokimari self-assigned this Feb 9, 2024
Comment on lines 123 to 129
### 通信を伴うデータ更新のフィードバック

- 成功:[Toast - Confirmation](/docs/toast--confirmation)で、成功した事実のみを伝える
- 失敗:[InlineNotification - Error Emphasis](/docs/inlinenotification--error-emphasis)で、失敗した理由とユーザーがすべきアクションを伝える
- 一連の動作のゴールがある場合:完了画面に遷移させる。例:
- 登録完了時
- 「元の画面に戻る」動作をユーザーにさせたい時
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Snackbarはデータ更新のフィードバックには使わないので、使ってはいけない、のように書く方が良いでしょうか 💭

@itsminadesu

This comment was marked as resolved.

@tokimari tokimari force-pushed the feature/update-notification-docs branch from eb69b6a to 7c4e9e4 Compare February 9, 2024 07:52
@tokimari

This comment was marked as resolved.

@tokimari tokimari force-pushed the feature/update-notification-docs branch from 7c4e9e4 to 80b5100 Compare February 9, 2024 07:54
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.

一旦、大枠だけコメントさせていただきました! 🙏🏻 (細かい部分は修正次第で変わると思うので一旦スルーしています)

@tokimari
Copy link
Contributor Author

#926 (comment)#926 (comment) について、たしかになので @MasatoHonda とSlackで詰めます:pray:(内部資料参照したいのでslackにて・・)

@tokimari tokimari marked this pull request as draft September 20, 2024 08:48
@tokimari tokimari changed the title docs: ユーザーへの通知の使い分けについて詳細追加 docs(spindle-ui): 通知系コンポーネントの使い分けについて詳細追加 Sep 20, 2024
@tokimari tokimari marked this pull request as ready for review September 20, 2024 09:11
@tokimari tokimari force-pushed the feature/update-notification-docs branch from d135006 to 4fd3428 Compare September 20, 2024 09:12
@tokimari
Copy link
Contributor Author

tokimari commented Sep 20, 2024

WAIのToast/SnackBarへの公式見解が出されたことを受けて内容を大幅に見直しました。まずはほんでぃと来週以降で相談しつつ修正を加えていく予定です。その後再レビュー依頼します!(内容にご意見いただくのは今でも全然!)

@tokimari tokimari marked this pull request as draft September 20, 2024 09:23
@tokimari tokimari marked this pull request as ready for review September 26, 2024 06:44
@tokimari tokimari force-pushed the feature/update-notification-docs branch from 4fd3428 to 8409838 Compare September 26, 2024 06:53
@tokimari
Copy link
Contributor Author

tokimari commented Sep 26, 2024

@herablog @itsminadesu @yasuda-shin デザイナーチェックokだったので、再レビューお願いします〜〜!(PRガッツリ描き直しています 🙇 )

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.

2 participants