feat: add accessibility labels to torch and cancel buttons#45
Draft
alexgerardojacinto wants to merge 1 commit into
Draft
feat: add accessibility labels to torch and cancel buttons#45alexgerardojacinto wants to merge 1 commit into
alexgerardojacinto wants to merge 1 commit 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
11 tasks
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
1 participant
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 were icon-only with no alternative text, so screen readers (VoiceOver) could not announce them.
OSBARCCancelButtonandOSBARCTorchButton(via.accessibility(label:), iOS 13 compatible). The torch label is state-aware (on vs off).OSBARCScannerBehaviour(AccessibilityDefaults.cancelLabel/.torchOnLabel/.torchOffLabel).OSBARCScanParametersso consumers can customize/localize the labels (fall back to the defaults when nil/empty):cancelButtonAccessibilityLabel,torchButtonOnAccessibilityLabel,torchButtonOffAccessibilityLabel.The new
initparameters default tonil, so the change is backward compatible.Note
Kept as draft to validate end-to-end in the consuming plugins first. The same approach is mirrored in the Android library: OutSystems/OSBarcodeLib-Android#55
Context
An accessibility audit flagged that the Torch and Cancel buttons have no alternative text, so they are announced incorrectly by screen readers.
Closes #44
Type of changes
Platforms affected
Tests
xcodebuild build(generic/platform=iOS) — BUILD SUCCEEDEDxcodebuild build-for-testing(iOS Simulator) — TEST BUILD SUCCEEDEDScreenshots (if appropriate)
N/A
Checklist