https://github.com/orange-opensource/accessibility-statement-lib-ios
Provides a view that indicates the WCAG compliance status to be integrated into your iOS mobile application, based on Vallydette report
https://github.com/orange-opensource/accessibility-statement-lib-ios
a11y ios swift swiftui wcag
Last synced: 5 months ago
JSON representation
Provides a view that indicates the WCAG compliance status to be integrated into your iOS mobile application, based on Vallydette report
- Host: GitHub
- URL: https://github.com/orange-opensource/accessibility-statement-lib-ios
- Owner: Orange-OpenSource
- License: apache-2.0
- Created: 2023-07-18T17:29:30.000Z (almost 3 years ago)
- Default Branch: develop
- Last Pushed: 2026-01-23T09:53:20.000Z (5 months ago)
- Last Synced: 2026-01-23T10:04:51.968Z (5 months ago)
- Topics: a11y, ios, swift, swiftui, wcag
- Language: Swift
- Homepage: https://a11y-statement-lib-ios.netlify.app/documentation/declarationaccessibility/
- Size: 738 KB
- Stars: 0
- Watchers: 3
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Maintainers: .github/MAINTAINERS.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
Accessibility Statement Lib iOS
Accessibility Statement Lib iOS contains a view showing the WCAG compliance status for a given iOS application.
Report bug
·
Request feature
## ⚙️ Status
[](https://github.com/Orange-OpenSource/accessibility-statement-lib-ios/blob/master/LICENSE)
[](https://github.com/Orange-OpenSource/accessibility-statement-lib-ios/releases)
[](https://github.com/Orange-OpenSource/accessibility-statement-lib-ios/issues?q=is%3Aissue+is%3Aclosed)
[](https://github.com/Orange-OpenSource/accessibility-statement-lib-ios)
[](https://github.com/Orange-OpenSource/accessibility-statement-lib-ios/issues)
[](https://swiftpackageindex.com/Orange-OpenSource/accessibility-statement-lib-ios)
[](https://openhub.net/p/accessibility-statement-lib-ios)
> [!CAUTION]
> To use it, you need the XML accessibility result file from the [Orange Va11ydette](https://la-va11ydette.orange.com/)
## 🚀 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:
```swift
.package(url: "https://github.com/Orange-OpenSource/accessibility-statement-lib-ios.git", .exact("2.0.0"))
```
2. Then add the dependency product in the target you want:
```swift
.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:
```swift
import DeclarationAccessibility
```
Then, given an XML file generated by [La Va11ydette](https://la-va11ydette.orange.com/) named `accessibility_result` in your app bundle:
- Display the statement with additional details in local HTML file
```swift
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)
```swift
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](https://github.com/Orange-OpenSource/accessibility-statement-lib-ios/issues/new/choose).
If you want to share ideas or discuss about API, features, components or other topics, you should first open a new discussion.
[Q&A](https://github.com/Orange-OpenSource/accessibility-statement-lib-ios/discussions/categories/q-a) is more dedicated for help, otherwise feel free to open or update a topic in [Ideas](https://github.com/Orange-OpenSource/accessibility-statement-lib-ios/discussions/categories/ideas).
Keep in mind internal or sensitive discussions must be in internal tools, not public ones.
## 🤝 Contributing
Please read through our [contributing guidelines](https://github.com/Orange-OpenSource/accessibility-statement-lib-ios/blob/master/.github/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development. More technical details are available also in the [DEVELOP](https://github.com/Orange-OpenSource/accessibility-statement-lib-ios/blob/master/.github/DEVELOP.md) 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](https://github.com/Orange-OpenSource/accessibility-statement-lib-ios/blob/master/LICENSE).