Skip to content

feat: add accessibility labels to torch and cancel buttons #55

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.

Sign up for GitHub

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

Open
alexgerardojacinto wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat: add accessibility labels to torch and cancel buttons #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a5232b1
feat: add accessibility labels to torch and cancel buttons
alexgerardojacinto Jun 11, 2026
297e7e2
refactor: make button accessibility labels opt-in with no default
alexgerardojacinto Jun 14, 2026
c35cd23
docs: correct CHANGELOG version to 2.1.0 (minor bump for new params)
alexgerardojacinto Jun 17, 2026
880922b
ci: comment failing Sonarcloud step
OS-pedrogustavobilro Jun 23, 2026
f165ecb
chore: finish preparing for 2.1.0 release
OS-pedrogustavobilro Jun 23, 2026
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
10 changes: 5 additions & 5 deletions .github/workflows/run-unit-tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ jobs:
- name: Setup sonarqube
uses: warchant/setup-sonar-scanner@v8

- name: Send to Sonarcloud
run: bundle exec fastlane sonarqube
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
#- name: Send to Sonarcloud
# run: bundle exec fastlane sonarqube
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

The changes documented here do not include those from the original repository.

# [2.1.0]

### 2026-06-11

- Add optional `cancelButtonAccessibilityLabel`, `torchButtonOnAccessibilityLabel` and `torchButtonOffAccessibilityLabel` scan parameters to set the alternative text (content description) read by screen readers on the Cancel and Torch buttons. When not provided, no label is set, keeping the previous behavior unchanged. (https://github.com/OutSystems/OSBarcodeLib-Android/issues/54)

# [2.0.1]

### 2025-10-02
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ In your app-level gradle file, import the OSBarcodeLib library like so:

```gradle
dependencies {
implementation("com.github.outsystems:osbarcode-android:2.0.1@aar")
implementation("com.github.outsystems:osbarcode-android:2.1.0@aar")
}
```

Expand Down
2 changes: 1 addition & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
<modelVersion>4.0.0</modelVersion>
<groupId>io.ionic.libs</groupId>
<artifactId>ionbarcode-android</artifactId>
<version>2.0.1</version>
<version>2.1.0</version>
</project>
5 changes: 4 additions & 1 deletion src/main/kotlin/com/outsystems/plugins/barcode/model/OSBARCScanParameters.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,8 @@ data class OSBARCScanParameters(
@SerializedName("scanButton") val scanButton: Boolean,
@SerializedName("scanText") val scanText: String,
@SerializedName("hint") val hint: OSBARCScannerHint?,
@SerializedName("androidScanningLibrary") val androidScanningLibrary: String?
@SerializedName("androidScanningLibrary") val androidScanningLibrary: String?,
@SerializedName("cancelButtonAccessibilityLabel") val cancelButtonAccessibilityLabel: String? = null,
@SerializedName("torchButtonOnAccessibilityLabel") val torchButtonOnAccessibilityLabel: String? = null,
@SerializedName("torchButtonOffAccessibilityLabel") val torchButtonOffAccessibilityLabel: String? = null
Comment on lines +17 to +19

@OS-pedrogustavobilro OS-pedrogustavobilro Jun 23, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should add these parameters to the README, as we have done before?

I didn't do it myself because I was a bit confused on a portion of the sentence you use to describe them.

) : Serializable
34 changes: 26 additions & 8 deletions src/main/kotlin/com/outsystems/plugins/barcode/view/OSBARCScannerActivity.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -534,7 +534,8 @@ class OSBARCScannerActivity : ComponentActivity() {
CloseButton(
modifier = Modifier
.padding(top = ScannerBorderPadding, end = ScannerBorderPadding)
.align(Alignment.TopEnd)
.align(Alignment.TopEnd),
accessibilityLabel = parameters.cancelButtonAccessibilityLabel
)
}

Expand Down Expand Up @@ -595,7 +596,9 @@ class OSBARCScannerActivity : ComponentActivity() {
TorchButton(
modifier = Modifier
.padding(bottom = ScannerBorderPadding, end = ScannerBorderPadding)
.align(Alignment.BottomEnd)
.align(Alignment.BottomEnd),
onAccessibilityLabel = parameters.torchButtonOnAccessibilityLabel,
offAccessibilityLabel = parameters.torchButtonOffAccessibilityLabel
)
}
}
Expand Down Expand Up @@ -684,7 +687,8 @@ class OSBARCScannerActivity : ComponentActivity() {
CloseButton(
modifier = Modifier
.padding(top = ScannerBorderPadding, end = ScannerBorderPadding)
.align(Alignment.TopEnd)
.align(Alignment.TopEnd),
accessibilityLabel = parameters.cancelButtonAccessibilityLabel
)

Column(
Expand All @@ -701,7 +705,9 @@ class OSBARCScannerActivity : ComponentActivity() {
if (showTorch) {
TorchButton(
modifier = Modifier
.align(Alignment.End)
.align(Alignment.End),
onAccessibilityLabel = parameters.torchButtonOnAccessibilityLabel,
offAccessibilityLabel = parameters.torchButtonOffAccessibilityLabel
)
Spacer(modifier = Modifier.height(16.dp))
}
Expand All @@ -724,12 +730,13 @@ class OSBARCScannerActivity : ComponentActivity() {
/**
* Composable function, responsible rendering the close button
* @param modifier the custom modifier for the button
* @param accessibilityLabel optional content description read by screen readers; when null or blank no label is set (default behavior)
*/
@Composable
fun CloseButton(modifier: Modifier) {
fun CloseButton(modifier: Modifier, accessibilityLabel: String? = null) {
Icon(
painter = painterResource(id = R.drawable.close),
contentDescription = null,
contentDescription = accessibilityLabel?.takeIf { it.isNotBlank() },
tint = Color.White,
modifier = modifier
.background(color = CloseButtonBackground, shape = CircleShape)
Expand All @@ -744,17 +751,28 @@ class OSBARCScannerActivity : ComponentActivity() {
/**
* Composable function, responsible rendering the torch button
* @param modifier the custom modifier for the button
* @param onAccessibilityLabel optional content description read by screen readers when the torch is on; when null or blank no label is set (default behavior)
* @param offAccessibilityLabel optional content description read by screen readers when the torch is off; when null or blank no label is set (default behavior)
*/
@Composable
fun TorchButton(modifier: Modifier) {
fun TorchButton(
modifier: Modifier,
onAccessibilityLabel: String? = null,
offAccessibilityLabel: String? = null
) {
var isFlashlightOn by remember { mutableStateOf(false) }
val onIcon = painterResource(id = R.drawable.flash_on)
val offIcon = painterResource(id = R.drawable.flash_off)
val icon = if (isFlashlightOn) onIcon else offIcon
val torchContentDescription = if (isFlashlightOn) {
onAccessibilityLabel?.takeIf { it.isNotBlank() }
} else {
offAccessibilityLabel?.takeIf { it.isNotBlank() }
}

Image(
painter = icon,
contentDescription = null,
contentDescription = torchContentDescription,
modifier = modifier
.clickable {
try {
Expand Down
Loading