{"id":13696766,"url":"https://github.com/playbook-ui/accessibility-snapshot-ios","last_synced_at":"2025-08-20T18:34:23.189Z","repository":{"id":40000144,"uuid":"307625341","full_name":"playbook-ui/accessibility-snapshot-ios","owner":"playbook-ui","description":"A library for generating snapshot images of components managed by Playbook with accessibility labels.","archived":false,"fork":false,"pushed_at":"2024-07-22T07:11:28.000Z","size":3872,"stargazers_count":42,"open_issues_count":1,"forks_count":2,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-12-11T12:12:04.354Z","etag":null,"topics":["a11y","a11y-testing","accessibility","ios","playbook","snapshot-testing","swift","swiftui","visual-regression-testing"],"latest_commit_sha":null,"homepage":"https://playbook-ui.github.io/accessibility-snapshot-ios/documentation/playbookaccessibilitysnapshot","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/playbook-ui.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-10-27T07:55:01.000Z","updated_at":"2024-10-27T16:12:25.000Z","dependencies_parsed_at":"2024-04-08T03:01:17.496Z","dependency_job_id":null,"html_url":"https://github.com/playbook-ui/accessibility-snapshot-ios","commit_stats":{"total_commits":52,"total_committers":3,"mean_commits":"17.333333333333332","dds":"0.42307692307692313","last_synced_commit":"03569df6a19292ccf1aa273803d01367c8733877"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/playbook-ui%2Faccessibility-snapshot-ios","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/playbook-ui%2Faccessibility-snapshot-ios/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/playbook-ui%2Faccessibility-snapshot-ios/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/playbook-ui%2Faccessibility-snapshot-ios/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/playbook-ui","download_url":"https://codeload.github.com/playbook-ui/accessibility-snapshot-ios/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230445927,"owners_count":18227060,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["a11y","a11y-testing","accessibility","ios","playbook","snapshot-testing","swift","swiftui","visual-regression-testing"],"created_at":"2024-08-02T18:00:46.683Z","updated_at":"2024-12-19T14:08:26.361Z","avatar_url":"https://github.com/playbook-ui.png","language":"Swift","funding_links":[],"categories":["iOS"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/playbook-ui/mediakit/master/logo/default-h%402x.png\" alt=\"Playbook\" width=\"400\"\u003e\n\u003c/p\u003e\n\n# PlaybookAccessibilitySnapshot\n\n\u003ca href=\"https://developer.apple.com/swift\"\u003e\u003cimg alt=\"Swift5\" src=\"https://img.shields.io/badge/language-Swift5-orange.svg\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/playbook-ui/accessibility-snapshot-ios/actions\"\u003e\u003cimg alt=\"CI Status\" src=\"https://github.com/playbook-ui/accessibility-snapshot-ios/workflows/GitHub%20Actions/badge.svg\"/\u003e\u003c/a\u003e\n\u003ca href=\"LICENSE\"\u003e\u003cimg alt=\"Lincense\" src=\"http://img.shields.io/badge/License-Apache%202.0-black.svg\"/\u003e\u003c/a\u003e\n\u003cbr\u003e\n\u003ca href=\"https://github.com/playbook-ui/accessibility-snapshot-ios/releases/latest\"\u003e\u003cimg alt=\"Release\" src=\"https://img.shields.io/github/v/release/playbook-ui/accessibility-snapshot-ios.svg\"/\u003e\u003c/a\u003e\n\u003ca href=\"https://swift.org/package-manager\"\u003e\u003cimg alt=\"Swift Package Manager\" src=\"https://img.shields.io/badge/SwiftPM-compatible-yellowgreen.svg\"/\u003e\u003c/a\u003e\n\n`PlaybookAccessibilitySnapshot` is an extension to [Playbook](https://github.com/playbook-ui/playbook-ios) that uses [AccessibilitySnapshot](https://github.com/cashapp/AccessibilitySnapshot) to produce snapshots with accessibility information such as activation points and labels.\n\n---\n\n## Usage\n\n- [API Document](https://playbook-ui.github.io/accessibility-snapshot-ios/documentation/playbookaccessibilitysnapshot)\n- [Example App](https://github.com/playbook-ui/accessibility-snapshot-ios/tree/main/Example)\n\n---\n\n### AccessibilitySnapshot\n\n```swift\nfinal class AccessibilitySnapshotTests: XCTestCase {\n    func testTakeAccessibilitySnapshot() throws {\n        let directory = ProcessInfo.processInfo.environment[\"SNAPSHOT_DIR\"]!\n\n        try Playbook.default.run(\n            AccessibilitySnapshot(\n                directory: URL(fileURLWithPath: directory),\n                clean: true,\n                format: .png,\n                keyWindow: UIApplication.shared.windows.first { $0.isKeyWindow },\n                devices: [.iPhone11Pro(.portrait)]\n            )\n        )\n    }\n}\n```\n\n\u003cimg src=\"https://raw.githubusercontent.com/playbook-ui/accessibility-snapshot-ios/main/assets/snapshot.png\" alt=\"snapshot\"\u003e\n\n|Sample|Before|After|\n|:-----|:-----|:----|\n|\u003cimg src=\"https://raw.githubusercontent.com/playbook-ui/accessibility-snapshot-ios/main/assets/sample.png\" alt=\"sample\"\u003e|\u003cimg src=\"https://raw.githubusercontent.com/playbook-ui/accessibility-snapshot-ios/main/assets/sample-before.png\" alt=\"before\"\u003e|\u003cimg src=\"https://raw.githubusercontent.com/playbook-ui/accessibility-snapshot-ios/main/assets/sample-after.png\" alt=\"after\"\u003e|\n\n---\n\n### Integration with Third-party Tools\n\nThe generated snapshot images with accessibility information can be used for more advanced visual regression testing by using a variety of third party tools.  \n\n#### [percy](https://percy.io)\n\n\u003cimg src=\"https://raw.githubusercontent.com/playbook-ui/accessibility-snapshot-ios/main/assets/percy.png\" alt=\"percy\" width=\"600\"\u003e\n\n---\n\n## Requirements\n\n- Swift 5.9+\n- Xcode 15.0+\n- iOS 13.0+\n\n---\n\n## Installation\n\n### [Swift Package Manager](https://developer.apple.com/documentation/xcode/adding_package_dependencies_to_your_app)\n\nSelect Xcode menu `File \u003e Swift Packages \u003e Add Package Dependency...` and enter repository URL with GUI.\n\n```\nRepository: https://github.com/playbook-ui/accessibility-snapshot-ios.git\n```\n\n---\n\n## Development\n\n1. Run `make proj` at the root of this repository.\n1. Open `Example/Example.xcworkspace` via Xcode.\n\n---\n\n## License\n\nPlaybook is released under the [Apache 2.0 License](https://github.com/playbook-ui/accessibility-snapshot-ios/tree/main/LICENSE).\n\n\u003cbr\u003e\n\u003cp align=\"center\"\u003e\n\u003cimg alt=\"Playbook\" src=\"https://raw.githubusercontent.com/playbook-ui/mediakit/master/logo/default%402x.png\" width=\"280\"\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplaybook-ui%2Faccessibility-snapshot-ios","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fplaybook-ui%2Faccessibility-snapshot-ios","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fplaybook-ui%2Faccessibility-snapshot-ios/lists"}