feat: add accessibility labels to torch and cancel buttons#45
Open
alexgerardojacinto wants to merge 2 commits into
Open
feat: add accessibility labels to torch and cancel buttons#45alexgerardojacinto wants to merge 2 commits into
alexgerardojacinto wants to merge 2 commits into
Conversation
The torch and cancel buttons were icon-only with no alternative text, so screen readers could not announce them. Add default English accessibility labels and expose optional cancelButtonAccessibilityLabel, torchButtonOnAccessibilityLabel and torchButtonOffAccessibilityLabel scan parameters so consumers can customize/localize them. Closes #44
12 tasks
When a label is not provided (nil/empty), no accessibility label is applied, keeping the previous behavior unchanged. The English default labels are removed; consumers supply the (localized) labels via the scan parameters.
Open
10 tasks
alexgerardojacinto
requested review from
ItsChaceD,
OS-pedrogustavobilro,
andredestro,
eric-horodyski,
jcesarmobile,
markemer and
theproducer
and removed request for
a team
OS-pedrogustavobilro
left a comment
OS-pedrogustavobilro
left a comment
Contributor
There was a problem hiding this comment.
I tested and it worked fine, my comments are more related to documentation and clarifications
| public let hint: OSBARCScannerHint? | ||
|
|
||
|
|
||
| /// Optional accessibility label for the cancel button. `Nil` or empty value uses the library's default. |
Contributor
There was a problem hiding this comment.
I was looking at this and was a bit confused. You talk in a few places here about "library's default", which from what I read, the default is just no label. While that makes sense, the whole "Nil or empty value uses the library's default." sentence makes it sound like it would provide an actual default label when the consumer doesn't provide anything. To me it feels like that sentence doesn't need to be there at all.
This also applies to the descriptions you added in the capacitor plugin.
Comment on lines
+17
to
+24
| /// Optional accessibility label for the cancel button. `Nil` or empty value uses the library's default. | ||
| public let cancelButtonAccessibilityLabel: String? | ||
|
|
||
| /// Optional accessibility label for the torch button when the torch is on. `Nil` or empty value uses the library's default. | ||
| public let torchButtonOnAccessibilityLabel: String? | ||
|
|
||
| /// Optional accessibility label for the torch button when the torch is off. `Nil` or empty value uses the library's default. | ||
| public let torchButtonOffAccessibilityLabel: String? |
Contributor
There was a problem hiding this comment.
Should add these parameters to the README, as we have for others.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The Torch and Cancel buttons are icon-only with no alternative text, so VoiceOver can't announce them. This PR adds the ability to set that alternative text.
OSBARCScanParametersthat set the accessibility label read by screen readers:cancelButtonAccessibilityLabeltorchButtonOnAccessibilityLabel(torch on)torchButtonOffAccessibilityLabel(torch off).accessibility(label:).Context
An accessibility audit flagged that the Torch and Cancel buttons have no alternative text, so they are announced incorrectly by screen readers. This exposes the labels as inputs so consumers can provide localized alternative text.
Closes #44
Type of changes
Platforms affected
Tests
Screenshots (if appropriate)
N/A
Checklist