Skip to content

[CM-1260] Add trait for better accessibility. #11

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

Merged
merged 5 commits into from
Mar 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions Package.swift
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
// swift-tools-version: 5.7
// swift-tools-version: 5.5
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
name: "YStepper",
defaultLocalization: "en",
platforms: [
.iOS(.v14)
],
Expand Down
12 changes: 0 additions & 12 deletions Sources/YStepper/Assets/Strings/en.lproj/Localizable.strings

This file was deleted.

29 changes: 17 additions & 12 deletions Sources/YStepper/SwiftUI/Views/Stepper.swift
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,11 @@ extension Stepper: View {
getShape()
.background(getShapeWithoutStroke().foregroundColor(Color(appearance.backgroundColor)))
)
.accessibilityElement(children: .combine)
.accessibilityValue(getValueText())
.accessibilityAdjustableAction { direction in
accessibilityAction(direction: direction)
}
}

@ViewBuilder
Expand All @@ -122,7 +127,7 @@ extension Stepper: View {
Color(appearance.textStyle.textColor).opacity(isIncrementDisabled ? 0.5 : 1)
)
}
.accessibilityLabel(StepperControl.Strings.incrementA11yButton.localized)
.accessibilityHidden(true)
.disabled(isIncrementDisabled)
}

Expand All @@ -134,7 +139,7 @@ extension Stepper: View {
Color(appearance.textStyle.textColor).opacity(isDecrementDisabled ? 0.5 : 1)
)
}
.accessibilityLabel(getAccessibilityText())
.accessibilityHidden(true)
.disabled(isDecrementDisabled)
}

Expand All @@ -148,7 +153,7 @@ extension Stepper: View {
label.textColor = appearance.textStyle.textColor
}
.frame(width: getStringSize(sizeCategory).width)
.accessibilityLabel(getAccessibilityLabelText())
.accessibilityHidden(true)
}

@ViewBuilder
Expand Down Expand Up @@ -218,13 +223,6 @@ extension Stepper {
String(format: "%.\(decimalPlaces)f", value)
}

func getAccessibilityText() -> String {
if shouldShowDelete {
return StepperControl.Strings.deleteA11yButton.localized
}
return StepperControl.Strings.decrementA11yButton.localized
}

func updateCurrentValue(newValue: Double) {
if newValue < valueObserver.minimumValue {
valueObserver.value = valueObserver.minimumValue
Expand Down Expand Up @@ -257,8 +255,15 @@ extension Stepper {
)
}

func getAccessibilityLabelText() -> String {
StepperControl.Strings.valueA11yLabel.localized + getValueText()
func accessibilityAction(direction: AccessibilityAdjustmentDirection) {
switch direction {
case .increment:
buttonAction(buttonType: .increment)
case .decrement:
buttonAction(buttonType: .decrement)
@unknown default:
break
}
}
}

Expand Down
10 changes: 0 additions & 10 deletions Sources/YStepper/UIKit/StepperControl.swift
Original file line number Diff line number Diff line change
Expand Up @@ -88,16 +88,6 @@ extension StepperControl {
case decrement = "minus"
case delete = "trash"
}

/// Collection of Strings
enum Strings: String, Localizable, CaseIterable {
case incrementA11yButton = "Increment_Button_A11y_label"
case decrementA11yButton = "Decrement_Button_A11y_label"
case deleteA11yButton = "Delete_Button_A11y_label"
case valueA11yLabel = "Value_A11y_label"

static var bundle: Bundle { .module }
}
}

extension StepperControl: StepperDelegate {
Expand Down
26 changes: 21 additions & 5 deletions Tests/YStepperTests/Views/StepperTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -231,12 +231,28 @@ final class StepperTests: XCTestCase {
XCTAssertNotNil(Stepper_Previews.previews)
}

func testGetAccessibilityText() {
var sut = makeSUT()
XCTAssertEqual(sut.getAccessibilityText(), StepperControl.Strings.deleteA11yButton.localized)
func test_accessibilityIncrement_IncrementsValue() {
let sut = makeSUT(maxValue: 2)
sut.accessibilityAction(direction: .increment)
sut.accessibilityAction(direction: .increment)
XCTAssertEqual(sut.value, sut.minimumValue + 2 * sut.stepValue)
XCTAssertEqual(sut.value, sut.maximumValue)
sut.accessibilityAction(direction: .increment)
// It should still just be the maximum value
XCTAssertEqual(sut.value, sut.maximumValue)
}

func test_accessibilityDecrement_decrementsValue() {
let sut = makeSUT()
sut.accessibilityAction(direction: .increment)
XCTAssertEqual(sut.value, sut.minimumValue + sut.stepValue)

sut.appearance.showDeleteImage = false
XCTAssertEqual(sut.getAccessibilityText(), StepperControl.Strings.decrementA11yButton.localized)
sut.accessibilityAction(direction: .decrement)
XCTAssertEqual(sut.value, sut.minimumValue)

sut.accessibilityAction(direction: .decrement)
// It should still just be the minimum value
XCTAssertEqual(sut.value, sut.minimumValue)
}
}

Expand Down