Skip to content
This repository has been archived by the owner on Aug 13, 2023. It is now read-only.

Update usage notes for Visually Hidden Text #3125

Open
1 task
sareh opened this issue Feb 13, 2020 · 0 comments
Open
1 task

Update usage notes for Visually Hidden Text #3125

sareh opened this issue Feb 13, 2020 · 0 comments
Labels
a11y Accessibility-related task Refinement Needed This is ready for refinement. It shouldn't be worked on until it has been refined by Dev & Test. ws-articles Tasks for the WS Articles Team ws-front-page-layout ws-media The World Service media stream

Comments

@sareh
Copy link
Contributor

sareh commented Feb 13, 2020

Is your feature request related to a problem? Please describe.
Currently, when Visually Hidden Text component is passed several child strings, React renders them as separate strings, often separated by empty html comments. E.g.

<span class=""VisuallyHiddenText>Video<!-- -->, </span>

When using Assistive Tech this often means several 'swipes' to read each of these strings.

We should update usage notes and Accessibility notes in the README of this component to reflect how it should be used.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered

  • Update Readme for Visually Hidden Text
  • Identify all uses of this component in Psammead and open another PR to change usage in all those components.

Eg.

<VisuallyHiddenText>
  {liveText}
  {mediaTypeText}
</VisuallyHiddenText>

should become:

const offscreenText = `${live Text} ${mediaTypeText} `
... 
<VisuallyHiddenText>
  {offscreenText}
</VisuallyHiddenText>

Testing notes
[Tester to complete]

Dev insight: Will there be any potential regression? etc

  • This feature is expected to need manual testing.

Additional context
Add any other context or screenshots about the feature request here.

@sareh sareh added Refinement Needed This is ready for refinement. It shouldn't be worked on until it has been refined by Dev & Test. ws-home Tasks for the WS Home Team a11y Accessibility-related task ws-front-page-layout labels Feb 13, 2020
@joshcoventry joshcoventry added ws-articles Tasks for the WS Articles Team ws-media The World Service media stream and removed ws-home Tasks for the WS Home Team labels Jul 1, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
a11y Accessibility-related task Refinement Needed This is ready for refinement. It shouldn't be worked on until it has been refined by Dev & Test. ws-articles Tasks for the WS Articles Team ws-front-page-layout ws-media The World Service media stream
Projects
None yet
Development

No branches or pull requests

2 participants