Giter Site home page Giter Site logo

jackstone92 / a11yoop Goto Github PK

View Code? Open in Web Editor NEW
3.0 3.0 0.0 314 KB

iOS accessibility tools

License: MIT License

Swift 100.00%
accessibility accessibility-analysis analytics analytics-tracking inclusion ios swift swift-package-manager swiftui

a11yoop's People

Contributors

jackstone92 avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

a11yoop's Issues

Improve the ergonomics of accessibility feature representation formatting for analytics

It is not always the case that users will want to represent a sequence of A11yFeature as a params dictionary (using the asAnalyticsParams(prefixedBy:) adapter) for analytics purposes. They may want, for example, only a subset of the enabled features listed as a comma-separated String. Previously, this would require a lot of extra work for the user to filter features provided by the A11yoopMonitor and then format them in whatever way is needed.

While it does not seem beneficial for A11yoop to attempt to provide convenience methods to format A11yFeature in x number of ways, it would be worth extending A11yoopMonitor to provide some additional properties for currently monitored accessibility features that are enabled, disabled and unsupported. This would then allow the user to take that information and format it in whichever way they require (using the asAnalyticsParams(prefixedBy:) adapter, comma-separated or otherwise).

Prevent potential data races on A11yStoreLive

There is currently the possibility for data races when writing to/reading from the A11yStoreLive; particularly as it is possible to specify for the A11yoopMonitor to run on a background queue. This needs addressing.

While a future optimisation might be to opt to use Swift Concurrency and actors, an intermediate fix might be to use thread locking or dispatch queues in order to prevent such data races from occurring.

Package structure overhaul

The package structure of A11yoop needs to be re-evaluated since, while a hyper-modularisation approach works well for app development, it is not necessarily the best approach for libraries that will be consumed outside of a first-party scope.

We want a very simple API contract where the user can only import products like A11yoopMonitor and use publicly available classes/structs without leaking any implementation detail that has been extracted into separate modules (eg. A11yStatusProvider). The biggest issue is that it is currently possible for these to be imported by the consumer. Swift does not currently have a moduleprivate access modifier yet, which is what would have been perfect for this package structure. Until this is available, we need to restructure the package to prevent the leaking of any implementation detail so that we can ensure that only public products are able to be imported.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.