Accessibility #263

aral · 2017-01-24T15:52:09Z

The demo strings in the iOS Examples app are currently not accessible.

Specifically:

The XML example has a decorative image that is visible to the accessibility system and shouldn’t be.
The Composition example has a content image without alternative text.
The Images & Special characters example has content images without alternative text.

Furthermore, there is a bug in the tintedImage(color:) method in the BONImage extension that loses the accessibility label on the original image.

This pull request:

Fixes the tintedImage(color:) method in the BONImage extension so that the resulting tinted image has the same accessibility label as the original image.
Adds accessibility support to the images in the iOS Example app.
(Minor) Adds the .idea folder added to projects by AppCode to .gitignore.

Regarding the second point, the difference in experience of a person using the iOS Example app with VoiceOver is the following:

XML example

Before: Maria Sharapova attachment png, crisp, very dark, file

After: Maria Sharapova

Composition:

Before: You’re going to need a bigger attachment, png, crisp, dark, file

After: You’re going to need a bigger boat

Images & Special Characters:

Before: 2 2

After: 2 bee oar knot 2 bee

ZevEisenberg · 2017-01-24T23:17:50Z

@aral it's saying "file", not "foul" (I slowed down the speaking rate to check).

~~If you make a change to the branch (even a trivial one), I've enabled CircleCI builds for fork pull requests.~~ I updated the branch after merging something in to master, so it's building now.

ZevEisenberg · 2017-01-25T00:36:06Z

@aral it looks like accessibilityLabel on iOS/tvOS maps to accessibilityDescription on the Mac. Would you mind updating your branch to fix the Mac build? You can test it locally by running tests in the BonMot-OSX target or building the AllTheThings target.

ZevEisenberg · 2017-01-25T00:47:32Z

@aral oh, and it also looks like accessibilityLabel isn't available on UIImage on watchOS, so you'll probably want to conditionally include that line as well.

ZevEisenberg · 2017-01-25T00:50:14Z

Example-iOS/DemoStrings.swift

