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

VisuallyHiddenTextのわかりやすい使い方を追加 #1463

Merged
merged 8 commits into from
Dec 26, 2024
Merged
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,36 @@ description: 'スクリーンリーダーによる音声読み上げを可能に

import ComponentPropsTable from '@/components/article/ComponentPropsTable.astro'

VisuallyHiddenTextコンポーネントは、テキストを視覚的に隠しつつ、マシンリーダブルにしたい場合に使用します。見出しやラベルが自明な場合などに使います。
VisuallyHiddenTextコンポーネントは、テキストを視覚的に隠しつつ、スクリーンリーダーで読み上げるテキストを提供する場合に使用します。見出しやラベルが自明で、表示すると視覚的に冗長になる場合などに使います。

## 実装例

### 期間表現
視覚情報では`〜`ですが、スクリーンリーダーでは`から`と読み上げるように指定しています。
oremega marked this conversation as resolved.
Show resolved Hide resolved

```tsx editable
<>
<Text>2024/12/20〜2025/01/30</Text>
<VisuallyHiddenText>2024/12/20から2025/01/30</VisuallyHiddenText>
</>
```

### Badgeにアクセスブルな名前をつける
ドット表示の場合には視覚情報しか持たないため、何らかの形で必ずアクセシブルな名前を与えてください。(参考:[Badge](/products/components/badge/))

```tsx editable
<>
<Badge dot count={9} />
<VisuallyHiddenText>通知があります</VisuallyHiddenText>
</>
```

## 使用上の注意

`VisuallyHiddenText`を必要以上に使いすぎないでください。情報が過剰になり、アクセシビリティが逆に損なわれる場合があります。

文脈をしっかり考慮し、スクリーンリーダーユーザーにとって価値のある情報を提供することが重要です。


## Props

Expand Down
Loading