{"id":19210457,"url":"https://github.com/ryanslikesocool/cheatsheetoverlay","last_synced_at":"2026-04-29T21:07:33.437Z","repository":{"id":213286841,"uuid":"733449818","full_name":"ryanslikesocool/CheatSheetOverlay","owner":"ryanslikesocool","description":"Customizable keyboard shortcut cheat sheet overlay for SwiftUI","archived":false,"fork":false,"pushed_at":"2024-11-26T16:02:09.000Z","size":87,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-04T16:42:47.202Z","etag":null,"topics":["cheatsheet","keyboard-shortcuts","macos","overlay","swift","swift-package","swiftui","ui"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ryanslikesocool.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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,"publiccode":null,"codemeta":null}},"created_at":"2023-12-19T11:00:30.000Z","updated_at":"2024-12-14T13:22:44.000Z","dependencies_parsed_at":"2023-12-22T02:18:16.636Z","dependency_job_id":"18337dd8-9fb3-4df6-8b34-931650331f82","html_url":"https://github.com/ryanslikesocool/CheatSheetOverlay","commit_stats":{"total_commits":12,"total_committers":1,"mean_commits":12.0,"dds":0.0,"last_synced_commit":"714a8dc32a4f58712270960154d1d0f9519f7815"},"previous_names":["ryanslikesocool/cheatsheetoverlay"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanslikesocool%2FCheatSheetOverlay","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanslikesocool%2FCheatSheetOverlay/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanslikesocool%2FCheatSheetOverlay/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryanslikesocool%2FCheatSheetOverlay/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ryanslikesocool","download_url":"https://codeload.github.com/ryanslikesocool/CheatSheetOverlay/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240282939,"owners_count":19776792,"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":["cheatsheet","keyboard-shortcuts","macos","overlay","swift","swift-package","swiftui","ui"],"created_at":"2024-11-09T13:36:09.229Z","updated_at":"2025-10-29T20:52:59.242Z","avatar_url":"https://github.com/ryanslikesocool.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CheatSheetOverlay\nCustomizable keyboard shortcut cheat sheet overlay for SwiftUI\\\n![A preview of the cheat sheet, displaying multiple keyboard shortcut items in a vertical list](images~/preview.png)\n\n## Requirements\nCheatSheetOverlay requires macOS 13.0 or later.\n\n## Installation\nCheatSheetOverlay can be added to a project as a Swift package.\n```swift\n.package(url: \"https://github.com/ryanslikesocool/CheatSheetOverlay\", from: \"0.2.0\"),\n```\n\n## Usage\n\nUse `Label` to create an item in the cheat sheet.\n```swift\nLabel(\"Copy\", systemImage: \"doc.on.doc\")\n```\n\n------\n\nAdd a `.keyboardShortcut()` modifier with the desired shortcut to a `Label` to make it appear in the cheat sheet.\n```swift\nLabel(\"Copy\", systemImage: \"doc.on.doc\")\n\t.keyboardShortcut(\"c\")\n```\n\n------\n\nUse `GroupBox` to group multiple `Label`s.\n```swift\nGroupBox(\"Text Commands\") {\n\tLabel(\"Copy\", systemImage: \"doc.on.doc\")\n\t\t.keyboardShortcut(\"c\")\n\tLabel(\"Paste\", systemImage: \"arrow.right.doc.on.clipboard\")\n\t\t.keyboardShortcut(\"v\")\n\tLabel(\"Cut\", systemImage: \"scissors\")\n\t\t.keyboardShortcut(\"x\")\n}\n```\n\n------\n\nThe cheat sheet can be added to a view with the `.cheatSheet` view modifier.  It takes a view as a parameter.  CheatSheetOverlay will apply styles the provided views.\n```swift\nContentView()\n\t.cheatSheet {\n\t\tGroupBox(\"Text Commands\") {\n\t\t\tLabel(\"Copy\", systemImage: \"doc.on.doc\")\n\t\t\t\t.keyboardShortcut(\"c\")\n\t\t\tLabel(\"Paste\", systemImage: \"arrow.right.doc.on.clipboard\")\n\t\t\t\t.keyboardShortcut(\"v\")\n\t\t\tLabel(\"Cut\", systemImage: \"scissors\")\n\t\t\t\t.keyboardShortcut(\"x\")\n\t\t}\n\n\t\tGroupBox {\n\t\t\tLabel(\"Print\", systemImage: \"printer\")\n\t\t\t\t.keyboardShortcut(\"p\")\n\t\t\tLabel(\"Go Wild\", systemImage: \"sparkles\")\n\t\t\t\t.keyboardShortcut(.return, modifiers: [.control, .option, .shift, .command])\n\t\t}\n\t}\n```\n\n------\n\nThe delay between when the activation key is held and when the cheat sheet appears can be changed by setting the `revealDelay` parameter on the `cheatSheet` modifier.\\\nThis value is set to `0.75` by default.\n```swift\nContentView()\n\t.cheatSheet(revealDelay: 0.75) { /* ... */ }\n```\n\n------\n\nThe activation key that must be pressed for the cheat sheet to appear can be changed by setting the `activationKey` parameter on the `cheatSheet` modifier.  This can be set to a single value or a combination of values.\\\nThis value is set to `.command` (the ⌘ key) by default.\n```swift\nContentView()\n\t.cheatSheet(activationKey: .command) { /* ... */ }\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryanslikesocool%2Fcheatsheetoverlay","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryanslikesocool%2Fcheatsheetoverlay","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryanslikesocool%2Fcheatsheetoverlay/lists"}