-        UIImage(named: "bee")!,
+    static let imagesExample: NSAttributedString = {
+
+        func accessibleImage(named name:String) -> UIImage {


Space after colon (per SwiftLint)

ZevEisenberg · 2017-01-25T00:52:25Z

Sources/Image+Tinting.swift

@@ -64,6 +64,9 @@ public extension BONImage {
        // Prevent further tinting
        image.isTemplate = false

+        // Transfer accessibility label
+        image.accessibilityLabel = self.accessibilityLabel


As mentioned above, this is accessibilityDescription on the Mac.

ZevEisenberg · 2017-01-25T00:56:50Z

Tests/ImageTintingTests.swift

@@ -85,4 +85,13 @@ class ImageTintingTests: XCTestCase {
        BONAssertEqualImages(untintedResult!, tintAttemptResult!)
    }

+    func testAccessibilityLabelTransferToTintedImage() {
+        let accessibilityLabel = "I’m the very model of a modern accessible image."
+        let accessibleImage = UIImage(cgImage: imageForTest.cgImage!)


Use BONImage instead of UIImage for cross-platform. You'll need to use accessibilityLabel vs. accessibilityDescription on iOS vs. Mac. Let me know if you need help.

As for the initializer, and various permutations of optional an non-optional parameters, you may want to add some helpers to Compatibility+Tests.swift, or use a bunch of conditional compilation.

Thanks for all the notes, Zev. Will update today. Sorry for missing the cross-platform issues.

No problem! It's pretty rare for a project like this. I should make sure the readme includes enough info on contributing. I never imagined we'd get as much community involvement as we have!

Looked into it on WatchKit a bit and couldn’t come up with anything. I don’t have any Apple Watch apps at the moment. Will look into it again when I can and possibly file a radar. Do you know of anyone using the framework in an open source Watch app I can look at?

I don't. I haven't seen much watchOS development in the wild.

…lity

aral · 2017-01-25T14:59:12Z

The latest commits should address all the review points. Do let me know if I missed anything.

ZevEisenberg · 2017-01-25T15:00:34Z

Sources/Image+Tinting.swift

@@ -113,6 +116,11 @@ public extension BONImage {
            image = image.resizableImage(withCapInsets: originalCapInsets, resizingMode: originalResizingMode)
        }

+        // Transfer accessibility label (iOS only; watchOS does not have accessibilityLabel on UIImage).
+        #if os(iOS)


What about tvOS?

ZevEisenberg · 2017-01-25T15:00:59Z

Sources/Image+Tinting.swift

@@ -113,6 +116,11 @@ public extension BONImage {
            image = image.resizableImage(withCapInsets: originalCapInsets, resizingMode: originalResizingMode)
        }

+        // Transfer accessibility label (iOS only; watchOS does not have accessibilityLabel on UIImage).
+        #if os(iOS)
+        image.accessibilityLabel = self.accessibilityLabel


nice-to-have: indent this line (project style: anything enclosed in #if should be indented.

ZevEisenberg · 2017-01-25T15:03:02Z

Tests/ImageTintingTests.swift

@@ -65,7 +67,7 @@ class ImageTintingTests: XCTestCase {
        XCTAssertNotNil(tintedResult)

        BONAssertNotEqualImages(untintedResult!, tintedResult!)
-    }
+    }   


Extra whitespace. (If you brew install swiftlint 0.16.1 or higher, it will catch this for you. You can also enable trimming trailing whitespace in Xcode → Preferences → Text Editing → Automatically trim trailing whitespace.)

swiftlint installed – will go mumble to myself about brace placement now ;)

ZevEisenberg · 2017-01-25T15:04:26Z

Tests/ImageTintingTests.swift

@@ -84,5 +86,23 @@ class ImageTintingTests: XCTestCase {

        BONAssertEqualImages(untintedResult!, tintAttemptResult!)
    }
+
+    func testAccessibilityIOS() {
+        #if os(iOS)


Same as above: what about tvOS?
Also: you could just do a single testAccessibility function, which the contents wrapped in #if, instead of two separate functions. I don't strongly care either way, I guess, but it might let you share more lines of code between the tests.

I initially had it in one method but decided it made the code harder to read. Updated to include tvOS.

ZevEisenberg · 2017-01-27T19:24:18Z

@aral thanks so much for your contribution! I'm going to try to get a couple more AX things in (#155) and cut a new release today.

aral added 4 commits January 24, 2017 16:37

Add AppCode project directory to .gitignore.

a01cf73

Fix accessibility label loss when an image is tinted.

720c796

Make demo strings in iOS Examples app accessible.

6a0800e

Add test for accessibility label handling on image tint.

7403461

Merge branch 'master' into accessibility

d57af4d

ZevEisenberg requested changes Jan 25, 2017

View reviewed changes

aral added 4 commits January 25, 2017 13:15

Use BONImage in test for cross-platform compatibility.

02550df

Merge branch 'accessibility' of github.com:aral/BonMot into accessibi…

42f68d6

…lity

Fix cross-platform accessibility issues on tinted images.

f050abc

Merge remote-tracking branch 'upstream/master' into accessibility

5bfc080

ZevEisenberg reviewed Jan 25, 2017

View reviewed changes

Add tvOS support to image tint tests; fix linter whitespace warning.

c092373

ZevEisenberg approved these changes Jan 27, 2017

View reviewed changes

ZevEisenberg merged commit f2fc860 into Rightpoint:master Jan 27, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Accessibility #263

Accessibility #263

aral commented Jan 24, 2017 •

edited

Loading

ZevEisenberg commented Jan 24, 2017 •

edited

Loading

ZevEisenberg commented Jan 25, 2017

ZevEisenberg commented Jan 25, 2017

ZevEisenberg Jan 25, 2017

ZevEisenberg Jan 25, 2017

ZevEisenberg Jan 25, 2017

ZevEisenberg Jan 25, 2017

aral Jan 25, 2017

ZevEisenberg Jan 25, 2017

aral Jan 25, 2017

ZevEisenberg Jan 25, 2017

aral commented Jan 25, 2017

ZevEisenberg Jan 25, 2017

aral Jan 26, 2017

ZevEisenberg Jan 25, 2017

aral Jan 26, 2017

ZevEisenberg Jan 25, 2017

aral Jan 26, 2017

ZevEisenberg Jan 25, 2017

aral Jan 26, 2017

ZevEisenberg commented Jan 27, 2017

Accessibility #263

Accessibility #263

Conversation

aral commented Jan 24, 2017 • edited Loading

XML example

Composition:

Images & Special Characters:

ZevEisenberg commented Jan 24, 2017 • edited Loading

ZevEisenberg commented Jan 25, 2017

ZevEisenberg commented Jan 25, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aral commented Jan 25, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ZevEisenberg commented Jan 27, 2017

aral commented Jan 24, 2017 •

edited

Loading

ZevEisenberg commented Jan 24, 2017 •

edited

Loading