Louis

Automated accessibility testing for iOS. This project is still new. Please contribute! We are looking to add more checks and eliminate false positives.

Installation

Fetch Using Cocoapods

Add the following to your Podfile:

pod 'Louis', '~> 1.0'

Fetch Using Carthage

Add the following to your Cartfile:

github "aleffert/Louis"

Configuring Louis in your project

Add the following to your app delegate:

// At the top with your other imports
import Louis


func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool
    ...
    // And add this line inside application(didFinishLaunchingWithOptions:)
    LUILouis.shared.timedCheckEnabled = true
    ...
}

This will enable a check that runs every three seconds looking for violations. The default is to log errors it finds to the console. You can also have it assert or doing something else entirely by setting the loggers property on the shared LUILouis instance. For example, to have it assert if there's a problem you can do:

    LUILouis.shared.addLogger(LUIAssertionLogger())

You can also use Louis as part of your XCTest cases. Simply assert that your view has no issues.

    XCTAssertEqual(view.lui_accessibilityReports.count, 0)

Hacking

Adding a new report

1. Create a new class that implements the LUIReport protocol.
2. Add [YourClass class] to +[LUIReport reporters].

License

Louis is available under the MIT license. See the LICENSE file for more info.