orange-opensource/accessibility-statement-lib-ios

⚙️ Status

[[Apache 2.0 license]](https://github.com/Orange-OpenSource/accessibility-statement-lib-ios/blob/master/LICENSE)

[[Versions]](https://github.com/Orange-OpenSource/accessibility-statement-lib-ios/releases) [[Still maintained]](https://github.com/Orange-OpenSource/accessibility-statement-lib-ios/issues?q=is%3Aissue+is%3Aclosed)

[[Code size]](https://github.com/Orange-OpenSource/accessibility-statement-lib-ios) [[Opened issues]](https://github.com/Orange-OpenSource/accessibility-statement-lib-ios/issues)

[[Open Hub]](https://openhub.net/p/accessibility-statement-lib-ios)

[!CAUTION] To use it, you need the XML accessibility result file from the Orange Va11ydette

<p align="center"> <img src="./.github/images/preview-ouds-Orange.png" alt="Preview with Orange theme from OUDS library (french)" title="Preview with Orange theme from OUDS library (french)" height="400" /> &nbsp; <img src="./.github/images/preview-ouds-Sosh.png" alt="Preview with Sosh theme from OUDS library (french)" title="Preview with Sosh theme from OUDS library (french)" height="400" /> &nbsp; <img src="./.github/images/preview-ouds-Wireframe.png" alt="Preview with Wireframe theme from OUDS library (french)" title="Preview with Wireframe theme from OUDS library (french)" height="400" />

</p>

🚀 Import Accessibility Statement lib in your project

1. To integrate the DeclarationAccessibility module into your Xcode project using Swift Package Manager, declare a new dependency:

.package(url: "https://github.com/Orange-OpenSource/accessibility-statement-lib-ios.git", .exact("2.0.0"))

1. Then add the dependency product in the target you want:

.target(
    name: "YourTargetName",
    dependencies: [
        .product(name: "DeclarationAccessibility", package: "accessibility-statement-lib-ios")
    ],
)

[!TIP] You can of course refer to it in your Xcode project settings.

🚀 Usage

Import the module from the Swift Package:

import DeclarationAccessibility

Then, given an XML file generated by La Va11ydette named accessibility_result in your app bundle:

• Display the statement with additional details in local HTML file

StatementView(xmlFile: "accessibility_result", theme: .orange, localUrl: absoluteStringUrlToLocalFile)

• Or use a detailed page available outside the app, e.g. in web site, to display in webview or not (by default not)

StatementView(xmlFile: "accessibility_result", theme: .orange, remoteUrl:  "https://a11y-guidelines.orange.com/fr/", useWebView: true)

🪲 Bugs, feature requests and discussions

Have a bug or a feature request? Please first search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

If you want to share ideas or discuss about API, features, components or other topics, you should first open a new discussion. Q&A is more dedicated for help, otherwise feel free to open or update a topic in Ideas. Keep in mind internal or sensitive discussions must be in internal tools, not public ones.

🤝 Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development. More technical details are available also in the DEVELOP file.

🔒 Data and privacy

The Accessibility Statement Lib is a Software Development Kit (SDK) that allows developpers display accessibility statement. As such:

• this SDK does not handle any personnal data
• this SDK does not require any device permission to work

⚖️ Copyright and license

Code released under the Apache 2.0 License.

Package Metadata

Repository: orange-opensource/accessibility-statement-lib-ios

Default branch: master

README: README.md