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

File Block: Consider removing the toggle control help text under the "Show Download Button" toggle. #13429

Closed
kjellr opened this issue Jan 22, 2019 · 5 comments
Labels
[Block] File Affects the File Block [Feature] Blocks Overall functionality of blocks [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). Needs Design Feedback Needs general design feedback.

Comments

@kjellr
Copy link
Contributor

kjellr commented Jan 22, 2019

The "Show Download Button" toggle for the File block comes with some helper text to explain the current state:

screen shot 2019-01-22 at 12 48 22 pm

There are many instances where supplementary text is helpful (For instance, we use that text to explain what a drop cap is for the paragraph block).

In the case of the file block's download button however, this text is simply a readout of the toggle button's state. It seems redundant and we should consider removing it.

@kjellr kjellr added [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Feature] Blocks Overall functionality of blocks Needs Design Feedback Needs general design feedback. [Block] File Affects the File Block labels Jan 22, 2019
@sarahmonster sarahmonster mentioned this issue Jan 22, 2019
7 tasks
@ZebulanStanphill
Copy link
Member

Pinging @afercia, since I vaguely recall that this text was added due to accessibility concerns, if I am not mistaken.

@afercia
Copy link
Contributor

afercia commented Jan 23, 2019

See the lengthy discussion on #2146 which was closed without consensus.

From an accessibility perspective, the accessibility team asked to have a textual representation of the toggle state. An On/Off was enough. Instead, in many cases the help text was used as sort of lengthier "dynamic" description.

Currently there's some inconsistency across all these toggles. I'd be in favor of removing inappropriate (slightly redundant) text but: graphics is not enough, there need to be some text to indicate the state.

@kjellr
Copy link
Contributor Author

kjellr commented Jan 24, 2019

Currently there's some inconsistency across all these toggles. I'd be in favor of removing inappropriate (slightly redundant) text but: graphics is not enough, there need to be some text to indicate the state.

For clarity's sake, do you agree that this specific instance is a bit redundant and could be removed?

It sounds like you're suggesting there might need to be a different text-based description here instead. If so, any suggestions?

Thank you for your input!

@afercia
Copy link
Contributor

afercia commented Jan 24, 2019

I'd agree this specific wording is redundant but there should be an On / Off text or maybe Enabled / Disabled. I'd like to not repeat all the argumentations already made on #2146 🙂but I'd suggest to have a look at it.

kjellr added a commit that referenced this issue Jan 24, 2019
As per discussion in #13429, this help text is redundant and can be removed.

There's still some discussion to be had about adding some sort of "on/off" text to clarify the state for toggles like this, but that should be tackled globally.
@kjellr
Copy link
Contributor Author

kjellr commented Jan 24, 2019

Thanks, @afercia. That on/off label sounds like something that should be tackled globally for all toggles. In the meantime, I've opened #13485 for this specific File Download button text.

@gziolo gziolo closed this as completed Jan 25, 2019
gziolo pushed a commit that referenced this issue Jan 25, 2019
As per discussion in #13429, this help text is redundant and can be removed.

There's still some discussion to be had about adding some sort of "on/off" text to clarify the state for toggles like this, but that should be tackled globally.
youknowriad pushed a commit that referenced this issue Mar 6, 2019
As per discussion in #13429, this help text is redundant and can be removed.

There's still some discussion to be had about adding some sort of "on/off" text to clarify the state for toggles like this, but that should be tackled globally.
youknowriad pushed a commit that referenced this issue Mar 6, 2019
As per discussion in #13429, this help text is redundant and can be removed.

There's still some discussion to be had about adding some sort of "on/off" text to clarify the state for toggles like this, but that should be tackled globally.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] File Affects the File Block [Feature] Blocks Overall functionality of blocks [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). Needs Design Feedback Needs general design feedback.
Projects
None yet
Development

No branches or pull requests

4 participants